@azure-rest/ai-content-safety package

インターフェイス

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

要求は成功しました。

AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

テキスト ブロックリストに blocklistItems を追加する要求。

AddOrUpdateTextBlocklistItemsResultOutput

テキスト ブロックリストに blocklistItems を追加する応答。

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
ImageCategoriesAnalysisOutput

画像分析結果。

ImageData

イメージには、base64 でエンコードされたバイトまたは BLOB URL のいずれかを指定できます。 これらのオプションの 1 つだけを選択できます。 両方が指定されている場合、要求は拒否されます。 最大イメージ サイズは 2048 x 2048 ピクセルで、最小イメージ サイズは 50 x 50 ピクセルですが、4 MB を超えないようにしてください。

ImageDataOutput

イメージには、base64 でエンコードされたバイトまたは BLOB URL のいずれかを指定できます。 これらのオプションの 1 つだけを選択できます。 両方が指定されている場合、要求は拒否されます。 最大イメージ サイズは 2048 x 2048 ピクセルで、最小イメージ サイズは 50 x 50 ピクセルですが、4 MB を超えないようにしてください。

ListTextBlocklistItems
ListTextBlocklistItems200Response

要求は成功しました。

ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

要求は成功しました。

ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

ページング ヘルパーのオプション

RemoveBlocklistItems
RemoveBlocklistItems204Response

この要求に送信するコンテンツはありませんが、ヘッダーが役立つ場合があります。

RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

テキスト ブロックリストから blocklistItems を削除する要求。

Routes
TextBlocklist

テキスト ブロックリスト。

TextBlocklistItem

TextBlocklist 内のアイテム。

TextBlocklistItemOutput

TextBlocklist 内のアイテム。

TextBlocklistMatchOutput

ブロックリストの一致の結果。

TextBlocklistOutput

テキスト ブロックリスト。

TextCategoriesAnalysisOutput

テキスト分析結果。

型エイリアス

AddOrUpdateBlocklistItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

配列の型を抽出するヘルパー型

GetPage

ページの取得方法と次のページへのリンク (存在する場合) を定義するカスタム関数の型。

GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PagedTextBlocklistItemOutput

TextBlocklistItem アイテムの Paged コレクション

PagedTextBlocklistOutput

TextBlocklist アイテムの Paged コレクション

PaginateReturn

応答の種類からページ化された要素の Type を推論するヘルパー型 この型は、ページアイテムが見つかった応答のプロパティを示す itemName プロパティに対する x-ms-pageable の swagger 情報に基づいて生成されます。 既定値は value です。 この型を使用すると、2 番目のパラメーターとして取得する応答に基づいて厳密に型指定された反復子を提供できます

RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

リソース インスタンス。

機能

default(string, TokenCredential | KeyCredential, ClientOptions)

の新しいインスタンスを初期化する ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
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, ClientOptions)

の新しいインスタンスを初期化する ContentSafetyClient

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

パラメーター

endpoint

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など): https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

クライアント資格情報を一意に識別する

options
ClientOptions

すべての省略可能なパラメーターの パラメーター

戻り値

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

パラメーター

戻り値

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

パラメーター

戻り値

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

パラメーター

戻り値

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