Delen via

@azure-rest/ai-content-safety package

  • Referentie

Interfaces

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

De aanvraag is geslaagd.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

De aanvraag om blocklistItems toe te voegen aan een tekstblokkeringslijst.
AddOrUpdateTextBlocklistItemsResultOutput

Het antwoord van het toevoegen van blocklistItems aan de tekstblokkeringslijst.
AnalyzeImage
AnalyzeImage200Response

De aanvraag is geslaagd.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

De aanvraag voor afbeeldingsanalyse.
AnalyzeImageOptionsOutput

De aanvraag voor afbeeldingsanalyse.
AnalyzeImageResultOutput

Het antwoord van de afbeeldingsanalyse.
AnalyzeText
AnalyzeText200Response

De aanvraag is geslaagd.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

De aanvraag voor tekstanalyse.
AnalyzeTextOptionsOutput

De aanvraag voor tekstanalyse.
AnalyzeTextResultOutput

Het antwoord van de tekstanalyse.
CreateOrUpdateTextBlocklist200Response

De aanvraag is geslaagd.
CreateOrUpdateTextBlocklist201Response

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Er kan geen inhoud worden verzonden voor deze aanvraag, maar de headers kunnen nuttig zijn.
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

De aanvraag is geslaagd.
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

De aanvraag is geslaagd.
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput

Resultaat van afbeeldingsanalyse.
ImageData

De afbeelding kan base64 gecodeerde bytes of een blob-URL zijn. U kunt slechts één van deze opties kiezen. Als beide zijn opgegeven, wordt de aanvraag geweigerd. De maximale afbeeldingsgrootte is 2048 x 2048 pixels en mag niet groter zijn dan 4 MB, terwijl de minimale afbeeldingsgrootte 50 x 50 pixels is.
ImageDataOutput

De afbeelding kan base64 gecodeerde bytes of een blob-URL zijn. U kunt slechts één van deze opties kiezen. Als beide zijn opgegeven, wordt de aanvraag geweigerd. De maximale afbeeldingsgrootte is 2048 x 2048 pixels en mag niet groter zijn dan 4 MB, terwijl de minimale afbeeldingsgrootte 50 x 50 pixels is.
ListTextBlocklistItems
ListTextBlocklistItems200Response

De aanvraag is geslaagd.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

De aanvraag is geslaagd.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

Opties voor de paging-helper
RemoveBlocklistItems
RemoveBlocklistItems204Response

Er kan geen inhoud worden verzonden voor deze aanvraag, maar de headers kunnen nuttig zijn.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

De aanvraag om blocklistItems te verwijderen uit een tekstblokkeringslijst.
Routes
TextBlocklist

Tekstblokkeringslijst.
TextBlocklistItem

Item in een TextBlocklist.
TextBlocklistItemOutput

Item in een TextBlocklist.
TextBlocklistMatchOutput

Het resultaat van de overeenkomst op de blokkeringslijst.
TextBlocklistOutput

Tekstblokkeringslijst.
TextCategoriesAnalysisOutput

Resultaat van tekstanalyse.

Type-aliassen

AddOrUpdateBlocklistItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Helpertype om het type van een matrix te extraheren
GetPage

Het type aangepaste functie waarmee wordt gedefinieerd hoe u een pagina en een koppeling naar de volgende pagina kunt ophalen, indien van toepassing.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PagedTextBlocklistItemOutput

Paged collection of TextBlocklistItem items paged
PagedTextBlocklistOutput

Gepaginade verzameling TextBlocklist-items
PaginateReturn

Helpertype om het Type van de wisselbare elementen af te maken van het antwoordtype Dit type wordt gegenereerd op basis van de swagger-informatie voor x-ms-pageable specifiek op de eigenschap itemName, waarmee de eigenschap wordt aangegeven van het antwoord waar de pagina-items zich bevinden. De standaardwaarde is value. Met dit type kunnen we sterk getypte Iterator opgeven op basis van het antwoord dat we krijgen als tweede parameter
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

Het resource-exemplaar.

Functies

default(string, TokenCredential | KeyCredential, ClientOptions)

Initialiseer een nieuw exemplaar van 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>)

Helper voor het pagineren van resultaten van een eerste antwoord dat de specificatie van de Autorest-extensie x-ms-pageable volgt

Functiedetails

default(string, TokenCredential | KeyCredential, ClientOptions)

Initialiseer een nieuw exemplaar van ContentSafetyClient

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

Parameters

endpoint

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

unieke identificatie van clientreferenties

options
ClientOptions

de parameter voor alle optionele parameters

Retouren

ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse) 

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parameters

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

Retouren

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse) 

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parameters

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Retouren

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse) 

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parameters

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

Retouren

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse) 

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

Parameters

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

Retouren

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse) 

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parameters

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

Retouren

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse) 

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parameters

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

Retouren

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse) 

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parameters

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

Retouren

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse) 

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parameters

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

Retouren

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse) 

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parameters

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

Retouren

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse) 

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parameters

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

Retouren

response

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

Helper voor het pagineren van resultaten van een eerste antwoord dat de specificatie van de Autorest-extensie x-ms-pageable volgt

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

Parameters

client
Client

Client die moet worden gebruikt voor het verzenden van aanvragen voor de volgende pagina

initialResponse

TResponse

Eerste antwoord met de nextLink en de huidige pagina met elementen

options

PagingOptions<TResponse>

Retouren

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator om de elementen te herhalen