Dela via


@azure-rest/ai-content-safety package

Gränssnitt

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

Begäran har slutförts.

AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

Begäran om att lägga till blocklistItems i en textblockeringslista.

AddOrUpdateTextBlocklistItemsResultOutput

Svaret på att lägga till blocklistItems i textblockeringslistan.

AnalyzeImage
AnalyzeImage200Response

Begäran har slutförts.

AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Begäran om bildanalys.

AnalyzeImageResultOutput

Bildanalyssvaret.

AnalyzeText
AnalyzeText200Response

Begäran har slutförts.

AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Begäran om textanalys.

AnalyzeTextResultOutput

Textanalyssvaret.

ContentSafetyClientOptions

Valfria parametrar för klienten

CreateOrUpdateTextBlocklist200Response

Begäran har slutförts.

CreateOrUpdateTextBlocklist201Response

Begäran har slutförts och en ny resurs har skapats som ett resultat.

CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

Begäran har slutförts.

GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

Begäran har slutförts.

GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput

Bildanalysresultat.

ImageData

Avbildningen kan vara antingen base64-kodade byte eller en blob-URL. Du kan bara välja ett av dessa alternativ. Om båda tillhandahålls avvisas begäran. Den maximala bildstorleken är 2 048 x 2 048 bildpunkter och får inte överstiga 4 MB, medan den minsta bildstorleken är 50 x 50 bildpunkter.

ListTextBlocklistItems
ListTextBlocklistItems200Response

Begäran har slutförts.

ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Begäran har slutförts.

ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PageSettings

Ett gränssnitt som spårar inställningarna för sidsidig iteration

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

PagedTextBlocklistItemOutput

Sidsidig samling med TextBlocklistItem-objekt

PagedTextBlocklistOutput

Sidsidig samling med TextBlocklist-objekt

PagingOptions

Alternativ för växlingshjälpen

RemoveBlocklistItems
RemoveBlocklistItems204Response

Det finns inget innehåll att skicka för den här begäran, men rubrikerna kan vara användbara.

RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

Begäran om att ta bort blocklistItems från en textblockeringslista.

Routes
TextBlocklist

Textblockeringslista.

TextBlocklistItem

Objekt i en TextBlocklist.

TextBlocklistItemOutput

Objekt i en TextBlocklist.

TextBlocklistMatchOutput

Resultatet av blocklistmatchning.

TextBlocklistOutput

Textblockeringslista.

TextCategoriesAnalysisOutput

Textanalysresultat.

Typalias

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType

Alias för AnalyzeImageOutputType

AnalyzeImageParameters
AnalyzeTextOutputType

Alias för AnalyzeTextOutputType

AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Hjälptyp för att extrahera typen av en matris

GetPage

Typen av en anpassad funktion som definierar hur du hämtar en sida och en länk till nästa om någon.

GetTextBlocklistItemParameters
GetTextBlocklistParameters
ImageCategory

Alias för ImageCategory

ImageCategoryOutput

Alias för ImageCategoryOutput

ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

Hjälptyp för att härleda typen av sidelement från svarstypen Den här typen genereras baserat på swagger-informationen för x-ms-pageable specifikt på egenskapen itemName som anger egenskapen för svaret där sidobjekten hittas. Standardvärdet är value. Med den här typen kan vi ange en starkt typbaserad iterator baserat på svaret vi får som andra parameter

RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

Resursinstansen.

TextCategory

Alias för TextCategory

TextCategoryOutput

Alias för TextCategoryOutput

Funktioner

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Initiera en ny instans av 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>)

Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg

Funktionsinformation

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Initiera en ny instans av ContentSafetyClient

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

Parametrar

endpointParam

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://< resource-name.cognitiveservices.azure.com>).

credentials

TokenCredential | KeyCredential

unikt identifiera klientautentiseringsuppgifter

options
ContentSafetyClientOptions

parametern för alla valfria parametrar

Returer

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parametrar

Returer

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parametrar

Returer

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parametrar

Returer

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parametrar

Returer

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parametrar

Returer

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parametrar

Returer

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parametrar

Returer

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parametrar

Returer

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parametrar

Returer

response

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

Hjälp för att paginate resultat från ett första svar som följer specifikationen för Autorest x-ms-pageable tillägg

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

Parametrar

client
Client

Klienten som ska användas för att skicka nästa sidbegäranden

initialResponse

TResponse

Första svaret som innehåller nästaLänk och aktuell sida med element

options

PagingOptions<TResponse>

Returer

  • PagedAsyncIterableIterator för att iterera elementen