@azure-rest/ai-content-safety package
Interfaces
| AddOrUpdateBlocklistItems | |
| AddOrUpdateBlocklistItems200Response |
A solicitação foi bem-sucedida. |
| AddOrUpdateBlocklistItemsBodyParam | |
| AddOrUpdateBlocklistItemsDefaultHeaders | |
| AddOrUpdateBlocklistItemsDefaultResponse | |
| AddOrUpdateTextBlocklistItemsOptions |
A solicitação para adicionar blocklistItems a uma lista de bloqueados de texto. |
| AddOrUpdateTextBlocklistItemsResultOutput |
A resposta da adição de blocklistItems à lista de bloqueados de texto. |
| AnalyzeImage | |
| AnalyzeImage200Response |
A solicitação foi bem-sucedida. |
| AnalyzeImageBodyParam | |
| AnalyzeImageDefaultHeaders | |
| AnalyzeImageDefaultResponse | |
| AnalyzeImageOptions |
A solicitação de análise de imagem. |
| AnalyzeImageOptionsOutput |
A solicitação de análise de imagem. |
| AnalyzeImageResultOutput |
A resposta da análise de imagem. |
| AnalyzeText | |
| AnalyzeText200Response |
A solicitação foi bem-sucedida. |
| AnalyzeTextBodyParam | |
| AnalyzeTextDefaultHeaders | |
| AnalyzeTextDefaultResponse | |
| AnalyzeTextOptions |
A solicitação de análise de texto. |
| AnalyzeTextOptionsOutput |
A solicitação de análise de texto. |
| AnalyzeTextResultOutput |
A resposta da análise de 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 | |
| ImageCategoriesAnalysisOutput |
Resultado da análise de imagem. |
| ImageData |
A imagem pode ser bytes codificados em base64 ou uma URL de blob. Você pode escolher apenas uma dessas opções. Se ambos forem fornecidos, a solicitação será recusada. 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 em base64 ou uma URL de blob. Você pode escolher apenas uma dessas opções. Se ambos forem fornecidos, a solicitação será recusada. 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 |
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 |
| RemoveBlocklistItems | |
| RemoveBlocklistItems204Response |
Não há conteúdo a ser enviado para essa solicitação, mas os cabeçalhos podem ser úteis. |
| RemoveBlocklistItemsBodyParam | |
| RemoveBlocklistItemsDefaultHeaders | |
| RemoveBlocklistItemsDefaultResponse | |
| RemoveTextBlocklistItemsOptions |
A solicitação para remover blocklistItems de uma lista de bloqueados de texto. |
| Routes | |
| TextBlocklist |
Lista de bloqueados 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 bloqueados de texto. |
| TextCategoriesAnalysisOutput |
Resultado da análise de texto. |
Aliases de tipo
| AddOrUpdateBlocklistItemsParameters | |
| 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 | |
| PagedTextBlocklistItemOutput |
Coleção paginada de itens TextBlocklistItem |
| PagedTextBlocklistOutput |
Coleção paginada de itens TextBlocklist |
| PaginateReturn |
Tipo auxiliar para inferir o Tipo dos elementos paginado 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 em que os itens de página são encontrados. O valor padrão é |
| RemoveBlocklistItemsParameters | |
| TextBlocklistResourceMergeAndPatch |
A instância de recurso. |
Funções
Detalhes da função
default(string, TokenCredential | KeyCredential, ClientOptions)
Inicializar uma nova instância do ContentSafetyClient
function default(endpoint: string, credentials: TokenCredential | KeyCredential, options?: ClientOptions): ContentSafetyClientParâmetros
- endpoint
-
string
Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://.cognitiveservices.azure.com).
- credentials
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): responseParâmetros
- response
Retornos
response
isUnexpected(AnalyzeImage200Response | AnalyzeImageDefaultResponse)
function isUnexpected(response: AnalyzeImage200Response | AnalyzeImageDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetTextBlocklist200Response | GetTextBlocklistDefaultResponse)
function isUnexpected(response: GetTextBlocklist200Response | GetTextBlocklistDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse)
function isUnexpected(response: CreateOrUpdateTextBlocklist200Response | CreateOrUpdateTextBlocklist201Response | CreateOrUpdateTextBlocklistDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse)
function isUnexpected(response: DeleteTextBlocklist204Response | DeleteTextBlocklistDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse)
function isUnexpected(response: ListTextBlocklists200Response | ListTextBlocklistsDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse)
function isUnexpected(response: AddOrUpdateBlocklistItems200Response | AddOrUpdateBlocklistItemsDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse)
function isUnexpected(response: RemoveBlocklistItems204Response | RemoveBlocklistItemsDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse)
function isUnexpected(response: GetTextBlocklistItem200Response | GetTextBlocklistItemDefaultResponse): responseParâmetros
Retornos
response
isUnexpected(ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse)
function isUnexpected(response: ListTextBlocklistItems200Response | ListTextBlocklistItemsDefaultResponse): responseParâ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 de elementos
- options
-
PagingOptions<TResponse>
Retornos
PagedAsyncIterableIterator<PaginateReturn<TResponse>>
- PagedAsyncIterableIterator para iterar os elementos