Partilhar via


@azure-rest/ai-content-safety package

Interfaces

AddOrUpdateBlocklistItems
AddOrUpdateBlocklistItems200Response

O pedido foi bem-sucedido.

AddOrUpdateBlocklistItemsBodyParam
AddOrUpdateBlocklistItemsDefaultHeaders
AddOrUpdateBlocklistItemsDefaultResponse
AddOrUpdateTextBlocklistItemsOptions

A solicitação para adicionar blocklistItems a uma lista de bloqueio de texto.

AddOrUpdateTextBlocklistItemsResultOutput

A resposta de adicionar blocklistItems à lista de bloqueio de texto.

AnalyzeImage
AnalyzeImage200Response

O pedido foi bem-sucedido.

AnalyzeImageBodyParam
AnalyzeImageDefaultHeaders
AnalyzeImageDefaultResponse
AnalyzeImageOptions

O pedido de análise de imagem.

AnalyzeImageResultOutput

A resposta da análise de imagem.

AnalyzeText
AnalyzeText200Response

O pedido foi bem-sucedido.

AnalyzeTextBodyParam
AnalyzeTextDefaultHeaders
AnalyzeTextDefaultResponse
AnalyzeTextOptions

O pedido de análise de texto.

AnalyzeTextResultOutput

A resposta da análise de texto.

ContentSafetyClientOptions

Os parâmetros opcionais para o cliente

CreateOrUpdateTextBlocklist200Response

O pedido foi bem-sucedido.

CreateOrUpdateTextBlocklist201Response

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

CreateOrUpdateTextBlocklistBodyParam
CreateOrUpdateTextBlocklistDefaultHeaders
CreateOrUpdateTextBlocklistDefaultResponse
CreateOrUpdateTextBlocklistMediaTypesParam
DeleteTextBlocklist204Response

Não há conteúdo para enviar para esta solicitação, 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 imagem.

ImageData

A imagem pode ser de bytes codificados base64 ou um URL de blob. Você pode escolher apenas uma dessas 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
PageSettings

Uma interface que rastreia as configurações para iteração paginada

PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.

PagedTextBlocklistItemOutput

Coleção paginada de itens TextBlocklistItem

PagedTextBlocklistOutput

Coleção paginada de itens TextBlocklist

PagingOptions

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

RemoveBlocklistItems
RemoveBlocklistItems204Response

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

RemoveBlocklistItemsBodyParam
RemoveBlocklistItemsDefaultHeaders
RemoveBlocklistItemsDefaultResponse
RemoveTextBlocklistItemsOptions

A solicitação para remover blocklistItems de uma lista de bloqueio de texto.

Routes
TextBlocklist

Lista de bloqueio de texto.

TextBlocklistItem

Item em um TextBlocklist.

TextBlocklistItemOutput

Item em um TextBlocklist.

TextBlocklistMatchOutput

O resultado da correspondência da lista de bloqueios.

TextBlocklistOutput

Lista de bloqueio de texto.

TextCategoriesAnalysisOutput

Resultado da análise de texto.

Aliases de Tipo

AddOrUpdateBlocklistItemsParameters
AnalyzeImageOutputType

Alias para AnalyzeImageOutputType

AnalyzeImageParameters
AnalyzeTextOutputType

Alias para AnalyzeTextOutputType

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
ImageCategory

Alias para ImageCategory

ImageCategoryOutput

Alias para ImageCategoryOutput

ListTextBlocklistItemsParameters
ListTextBlocklistsParameters
PaginateReturn

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

RemoveBlocklistItemsParameters
TextBlocklistResourceMergeAndPatch

A instância do recurso.

TextCategory

Alias para TextCategory

TextCategoryOutput

Alias para TextCategoryOutput

Funções

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

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

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

Detalhes de Função

default(string, TokenCredential | KeyCredential, ContentSafetyClientOptions)

Inicializar uma nova instância do ContentSafetyClient

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

Parâmetros

endpointParam

string

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

credentials

TokenCredential | KeyCredential

identificar exclusivamente a credencial do cliente

options
ContentSafetyClientOptions

o parâmetro para todos os parâmetros opcionais

Devoluções

isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)

function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(AnalyzeText200Response | AnalyzeTextDefaultResponse)

function isUnexpected(response: AnalyzeText200Response | AnalyzeTextDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)

function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)

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

Parâmetros

Devoluções

response

isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)

function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)

function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)

function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)

function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)

function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): response

Parâmetros

Devoluções

response

isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)

function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): response

Parâmetros

Devoluções

response

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

O auxiliar para paginar resulta 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 da página seguinte

initialResponse

TResponse

Resposta inicial contendo o nextLink e a página atual de elementos

options

PagingOptions<TResponse>

Devoluções

  • PagedAsyncIterableIterator para iterar os elementos