Freigeben über

@azure-rest/ai-content-safety package

Schnittstellen

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

Die Anforderung ist erfolgreich.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

Die Anforderung zum Hinzufügen von blocklistItems zu einer Textblockliste.
AddOrUpdateTextBlocklistItemsResultOutput

Die Antwort des Hinzufügens von BlocklistItems zur Textblockliste.
AnalyzeImage
AnalyzeImage200Response

Die Anforderung ist erfolgreich.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Die Anforderung für die Bildanalyse.
AnalyzeImageResultOutput

Die Antwort der Bildanalyse.
AnalyzeText
AnalyzeText200Response

Die Anforderung ist erfolgreich.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Die Textanalyseanforderung.
AnalyzeTextResultOutput

Die Textanalyseantwort.
ContentSafetyClientOptions

Die optionalen Parameter für den Client
CreateOrUpdateTextBlocklist200Response

Die Anforderung ist erfolgreich.
CreateOrUpdateTextBlocklist201Response

Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Header können nützlich sein.
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

Die Anforderung ist erfolgreich.
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

Die Anforderung ist 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 beides angegeben wird, wird der Antrag abgelehnt. Die maximale Bildgröße beträgt 2048 x 2048 Pixel und darf 4 MB nicht überschreiten, während die Mindestbildgröße 50 x 50 Pixel beträgt.
ListTextBlocklistItems
ListTextBlocklistItems200Response

Die Anforderung ist erfolgreich.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Die Anforderung ist erfolgreich.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PageSettings

Eine Schnittstelle, die die Einstellungen für die seitenseitige Iteration nachverfolgt
PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone iterierbare Iteration sowohl zum Abschluss als auch nach Seite ermöglicht.
PagedTextBlocklistItemOutput

Paged-Auflistung von TextBlocklistItem-Elementen
PagedTextBlocklistOutput

Paged-Auflistung von TextBlocklist-Elementen
PagingOptions

Optionen für das Paging-Hilfsprogramm
RemoveBlocklistItems
RemoveBlocklistItems204Response

Es gibt keinen Inhalt, der für diese Anforderung gesendet werden soll, aber die Header können nützlich sein.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

Die Anforderung, blocklistItems aus einer Textblockliste zu entfernen.
Routes
TextBlocklist

Textblockliste.
TextBlocklistItem

Element in einer TextBlocklist.
TextBlocklistItemOutput

Element in einer TextBlocklist.
TextBlocklistMatchOutput

Das Ergebnis der Blocklistenzuordnung.
TextBlocklistOutput

Textblockliste.
TextCategoriesAnalysisOutput

Ergebnis der Textanalyse.

Typaliase

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType

Alias für AnalyzeImageOutputType
AnalyzeImageParameters
AnalyzeTextOutputType

Alias für AnalyzeTextOutputType
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Hilfstyp zum Extrahieren des Typs eines Arrays
GetPage

Der Typ einer benutzerdefinierten Funktion, die definiert, wie eine Seite und ein Link zum nächsten abgerufen werden, falls vorhanden.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ImageCategory

Alias für ImageCategory
ImageCategoryOutput

Alias für ImageCategoryOutput
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

Hilfstyp zum Ableiten des Typs der seitenseitigen Elemente vom Antworttyp Dieser Typ wird basierend auf den Waggerinformationen für x-ms-pageable speziell auf der itemName-Eigenschaft generiert, die die Eigenschaft der Antwort angibt, in der die Seitenelemente gefunden werden. Der Standardwert ist value. Dieser Typ ermöglicht es uns, stark typierte Iterator basierend auf der Antwort bereitzustellen, die als zweiter Parameter abgerufen wird.
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

Die Ressourceninstanz.
TextCategory

Alias für TextCategory
TextCategoryOutput

Alias für TextCategoryOutput

Functions

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Initialisieren einer neuen Instanz von 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>)

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

Details zur Funktion

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Initialisieren einer neuen Instanz von ContentSafetyClient

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

Parameter

endpointParam

string

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

credentials

TokenCredential | KeyCredential

Eindeutige Identifizierung von Clientanmeldeinformationen

options
ContentSafetyClientOptions

der Parameter für alle optionalen Parameter

Gibt zurück

ContentSafetyClient

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse) 

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parameter

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Gibt zurück

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse) 

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parameter

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

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 auf die Spezifikation der Erweiterung Autorest 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 nächsten Seitenanforderungen verwendet werden soll

initialResponse

TResponse

Ursprüngliche 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