@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	協助程式類型，從回應類型推斷分頁專案的 Type 這個類型會根據 x-ms-pageable 的 swagger 資訊，特別在 itemName 屬性上產生，這表示找到頁面專案之回應的屬性。 預設值是 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://.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 逐一查看元素