@azure-rest/ai-content-safety package

Interfejsy

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response	Żądanie zakończyło się pomyślnie.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions	Żądanie dodania elementu blocklistItems do listy bloków tekstowych.
AddOrUpdateTextBlocklistItemsResultOutput	Odpowiedź na dodanie elementu blocklistItems do listy bloków tekstowych.
AnalyzeImage
AnalyzeImage200Response	Żądanie zakończyło się pomyślnie.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions	Żądanie analizy obrazu.
AnalyzeImageResultOutput	Odpowiedź na analizę obrazu.
AnalyzeText
AnalyzeText200Response	Żądanie zakończyło się pomyślnie.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions	Żądanie analizy tekstu.
AnalyzeTextResultOutput	Odpowiedź analizy tekstu.
ContentSafetyClientOptions	Opcjonalne parametry klienta
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
ImageCategoriesAnalysisOutput	Wynik analizy obrazu.
ImageData	Obraz może być zakodowany w formacie base64 bajtami lub adresem URL obiektu blob. Możesz wybrać tylko jedną z tych opcji. Jeśli oba te elementy zostaną podane, żądanie zostanie odrzucone. Maksymalny rozmiar obrazu to 2048 x 2048 pikseli i nie powinien przekraczać 4 MB, podczas gdy minimalny rozmiar obrazu to 50 x 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
PageSettings	Interfejs śledzący ustawienia iteracji stronicowanej
PagedAsyncIterableIterator	Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony.
PagedTextBlocklistItemOutput	Stronicowana kolekcja elementów TextBlocklistItem
PagedTextBlocklistOutput	Stronicowana kolekcja elementów TextBlocklist
PagingOptions	Opcje pomocnika stronicowania
RemoveBlocklistItems
RemoveBlocklistItems204Response	Brak zawartości do wysłania dla tego żądania, ale nagłówki mogą być przydatne.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions	Żądanie usunięcia elementu blocklistItems z listy bloków tekstowych.
Routes
TextBlocklist	Lista bloków tekstu.
TextBlocklistItem	Element w elemencie TextBlocklist.
TextBlocklistItemOutput	Element w elemencie TextBlocklist.
TextBlocklistMatchOutput	Wynik dopasowania listy zablokowanych.
TextBlocklistOutput	Lista bloków tekstu.
TextCategoriesAnalysisOutput	Wynik analizy tekstu.

Aliasy typu

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType	Alias dla elementu AnalyzeImageOutputType
AnalyzeImageParameters
AnalyzeTextOutputType	Alias dla elementu AnalyzeTextOutputType
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
ImageCategory	Alias dla kategorii obrazów
ImageCategoryOutput	Alias dla elementu ImageCategoryOutput
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn	Typ pomocnika, aby wywnioskować typ stronicowanych elementów z typu odpowiedzi Ten typ jest generowany na podstawie informacji o programie Swagger dla elementu x-ms-pageable w szczególności na 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 zapewnienie silnie typizowanego iteratora na podstawie odpowiedzi, która otrzymujemy jako drugi parametr
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch	Wystąpienie zasobu.
TextCategory	Alias dla textCategory
TextCategoryOutput	Alias dla textCategoryOutput

Funkcje

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)	Inicjowanie nowego wystąpienia 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>)	Pomocnik do stronicowania wyników z początkowej odpowiedzi zgodnej ze specyfikacją rozszerzenia Autorest x-ms-pageable

Szczegóły funkcji

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Inicjowanie nowego wystąpienia ContentSafetyClient

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

Parametry

endpointParam

string

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

credentials

TokenCredential | KeyCredential

unikatowe identyfikowanie poświadczeń klienta

options

ContentSafetyClientOptions

parametr dla wszystkich parametrów opcjonalnych

Zwraca

ContentSafetyClient

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parametry

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Zwraca

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parametry

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

Zwraca

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parametry

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

Zwraca

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parametry

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

Zwraca

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parametry

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

Zwraca

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parametry

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

Zwraca

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parametry

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

Zwraca

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parametry

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

Zwraca

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parametry

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

Zwraca

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parametry

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

Zwraca

response

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

Pomocnik do stronicowania wyników 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 element nextLink i bieżącą stronę elementów

options

PagingOptions<TResponse>

Zwraca

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator w celu iterowania elementów