Text Operations - Analyze Text

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-09-01

Analisar Texto
Uma API síncrona para a análise de conteúdo de texto potencialmente prejudicial. Atualmente, ele dá suporte a quatro categorias: Ódio, SelfHarm, Sexual e Violência.

POST {endpoint}/contentsafety/text:analyze?api-version=2024-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (protocolo e nome do host, por exemplo: https://.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
text	True	string maxLength: 10000	O texto a ser analisado. Há suporte para um máximo de 10 mil caracteres Unicode (pontos de código Unicode) no texto de uma solicitação.
blocklistNames		string[]	Os nomes das listas de bloqueios.
categories		TextCategory[]	As categorias serão analisadas. Se eles não forem atribuídos, um conjunto padrão de resultados de análise para as categorias será retornado.
haltOnBlocklistHit		boolean	Quando definido como true, análises adicionais de conteúdo prejudicial não serão executadas nos casos em que as listas de bloqueios forem atingidas. Quando definido como false, todas as análises de conteúdo prejudicial serão executadas, independentemente de as listas de bloqueio serem ou não atingidas.
outputType		AnalyzeTextOutputType	Isso se refere ao tipo de saída de análise de texto. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

Respostas

Nome	Tipo	Description
200 OK	AnalyzeTextResult	A solicitação foi bem-sucedida.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

AnalyzeTextResult

A solicitação foi bem-sucedida.

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: application
URL do Token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

Analyze Text

Solicitação de exemplo

HTTP

POST {endpoint}/contentsafety/text:analyze?api-version=2024-09-01

{
  "text": "This is text example"
}

Resposta de exemplo

Código de status:: 200

{
  "blocklistsMatch": [],
  "categoriesAnalysis": [
    {
      "category": "Hate",
      "severity": 0
    },
    {
      "category": "SelfHarm",
      "severity": 0
    },
    {
      "category": "Sexual",
      "severity": 0
    },
    {
      "category": "Violence",
      "severity": 0
    }
  ]
}

Definições

Nome	Description
AnalyzeTextOptions	A solicitação de análise de texto.
AnalyzeTextOutputType	Isso se refere ao tipo de saída de análise de texto. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".
AnalyzeTextResult	A resposta da análise de texto.
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
TextBlocklistMatch	O resultado da correspondência da lista de bloqueios.
TextCategoriesAnalysis	Resultado da análise de texto.
TextCategory	A categoria de danos com suporte na análise de conteúdo de texto.

AnalyzeTextOptions

Objeto

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

Nome	Tipo	Valor padrão	Description
blocklistNames	string[]		Os nomes das listas de bloqueios.
categories	TextCategory[]		As categorias serão analisadas. Se eles não forem atribuídos, um conjunto padrão de resultados de análise para as categorias será retornado.
haltOnBlocklistHit	boolean		Quando definido como true, análises adicionais de conteúdo prejudicial não serão executadas nos casos em que as listas de bloqueios forem atingidas. Quando definido como false, todas as análises de conteúdo prejudicial serão executadas, independentemente de as listas de bloqueio serem ou não atingidas.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Isso se refere ao tipo de saída de análise de texto. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".
text	string maxLength: 10000		O texto a ser analisado. Há suporte para um máximo de 10 mil caracteres Unicode (pontos de código Unicode) no texto de uma solicitação.

AnalyzeTextOutputType

Enumeração

Isso se refere ao tipo de saída de análise de texto. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

Valor	Description
EightSeverityLevels	As severidades de saída em oito níveis, o valor pode ser 0,1,2,3,4,5,6,7.
FourSeverityLevels	As severidades de saída em quatro níveis, o valor pode ser 0,2,4,6.

AnalyzeTextResult

Objeto

A resposta da análise de texto.

Nome	Tipo	Description
blocklistsMatch	TextBlocklistMatch[]	Os detalhes da correspondência da lista de bloqueios.
categoriesAnalysis	TextCategoriesAnalysis[]	Resultado da análise para categorias.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

TextBlocklistMatch

Objeto

O resultado da correspondência da lista de bloqueios.

Nome	Tipo	Description
blocklistItemId	string maxLength: 64	A ID do item correspondente.
blocklistItemText	string maxLength: 128	O conteúdo do item correspondente.
blocklistName	string maxLength: 64	O nome da lista de bloqueios correspondente.

TextCategoriesAnalysis

Objeto

Resultado da análise de texto.

Nome	Tipo	Description
category	TextCategory	A categoria de análise de texto.
severity	integer (int32)	O valor aumenta com a gravidade do conteúdo de entrada. O valor desse campo é determinado pelo tipo de saída especificado na solicitação. O tipo de saída pode ser 'FourSeverityLevels' ou 'EightSeverity Levels', e o valor de saída pode ser 0, 2, 4, 6 ou 0, 1, 2, 3, 4, 5, 6 ou 7.

TextCategory

Enumeração

A categoria de danos com suporte na análise de conteúdo de texto.

Valor	Description
Hate	A categoria de dano para Texto – Ódio.
SelfHarm	A categoria de dano para Texto – SelfHarm.
Sexual	A categoria de dano para Texto – Sexual.
Violence	A categoria de dano para Texto – Violência.

Compartilhar via

Text Operations - Analyze Text

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

Analyze Text

Solicitação de exemplo

Resposta de exemplo

Definições

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory