Dela via

@azure-rest/ai-content-safety package

  • Referens

Gränssnitt

AddBlockItems
AddBlockItems200Response

Begäran har slutförts.
AddBlockItemsBodyParam
AddBlockItemsDefaultHeaders
AddBlockItemsDefaultResponse
AddBlockItemsOptions

Begäran om att lägga till blockItems i textblockeringslistan.
AddBlockItemsResultOutput

Svaret på att lägga till blockItems i textblockeringslistan.
AnalyzeImage
AnalyzeImage200Response

Begäran har slutförts.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Bildens analysbegäran.
AnalyzeImageOptionsOutput

Bildens analysbegäran.
AnalyzeImageResultOutput

Bildens analyssvar.
AnalyzeText
AnalyzeText200Response

Begäran har slutförts.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Textens analysbegäran.
AnalyzeTextOptionsOutput

Textens analysbegäran.
AnalyzeTextResultOutput

Textens analyssvar
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
ImageAnalyzeSeverityResultOutput

Bildanalysresultat.
ImageData

Innehållet eller blob-URL:en för bilden kan vara base64-kodningsbyte eller blob-URL. Om båda anges avvisas begäran. Den maximala storleken på bilden är 2 048 bildpunkter * 2 048 bildpunkter, inte större än 4 MB samtidigt. Den minsta storleken på bilden är 50 bildpunkter * 50 bildpunkter.
ImageDataOutput

Innehållet eller blob-URL:en för bilden kan vara base64-kodningsbyte eller blob-URL. Om båda anges avvisas begäran. Den maximala storleken på bilden är 2 048 bildpunkter * 2 048 bildpunkter, inte större än 4 MB samtidigt. Den minsta storleken på bilden är 50 bildpunkter * 50 bildpunkter.
ListTextBlocklistItems
ListTextBlocklistItems200Response

Begäran har slutförts.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Begäran har slutförts.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

Alternativ för växlingshjälpen
RemoveBlockItems
RemoveBlockItems204Response

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

Begäran om att ta bort blockItems från textblockeringslistan.
Routes
TextAnalyzeSeverityResultOutput

Textanalysresultat.
TextBlockItemInfo

Blockera objektinformation i textblockeringslistan.
TextBlockItemOutput

Objekt i TextBlocklist.
TextBlocklist

Textblockeringslista.
TextBlocklistMatchResultOutput

Resultatet av blocklistmatchning.
TextBlocklistOutput

Textblockeringslista.

Typalias

AddBlockItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

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

Typen av anpassad funktion som definierar hur du hämtar en sida och en länk till nästa om det finns någon.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
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. Den här typen gör att vi kan tillhandahålla starkt skriven Iterator baserat på svaret vi får som andra parameter
RemoveBlockItemsParameters
TextBlockItemListOutput

Sidsamling med TextBlockItem-objekt
TextBlocklistListOutput

Sidsamling med TextBlocklist-objekt
TextBlocklistResourceMergeAndPatch

Resursinstansen.

Funktioner

default(string, KeyCredential, ClientOptions)

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

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

Funktionsinformation

default(string, KeyCredential, ClientOptions)

Initiera en ny instans av ContentSafetyClient

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

Parametrar

endpoint

string

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

credentials
KeyCredential

unikt identifiera klientautentiseringsuppgifter

options
ClientOptions

parametern för alla valfria parametrar

Returer

ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse) 

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parametrar

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

Returer

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse) 

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parametrar

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Returer

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse) 

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parametrar

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

Returer

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse) 

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

Parametrar

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

Returer

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse) 

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parametrar

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

Returer

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse) 

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parametrar

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

Returer

response

isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse) 

function isUnexpected(response: AddBlockItems200Response | AddBlockItemsDefaultResponse): response

Parametrar

response

AddBlockItems200Response | AddBlockItemsDefaultResponse

Returer

response

isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse) 

function isUnexpected(response: RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse): response

Parametrar

response

RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse

Returer

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse) 

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parametrar

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

Returer

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse) 

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parametrar

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

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-tillägget x-ms-pageable

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 nextLink och aktuell sida med element

options

PagingOptions<TResponse>

Returer

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator för att iterera elementen