Udostępnij za pośrednictwem


@azure-rest/ai-content-safety package

Interfejsy

AddBlockItems
AddBlockItems200Response

Żądanie zakończyło się pomyślnie.

AddBlockItemsBodyParam
AddBlockItemsDefaultHeaders
AddBlockItemsDefaultResponse
AddBlockItemsOptions

Żądanie dodania elementu blockItems do listy bloków tekstowych.

AddBlockItemsResultOutput

Odpowiedź dodawania elementów blockItems do listy bloków tekstowych.

AnalyzeImage
AnalyzeImage200Response

Żądanie zakończyło się pomyślnie.

AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Żądanie analizy obrazu.

AnalyzeImageOptionsOutput

Żądanie analizy obrazu.

AnalyzeImageResultOutput

Odpowiedź analizy obrazu.

AnalyzeText
AnalyzeText200Response

Żądanie zakończyło się pomyślnie.

AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Żądanie analizy tekstu.

AnalyzeTextOptionsOutput

Żądanie analizy tekstu.

AnalyzeTextResultOutput

Odpowiedź analizy tekstu

CreateOrUpdateTextBlocklist200Response

Żądanie zakończyło się pomyślnie.

CreateOrUpdateTextBlocklist201Response

Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób.

CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Brak zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

Żądanie zakończyło się pomyślnie.

GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

Żądanie zakończyło się pomyślnie.

GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageAnalyzeSeverityResultOutput

Wynik analizy obrazu.

ImageData

Adres URL zawartości lub obiektu blob obrazu może być zakodowany w formacie Base64 bajtów lub adres URL obiektu blob. Jeśli zostaną podane oba te elementy, żądanie zostanie odrzucone. Maksymalny rozmiar obrazu to 2048 pikseli * 2048 pikseli, nie większy niż 4 MB w tym samym czasie. Minimalny rozmiar obrazu to 50 pikseli * 50 pikseli.

ImageDataOutput

Adres URL zawartości lub obiektu blob obrazu może być zakodowany w formacie Base64 bajtów lub adres URL obiektu blob. Jeśli zostaną podane oba te elementy, żądanie zostanie odrzucone. Maksymalny rozmiar obrazu to 2048 pikseli * 2048 pikseli, nie większy niż 4 MB w tym samym czasie. Minimalny rozmiar obrazu to 50 pikseli * 50 pikseli.

ListTextBlocklistItems
ListTextBlocklistItems200Response

Żądanie zakończyło się pomyślnie.

ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Żądanie zakończyło się pomyślnie.

ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

Opcje pomocnika stronicowania

RemoveBlockItems
RemoveBlockItems204Response

Brak zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.

RemoveBlockItemsBodyParam
RemoveBlockItemsDefaultHeaders
RemoveBlockItemsDefaultResponse
RemoveBlockItemsOptions

Żądanie usunięcia elementów blockItems z listy bloków tekstowych.

Routes
TextAnalyzeSeverityResultOutput

Wynik analizy tekstu.

TextBlockItemInfo

Blokuj informacje o elemencie na liście bloków tekstowych.

TextBlockItemOutput

Element w elemencie TextBlocklist.

TextBlocklist

Lista bloków tekstu.

TextBlocklistMatchResultOutput

Wynik dopasowania listy bloków.

TextBlocklistOutput

Lista bloków tekstu.

Aliasy typu

AddBlockItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Typ pomocnika w celu wyodrębnienia typu tablicy

GetPage

Typ funkcji niestandardowej, która definiuje sposób pobierania strony i linku do następnej, jeśli istnieje.

GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

Typ pomocnika, aby wywnioskować typ stronicowanych elementów z typu odpowiedzi Ten typ jest generowany na podstawie informacji o strukturze swagger dla elementu x-ms-pageable konkretnie dla właściwości itemName, która wskazuje właściwość odpowiedzi, w której znaleziono elementy strony. Wartość domyślna to value. Ten typ umożliwi nam podanie silnie typizowanego iteratora na podstawie odpowiedzi, która otrzymujemy jako drugi parametr

RemoveBlockItemsParameters
TextBlockItemListOutput

Stronicowana kolekcja elementów TextBlockItem

TextBlocklistListOutput

Stronicowana kolekcja elementów TextBlocklist

TextBlocklistResourceMergeAndPatch

Wystąpienie zasobu.

Funkcje

default(string, KeyCredential, ClientOptions)

Inicjowanie nowego wystąpienia klasy 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>)

Pomocnik do dzielenia wyników na strony z początkowej odpowiedzi zgodnej ze specyfikacją rozszerzenia Autorest x-ms-pageable

Szczegóły funkcji

default(string, KeyCredential, ClientOptions)

Inicjowanie nowego wystąpienia klasy ContentSafetyClient

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

Parametry

endpoint

string

Obsługiwane punkty końcowe usług Cognitive Services (protokół i nazwa hosta, na przykład: https://.cognitiveservices.azure.com).

credentials
KeyCredential

unikatowe identyfikowanie poświadczeń klienta

options
ClientOptions

parametr dla wszystkich parametrów opcjonalnych

Zwraca

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parametry

Zwraca

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse)

function isUnexpected(response: AddBlockItems200Response | AddBlockItemsDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse)

function isUnexpected(response: RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parametry

Zwraca

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parametry

Zwraca

response

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

Pomocnik do dzielenia wyników na strony z początkowej odpowiedzi zgodnej ze specyfikacją rozszerzenia Autorest x-ms-pageable

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

Parametry

client
Client

Klient do użycia do wysyłania żądań następnej strony

initialResponse

TResponse

Początkowa odpowiedź zawierająca ciąg nextLink i bieżącą stronę elementów

options

PagingOptions<TResponse>

Zwraca

  • PagedAsyncIterableIterator w celu iteracji elementów