@azure-rest/ai-content-safety package

Schnittstellen

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response	Die Anforderung war erfolgreich.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions	Die Anforderung zum Hinzufügen von blocklistItems zu einer Textblockliste.
AddOrUpdateTextBlocklistItemsResultOutput	Die Antwort auf das Hinzufügen von blocklistItems zur Textblockliste.
AnalyzeImage
AnalyzeImage200Response	Die Anforderung war erfolgreich.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions	Die Bildanalyseanforderung.
AnalyzeImageOptionsOutput	Die Bildanalyseanforderung.
AnalyzeImageResultOutput	Die Antwort auf die Bildanalyse.
AnalyzeText
AnalyzeText200Response	Die Anforderung war erfolgreich.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions	Die Textanalyseanforderung.
AnalyzeTextOptionsOutput	Die Textanalyseanforderung.
AnalyzeTextResultOutput	Die Antwort der Textanalyse.
CreateOrUpdateTextBlocklist200Response	Die Anforderung war erfolgreich.
CreateOrUpdateTextBlocklist201Response	Die Anforderung war erfolgreich, und als Ergebnis wurde eine neue Ressource erstellt.
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response	Es gibt keinen Inhalt, der für diese Anforderung gesendet werden kann, aber die Header können nützlich sein.
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response	Die Anforderung war erfolgreich.
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response	Die Anforderung war erfolgreich.
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput	Ergebnis der Bildanalyse.
ImageData	Das Bild kann entweder Base64-codierte Bytes oder eine Blob-URL sein. Sie können nur eine dieser Optionen auswählen. Wenn beide bereitgestellt werden, wird die Anforderung abgelehnt. Die maximale Bildgröße beträgt 2048 x 2048 Pixel und sollte 4 MB nicht überschreiten, während die minimale Bildgröße 50 x 50 Pixel beträgt.
ImageDataOutput	Das Bild kann entweder Base64-codierte Bytes oder eine Blob-URL sein. Sie können nur eine dieser Optionen auswählen. Wenn beide bereitgestellt werden, wird die Anforderung abgelehnt. Die maximale Bildgröße beträgt 2048 x 2048 Pixel und sollte 4 MB nicht überschreiten, während die minimale Bildgröße 50 x 50 Pixel beträgt.
ListTextBlocklistItems
ListTextBlocklistItems200Response	Die Anforderung war erfolgreich.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response	Die Anforderung war erfolgreich.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions	Optionen für das Paginghilfsprogramm
RemoveBlocklistItems
RemoveBlocklistItems204Response	Es gibt keinen Inhalt, der für diese Anforderung gesendet werden kann, aber die Header können nützlich sein.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions	Die Anforderung zum Entfernen von blocklistItems aus einer Textblockliste.
Routes
TextBlocklist	Textblockliste.
TextBlocklistItem	Element in einer TextBlocklist.
TextBlocklistItemOutput	Element in einer TextBlocklist.
TextBlocklistMatchOutput	Das Ergebnis der Blocklisteneinstimmung.
TextBlocklistOutput	Textblockliste.
TextCategoriesAnalysisOutput	Ergebnis der Textanalyse.

Typaliase

AddOrUpdateBlocklistItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType	Hilfstyp zum Extrahieren des Arraytyps
GetPage	Der Typ einer benutzerdefinierten Funktion, die definiert, wie eine Seite und ggf. ein Link zur nächsten Seite abgerufen werden.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PagedTextBlocklistItemOutput	Ausgelagerte Auflistung von TextBlocklistItem-Elementen
PagedTextBlocklistOutput	Ausgelagerte Auflistung von TextBlocklist-Elementen
PaginateReturn	Hilfstyp zum Ableiten des Typs der ausgelagerten Elemente aus dem Antworttyp Dieser Typ wird basierend auf den swagger-Informationen für x-ms-pageable speziell für die itemName-Eigenschaft generiert, die die Eigenschaft der Antwort angibt, in der die Seitenelemente gefunden werden. Standardwert: value. Dieser Typ ermöglicht es uns, einen stark typisierten Iterator basierend auf der Antwort bereitzustellen, die wir als zweiten Parameter erhalten.
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch	Die Ressource instance.

Functions

default(string, TokenCredential | KeyCredential, ClientOptions)	Initialisieren einer neuen instance vonContentSafetyClient
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>)	Hilfsprogramm zum Paginieren von Ergebnissen aus einer ersten Antwort, die der Spezifikation der Autorest-Erweiterung x-ms-pageable folgt

Details zur Funktion

default(string, TokenCredential | KeyCredential, ClientOptions)

Initialisieren einer neuen instance vonContentSafetyClient

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

Parameter

endpoint

string

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B.: https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

Eindeutiges Identifizieren von Clientanmeldeinformationen

options

ClientOptions

der Parameter für alle optionalen Parameter

Gibt zurück

ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parameter

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

Gibt zurück

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parameter

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Gibt zurück

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parameter

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

Gibt zurück

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parameter

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

Gibt zurück

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parameter

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

Gibt zurück

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parameter

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

Gibt zurück

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parameter

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

Gibt zurück

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parameter

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

Gibt zurück

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parameter

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

Gibt zurück

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parameter

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

Gibt zurück

response

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

Hilfsprogramm zum Paginieren von Ergebnissen aus einer ersten Antwort, die der Spezifikation der Autorest-Erweiterung x-ms-pageable folgt

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

Parameter

client

Client

Client, der zum Senden der Anforderungen der nächsten Seite verwendet werden soll

initialResponse

TResponse

Erste Antwort, die die nextLink- und aktuelle Seite von Elementen enthält

options

PagingOptions<TResponse>

Gibt zurück

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator zum Durchlaufen der Elemente