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

@azure-rest/ai-content-safety package

接口

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response	请求已成功。
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions	向文本阻止列表添加 blocklistItems 的请求。
AddOrUpdateTextBlocklistItemsResultOutput	将 blocklistItems 添加到文本阻止列表的响应。
AnalyzeImage
AnalyzeImage200Response	请求已成功。
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions	图像分析请求。
AnalyzeImageResultOutput	图像分析响应。
AnalyzeText
AnalyzeText200Response	请求已成功。
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions	文本分析请求。
AnalyzeTextResultOutput	文本分析响应。
ContentSafetyClientOptions	客户端的可选参数
CreateOrUpdateTextBlocklist200Response	请求已成功。
CreateOrUpdateTextBlocklist201Response	请求已成功，因此创建了一个新资源。
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response	没有要为此请求发送的内容，但标头可能很有用。
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response	请求已成功。
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response	请求已成功。
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput	图像分析结果。
ImageData	该图像可以是 base64 编码的字节或 Blob URL。 只能选择其中一个选项。 如果两者均已提供，将拒绝请求。 最大图像大小为 2048 x 2048 像素，不应超过 4 MB，最小图像大小为 50 x 50 像素。
ListTextBlocklistItems
ListTextBlocklistItems200Response	请求已成功。
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response	请求已成功。
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PageSettings	跟踪分页迭代设置的接口
PagedAsyncIterableIterator	允许异步迭代到完成和逐页迭代的接口。
PagedTextBlocklistItemOutput	TextBlocklistItem 项的分页集合
PagedTextBlocklistOutput	TextBlocklist 项的分页集合
PagingOptions	分页帮助程序的选项
RemoveBlocklistItems
RemoveBlocklistItems204Response	没有要为此请求发送的内容，但标头可能很有用。
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions	从文本阻止列表中删除 blocklistItems 的请求。
Routes
TextBlocklist	文本阻止列表。
TextBlocklistItem	TextBlocklist 中的项。
TextBlocklistItemOutput	TextBlocklist 中的项。
TextBlocklistMatchOutput	阻止列表匹配的结果。
TextBlocklistOutput	文本阻止列表。
TextCategoriesAnalysisOutput	文本分析结果。

类型别名

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType	AnalyzeImageOutputType 的别名
AnalyzeImageParameters
AnalyzeTextOutputType	AnalyzeTextOutputType 的别名
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType	用于提取数组类型的帮助程序类型
GetPage	自定义函数的类型，用于定义如何获取页面和指向下一个页面的链接（如果有）。
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ImageCategory	ImageCategory 的别名
ImageCategoryOutput	ImageCategoryOutput 的别名
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn	用于推断响应类型中分页元素的帮助程序类型。此类型基于特定于 itemName 属性的 x-ms-pageable 的 swagger 信息生成，该属性指示在其中找到页面项的响应的属性。 默认值为 value。 此类型将允许我们根据作为第二个参数获取的响应提供强类型迭代器
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch	资源实例。
TextCategory	TextCategory 的别名
TextCategoryOutput	TextCategoryOutput 的别名

函数

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)	初始化 ContentSafetyClient 的新实例
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)
isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)
isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)
isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)
isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)
isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)
isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)
isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	帮助程序根据 Autorest x-ms-pageable 扩展规范对初始响应的结果进行分页

函数详细信息

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

初始化 ContentSafetyClient 的新实例

function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ContentSafetyClientOptions): ContentSafetyClient

参数

endpointParam

string

支持的认知服务终结点（协议和主机名，例如：https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

唯一标识客户端凭据

options

ContentSafetyClientOptions

所有可选参数的参数

返回

ContentSafetyClient

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

参数

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

返回

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

参数

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

返回

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(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

参数

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

返回

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

参数

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

返回

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 循环访问元素