Compartilhar via


@azure-rest/ai-content-safety package

Interfaces

AddBlockItems
AddBlockItems200Response

A solicitação foi bem-sucedida.

AddBlockItemsBodyParam
AddBlockItemsDefaultHeaders
AddBlockItemsDefaultResponse
AddBlockItemsOptions

A solicitação de adição de blockItems à lista de bloqueios de texto.

AddBlockItemsResultOutput

A resposta da adição de blockItems à lista de bloqueios de texto.

AnalyzeImage
AnalyzeImage200Response

A solicitação foi bem-sucedida.

AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

A solicitação de análise da imagem.

AnalyzeImageOptionsOutput

A solicitação de análise da imagem.

AnalyzeImageResultOutput

A resposta de análise da imagem.

AnalyzeText
AnalyzeText200Response

A solicitação foi bem-sucedida.

AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

A solicitação de análise do texto.

AnalyzeTextOptionsOutput

A solicitação de análise do texto.

AnalyzeTextResultOutput

A resposta de análise do texto

CreateOrUpdateTextBlocklist200Response

A solicitação foi bem-sucedida.

CreateOrUpdateTextBlocklist201Response

A solicitação foi bem-sucedida e um novo recurso foi criado como resultado.

CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

DeleteTextBlocklistDefaultHeaders
DeleteTextBlocklistDefaultResponse
GetTextBlocklist
GetTextBlocklist200Response

A solicitação foi bem-sucedida.

GetTextBlocklistDefaultHeaders
GetTextBlocklistDefaultResponse
GetTextBlocklistItem
GetTextBlocklistItem200Response

A solicitação foi bem-sucedida.

GetTextBlocklistItemDefaultHeaders
GetTextBlocklistItemDefaultResponse
ImageAnalyzeSeverityResultOutput

Resultado da análise de imagem.

ImageData

O conteúdo ou a URL de blob da imagem podem ser bytes de codificação base64 ou url de blob. Se ambos forem dados, a solicitação será recusada. O tamanho máximo da imagem é de 2048 pixels * 2048 pixels, não maior que 4 MB ao mesmo tempo. O tamanho mínimo da imagem é de 50 pixels * 50 pixels.

ImageDataOutput

O conteúdo ou a URL de blob da imagem podem ser bytes de codificação base64 ou url de blob. Se ambos forem dados, a solicitação será recusada. O tamanho máximo da imagem é de 2048 pixels * 2048 pixels, não maior que 4 MB ao mesmo tempo. O tamanho mínimo da imagem é de 50 pixels * 50 pixels.

ListTextBlocklistItems
ListTextBlocklistItems200Response

A solicitação foi bem-sucedida.

ListTextBlocklistItemsDefaultHeaders
ListTextBlocklistItemsDefaultResponse
ListTextBlocklistItemsQueryParam
ListTextBlocklistItemsQueryParamProperties
ListTextBlocklists
ListTextBlocklists200Response

A solicitação foi bem-sucedida.

ListTextBlocklistsDefaultHeaders
ListTextBlocklistsDefaultResponse
PagingOptions

Opções para o auxiliar de paginação

RemoveBlockItems
RemoveBlockItems204Response

Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis.

RemoveBlockItemsBodyParam
RemoveBlockItemsDefaultHeaders
RemoveBlockItemsDefaultResponse
RemoveBlockItemsOptions

A solicitação de remoção de blockItems da lista de bloqueios de texto.

Routes
TextAnalyzeSeverityResultOutput

Resultado da análise de texto.

TextBlockItemInfo

Bloquear informações de item na lista de bloqueio de texto.

TextBlockItemOutput

Item em TextBlocklist.

TextBlocklist

Lista de bloqueios de texto.

TextBlocklistMatchResultOutput

O resultado da correspondência da lista de bloqueios.

TextBlocklistOutput

Lista de bloqueios de texto.

Aliases de tipo

AddBlockItemsParameters
AnalyzeImageParameters
AnalyzeTextParameters
ContentSafetyClient
CreateOrUpdateTextBlocklistParameters
DeleteTextBlocklistParameters
GetArrayType

Tipo auxiliar para extrair o tipo de uma matriz

GetPage

O tipo de uma função personalizada que define como obter uma página e um link para a próxima, se houver.

GetTextBlocklistItemParameters
GetTextBlocklistParameters
ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

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

RemoveBlockItemsParameters
TextBlockItemListOutput

Coleção paginada de itens TextBlockItem

TextBlocklistListOutput

Coleção paginada de itens TextBlocklist

TextBlocklistResourceMergeAndPatch

A instância de recurso.

Funções

default(string, KeyCredential, ClientOptions)

Inicializar uma nova instância do 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>)

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

Detalhes da função

default(string, KeyCredential, ClientOptions)

Inicializar uma nova instância do ContentSafetyClient

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

Parâmetros

endpoint

string

Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://.cognitiveservices.azure.com).

credentials
KeyCredential

identificar exclusivamente a credencial do cliente

options
ClientOptions

o parâmetro para todos os parâmetros opcionais

Retornos

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parâmetros

Retornos

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(AddBlockItems200Response | AddBlockItemsDefaultResponse)

function isUnexpected(response: AddBlockItems200Response | AddBlockItemsDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse)

function isUnexpected(response: RemoveBlockItems204Response | RemoveBlockItemsDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parâmetros

Retornos

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parâmetros

Retornos

response

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

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 ser usado para enviar as solicitações da próxima página

initialResponse

TResponse

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

options

PagingOptions<TResponse>

Retornos

  • PagedAsyncIterableIterator para iterar os elementos