Sdílet prostřednictvím


@azure-rest/ai-content-safety package

Rozhraní

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

Požadavek byl úspěšný.

AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

Požadavek na přidání blocklistItems do seznamu blokovaných textu.

AddOrUpdateTextBlocklistItemsResultOutput

Odpověď přidání blocklistItems do seznamu blokovaných textů.

AnalyzeImage
AnalyzeImage200Response

Požadavek byl úspěšný.

AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

Požadavek na analýzu obrázků.

AnalyzeImageResultOutput

Odpověď na analýzu obrázků.

AnalyzeText
AnalyzeText200Response

Požadavek byl úspěšný.

AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

Požadavek na analýzu textu.

AnalyzeTextResultOutput

Odpověď na analýzu textu.

ContentSafetyClientOptions

Volitelné parametry klienta

CreateOrUpdateTextBlocklist200Response

Požadavek byl úspěšný.

CreateOrUpdateTextBlocklist201Response

Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

Požadavek byl úspěšný.

GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

Požadavek byl úspěšný.

GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput

Výsledek analýzy obrázků

ImageData

Obrázek může mít kódování base64 bajtů nebo adresu URL objektu blob. Můžete zvolit jenom jednu z těchto možností. Pokud je k dispozici obojí, žádost bude odmítnuta. Maximální velikost obrázku je 2048 × 2048 pixelů a neměla by překročit 4 MB, zatímco minimální velikost obrázku je 50 × 50 pixelů.

ListTextBlocklistItems
ListTextBlocklistItems200Response

Požadavek byl úspěšný.

ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

Požadavek byl úspěšný.

ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PageSettings

Rozhraní, které sleduje nastavení stránkované iterace

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iteraci k dokončení i po stránce.

PagedTextBlocklistItemOutput

Stránkovaná kolekce položek TextBlocklistItem

PagedTextBlocklistOutput

Paged collection of TextBlocklist items

PagingOptions

Možnosti pomocné rutiny stránkování

RemoveBlocklistItems
RemoveBlocklistItems204Response

Pro tento požadavek se nedá odeslat žádný obsah, ale hlavičky můžou být užitečné.

RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

Požadavek na odebrání blocklistItems z seznamu blokovaných textu.

Routes
TextBlocklist

Seznam blokovaných textu

TextBlocklistItem

Položka v seznamu TextBlocklist.

TextBlocklistItemOutput

Položka v seznamu TextBlocklist.

TextBlocklistMatchOutput

Výsledek shody seznamu blokovaných položek.

TextBlocklistOutput

Seznam blokovaných textu

TextCategoriesAnalysisOutput

Výsledek analýzy textu

Aliasy typu

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType

Alias pro AnalyzeImageOutputType

AnalyzeImageParameters
AnalyzeTextOutputType

Alias pro AnalyzeTextOutputType

AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Pomocný typ pro extrahování typu pole

GetPage

Typ vlastní funkce, která definuje, jak získat stránku, a odkaz na další, pokud existuje.

GetTextBlocklistItemParameters
GetTextBlocklistParameters
ImageCategory

Alias pro ImageCategory

ImageCategoryOutput

Alias pro ImageCategoryOutput

ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

Pomocný typ pro odvození typu stránkovaných prvků z typu odpovědi Tento typ je generován na základě informací swagger pro x-ms-pageable konkrétně na itemName vlastnost, která označuje vlastnost odpovědi, kde jsou nalezeny položky stránky. Výchozí hodnota je value. Tento typ nám umožní poskytnout iterátor silného typu na základě odpovědi, která se nám zobrazí jako druhý parametr.

RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

Instance prostředku.

TextCategory

Alias pro TextCategory

TextCategoryOutput

Alias pro TextCategoryOutput

Funkce

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Inicializace nové instance 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>)

Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable

Podrobnosti funkce

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Inicializace nové instance ContentSafetyClient

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

Parametry

endpointParam

string

Podporované koncové body služeb Cognitive Services (protokol a název hostitele, například: https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

jedinečně identifikovat přihlašovací údaje klienta

options
ContentSafetyClientOptions

parametr pro všechny volitelné parametry

Návraty

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parametry

Návraty

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parametry

Návraty

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parametry

Návraty

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parametry

Návraty

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parametry

Návraty

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parametry

Návraty

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parametry

Návraty

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parametry

Návraty

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parametry

Návraty

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parametry

Návraty

response

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

Pomocná rutina stránkovat výsledky z počáteční odpovědi, která odpovídá specifikaci rozšíření Automatické x-ms-pageable

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

Parametry

client
Client

Klient, který se má použít k odesílání žádostí na další stránku

initialResponse

TResponse

Počáteční odpověď obsahující nextLink a aktuální stránku prvků

options

PagingOptions<TResponse>

Návraty

  • PagedAsyncIterableIterator pro iteraci prvků