通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

@azure-rest/ai-content-safety package

接口

AddBlockItems
AddBlockItems200Response

请求已成功。
AddBlockItemsBodyParam
AddBlockItemsDefaultHeaders
AddBlockItemsDefaultResponse
AddBlockItemsOptions

将 blockItems 添加到文本阻止列表的请求。
AddBlockItemsResultOutput

将 blockItems 添加到文本阻止列表的响应。
AnalyzeImage
AnalyzeImage200Response

请求已成功。
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

图像的分析请求。
AnalyzeImageOptionsOutput

图像的分析请求。
AnalyzeImageResultOutput

图像的分析响应。
AnalyzeText
AnalyzeText200Response

请求已成功。
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

文本的分析请求。
AnalyzeTextOptionsOutput

文本的分析请求。
AnalyzeTextResultOutput

文本的分析响应
CreateOrUpdateTextBlocklist200Response

请求已成功。
CreateOrUpdateTextBlocklist201Response

请求已成功，因此创建了一个新资源。
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

没有要为此请求发送的内容，但标头可能很有用。
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

请求已成功。
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

请求已成功。
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageAnalyzeSeverityResultOutput

图像分析结果。
ImageData

图像的内容或 blob URL 可以是 base64 编码字节或 blob URL。 如果同时提供这两个请求，将拒绝该请求。 图像的最大大小为 2048 像素 * 2048 像素，同时不超过 4MB。 图像的最小大小为 50 像素 * 50 像素。
ImageDataOutput

图像的内容或 blob URL 可以是 base64 编码字节或 blob URL。 如果同时提供这两个请求，将拒绝该请求。 图像的最大大小为 2048 像素 * 2048 像素，同时不超过 4MB。 图像的最小大小为 50 像素 * 50 像素。
ListTextBlocklistItems
ListTextBlocklistItems200Response

请求已成功。
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

请求已成功。
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

分页帮助程序的选项
RemoveBlockItems
RemoveBlockItems204Response

没有要为此请求发送的内容，但标头可能很有用。
RemoveBlockItemsBodyParam
RemoveBlockItemsDefaultHeaders
RemoveBlockItemsDefaultResponse
RemoveBlockItemsOptions

从文本阻止列表中删除 blockItems 的请求。
Routes
TextAnalyzeSeverityResultOutput

文本分析结果。
TextBlockItemInfo

在文本阻止列表中阻止项信息。
TextBlockItemOutput

TextBlocklist 中的项。
TextBlocklist

文本阻止列表。
TextBlocklistMatchResultOutput

阻止列表匹配的结果。
TextBlocklistOutput

文本阻止列表。

类型别名

AddBlockItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

用于提取数组类型的帮助程序类型
GetPage

自定义函数的类型，用于定义如何获取页面和指向下一个页面的链接（如果有）。
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

用于推断响应类型中分页元素的帮助程序类型。此类型基于特定于 itemName 属性的 x-ms-pageable 的 swagger 信息生成，该属性指示在其中找到页面项的响应的属性。 默认值为 value。 此类型将允许我们根据作为第二个参数获取的响应提供强类型迭代器
RemoveBlockItemsParameters
TextBlockItemListOutput

TextBlockItem 项的分页集合
TextBlocklistListOutput

TextBlocklist 项的分页集合
TextBlocklistResourceMergeAndPatch

资源实例。

函数

default(string, KeyCredential, ClientOptions)

初始化 ContentSafetyClient 的新实例
isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)
isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)
isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)
isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)
isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse)
isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse)
isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)
isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

帮助程序根据 Autorest x-ms-pageable 扩展规范对初始响应的结果进行分页

函数详细信息

default(string, KeyCredential, ClientOptions)

初始化 ContentSafetyClient 的新实例

function default(endpoint: string, credentials: KeyCredential, options?: ClientOptions): ContentSafetyClient

参数

endpoint

string

支持的认知服务终结点（协议和主机名，例如：https://< resource-name.cognitiveservices.azure.com>）。

credentials
KeyCredential

唯一标识客户端凭据

options
ClientOptions

所有可选参数的参数

返回

ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse) 

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

参数

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

返回

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse) 

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

参数

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

返回

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse) 

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

参数

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

返回

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse) 

function isUnexpected(response: CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse): response

参数

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

返回

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse) 

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

参数

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

返回

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse) 

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

参数

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

返回

response

isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse) 

function isUnexpected(response: AddBlockItems200Response | AddBlockItemsDefaultResponse): response

参数

response

AddBlockItems200Response | AddBlockItemsDefaultResponse

返回

response

isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse) 

function isUnexpected(response: RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse): response

参数

response

RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse

返回

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse) 

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

参数

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

返回

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse) 

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

参数

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

返回

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

帮助程序根据 Autorest x-ms-pageable 扩展规范对初始响应的结果进行分页

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

参数

client
Client

用于发送下一页请求的客户端

initialResponse

TResponse

包含 nextLink 和元素当前页的初始响应

options

PagingOptions<TResponse>

返回

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator 循环访问元素