Freigeben über


@azure-rest/ai-content-safety package

Schnittstellen

AddBlockItems
AddBlockItems200Response

Die Anforderung war erfolgreich.

AddBlockItemsBodyParam
AddBlockItemsDefaultHeaders
AddBlockItemsDefaultResponse
AddBlockItemsOptions

Die Anforderung zum Hinzufügen von blockItems zur Textblockliste.

AddBlockItemsResultOutput

Die Antwort auf das Hinzufügen von blockItems zur Textblockliste.

AnalyzeImage
AnalyzeImage200Response

Die Anforderung war erfolgreich.

AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Die Analyseanforderung des Bilds.

AnalyzeImageOptionsOutput

Die Analyseanforderung des Bilds.

AnalyzeImageResultOutput

Die Analyseantwort des Bilds.

AnalyzeText
AnalyzeText200Response

Die Anforderung war erfolgreich.

AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Die Analyseanforderung des Texts.

AnalyzeTextOptionsOutput

Die Analyseanforderung des Texts.

AnalyzeTextResultOutput

Die Analyseantwort des Texts

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
ImageAnalyzeSeverityResultOutput

Ergebnis der Bildanalyse.

ImageData

Der Inhalt oder die Blob-URL des Bilds kann Base64-Codierungsbytes oder Blob-URL sein. Wenn beide erteilt werden, wird die Anforderung abgelehnt. Die maximale Größe des Bilds beträgt 2048 Pixel * 2048 Pixel, nicht größer als 4 MB gleichzeitig. Die Mindestgröße des Bilds beträgt 50 Pixel * 50 Pixel.

ImageDataOutput

Der Inhalt oder die Blob-URL des Bilds kann Base64-Codierungsbytes oder Blob-URL sein. Wenn beide erteilt werden, wird die Anforderung abgelehnt. Die maximale Größe des Bilds beträgt 2048 Pixel * 2048 Pixel, nicht größer als 4 MB gleichzeitig. Die Mindestgröße des Bilds beträgt 50 Pixel * 50 Pixel.

ListTextBlocklistItems
ListTextBlocklistItems200Response

Die Anforderung war erfolgreich.

ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Die Anforderung war erfolgreich.

ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

Optionen für das Paginghilfsprogramm

RemoveBlockItems
RemoveBlockItems204Response

Es gibt keinen Inhalt, der für diese Anforderung gesendet werden kann, aber die Header können nützlich sein.

RemoveBlockItemsBodyParam
RemoveBlockItemsDefaultHeaders
RemoveBlockItemsDefaultResponse
RemoveBlockItemsOptions

Die Anforderung zum Entfernen von blockItems aus der Textblockliste.

Routes
TextAnalyzeSeverityResultOutput

Ergebnis der Textanalyse.

TextBlockItemInfo

Blockelementinformationen in der Textblockliste.

TextBlockItemOutput

Element in TextBlocklist.

TextBlocklist

Textblockliste.

TextBlocklistMatchResultOutput

Das Ergebnis der Blocklisteneinstimmung.

TextBlocklistOutput

Textblockliste.

Typaliase

AddBlockItemsParameters
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
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.

RemoveBlockItemsParameters
TextBlockItemListOutput

Ausgelagerte Auflistung von TextBlockItem-Elementen

TextBlocklistListOutput

Ausgelagerte Auflistung von TextBlocklist-Elementen

TextBlocklistResourceMergeAndPatch

Die Ressource instance.

Functions

default(string, 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(AddBlockItems200Response | AddBlockItemsDefaultResponse)
isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse)
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, KeyCredential, ClientOptions)

Initialisieren einer neuen instance vonContentSafetyClient

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

Parameter

endpoint

string

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

credentials
KeyCredential

Eindeutiges Identifizieren von Clientanmeldeinformationen

options
ClientOptions

der Parameter für alle optionalen Parameter

Gibt zurück

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parameter

Gibt zurück

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse)

function isUnexpected(response: AddBlockItems200Response | AddBlockItemsDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse)

function isUnexpected(response: RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parameter

Gibt zurück

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parameter

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 zum Durchlaufen der Elemente