@azure-rest/ai-content-safety package

  • Referência

Interfaces

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

O pedido foi bem-sucedido.
AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

O pedido para adicionar blocklistItems a uma lista de bloqueios de texto.
AddOrUpdateTextBlocklistItemsResultOutput

A resposta da adição de blocklistItems à lista de bloqueios de texto.
AnalyzeImage
AnalyzeImage200Response

O pedido foi bem-sucedido.
AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

O pedido de análise de imagens.
AnalyzeImageOptionsOutput

O pedido de análise de imagens.
AnalyzeImageResultOutput

A resposta da análise de imagens.
AnalyzeText
AnalyzeText200Response

O pedido foi bem-sucedido.
AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

O pedido de análise de texto.
AnalyzeTextOptionsOutput

O pedido de análise de texto.
AnalyzeTextResultOutput

A resposta da análise de texto.
CreateOrUpdateTextBlocklist200Response

O pedido foi bem-sucedido.
CreateOrUpdateTextBlocklist201Response

O pedido foi bem-sucedido e, consequentemente, foi criado um novo recurso.
CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Não existem conteúdos para enviar para este pedido, mas os cabeçalhos podem ser úteis.
DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

O pedido foi bem-sucedido.
GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

O pedido foi bem-sucedido.
GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageCategoriesAnalysisOutput

Resultado da análise de imagens.
ImageData

A imagem pode ser bytes codificados com base64 ou um URL de blob. Pode escolher apenas uma destas opções. Se ambos forem fornecidos, o pedido será recusado. O tamanho máximo da imagem é de 2048 x 2048 pixels e não deve exceder 4 MB, enquanto o tamanho mínimo da imagem é de 50 x 50 pixels.
ImageDataOutput

A imagem pode ser bytes codificados com base64 ou um URL de blob. Pode escolher apenas uma destas opções. Se ambos forem fornecidos, o pedido será recusado. O tamanho máximo da imagem é de 2048 x 2048 pixels e não deve exceder 4 MB, enquanto o tamanho mínimo da imagem é de 50 x 50 pixels.
ListTextBlocklistItems
ListTextBlocklistItems200Response

O pedido foi bem-sucedido.
ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

O pedido foi bem-sucedido.
ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

Opções para o programa auxiliar de paginação
RemoveBlocklistItems
RemoveBlocklistItems204Response

Não existem conteúdos para enviar para este pedido, mas os cabeçalhos podem ser úteis.
RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

O pedido para remover blocklistItems de uma lista de bloqueios de texto.
Routes
TextBlocklist

Lista de Bloqueios de Texto.
TextBlocklistItem

Item num TextBlocklist.
TextBlocklistItemOutput

Item num TextBlocklist.
TextBlocklistMatchOutput

O resultado da correspondência da lista de bloqueios.
TextBlocklistOutput

Lista de Bloqueios de Texto.
TextCategoriesAnalysisOutput

Resultado da análise de texto.

Aliases de Tipo

AddOrUpdateBlocklistItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Tipo de programa auxiliar para extrair o tipo de uma matriz
GetPage

O tipo de uma função personalizada que define como obter uma página e uma ligação para a seguinte, se existir.
GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PagedTextBlocklistItemOutput

Coleção paginada de itens TextBlocklistItem
PagedTextBlocklistOutput

Coleção paginada de itens textBlocklist
PaginateReturn

Tipo auxiliar para inferir o Tipo de elementos paginados do tipo de resposta Este tipo é gerado com base nas informações swagger para x-ms-pageable especificamente na propriedade itemName que indica a propriedade da resposta onde os itens da página são encontrados. O valor predefinido é value. Este tipo permitir-nos-á fornecer iterador fortemente escrito com base na resposta que obtemos como segundo parâmetro
RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

A instância do recurso.

Funções

default(string, TokenCredential | KeyCredential, ClientOptions)

Inicializar uma nova instância de ContentSafetyClient
isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
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>)

Programa auxiliar para paginar resultados de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

Detalhes de Função

default(string, TokenCredential | KeyCredential, ClientOptions)

Inicializar uma nova instância de ContentSafetyClient

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

Parâmetros

endpoint

string

Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://.cognitiveservices.azure.com).

credentials

TokenCredential | KeyCredential

identificar exclusivamente a credencial do cliente

options
ClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

ContentSafetyClient

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse) 

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parâmetros

response

AnalyzeText200Response | AnalyzeTextDefaultResponse

Devoluções

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse) 

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parâmetros

response

AnalyzeImage200Response | AnalyzeImageDefaultResponse

Devoluções

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse) 

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parâmetros

response

GetTextBlocklist200Response | GetTextBlocklistDefaultResponse

Devoluções

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse) 

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

Parâmetros

response

CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse

Devoluções

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse) 

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parâmetros

response

DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse

Devoluções

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse) 

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parâmetros

response

ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse

Devoluções

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse) 

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parâmetros

response

AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse

Devoluções

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse) 

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parâmetros

response

RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse

Devoluções

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse) 

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parâmetros

response

GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse

Devoluções

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse) 

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parâmetros

response

ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse

Devoluções

response

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

Programa auxiliar para paginar resultados de uma resposta inicial que segue a especificação da extensão Autorest x-ms-pageable

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

Parâmetros

client
Client

Cliente a utilizar para enviar os pedidos de página seguinte

initialResponse

TResponse

Resposta inicial que contém a nextLink e a página atual de elementos

options

PagingOptions<TResponse>

Devoluções

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

  • PagedAsyncIterableIterator para iterar os elementos