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, suporta quatro categorias: Ódio, Automutilação, Sexual e Violência.

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

Parâmetros do URI

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

Corpo do Pedido

Name	Necessário	Tipo	Description
text	True	string	O texto a ser analisado. Suportamos um máximo de 10k caracteres Unicode (pontos de código Unicode) no texto de uma solicitação.
blocklistNames		string[]	Os nomes das listas de bloqueio.
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 verdadeiro, não serão realizadas análises adicionais de conteúdo nocivo nos casos em que as listas de bloqueio são atingidas. Quando definido como false, todas as análises de conteúdo nocivo serão realizadas, independentemente de as listas de bloqueio serem ou não atingidas.
outputType		AnalyzeTextOutputType	Isto refere-se ao tipo de saída de análise de texto. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".

Respostas

Name	Tipo	Description
200 OK	AnalyzeTextResult	O pedido foi bem-sucedido.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

AnalyzeTextResult

O pedido foi bem-sucedido.

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
Fluxo: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

Âmbitos

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

Exemplos

Analyze Text

Pedido de amostra

HTTP

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

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
AnalyzeTextOptions	O pedido de análise de texto.
AnalyzeTextOutputType	Isto refere-se 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 contendo 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/Guidelines.md#7102-error-condition-responses.
TextBlocklistMatch	O resultado da correspondência da lista de bloqueios.
TextCategoriesAnalysis	Resultado da análise de texto.
TextCategory	A categoria de dano suportada na análise de conteúdo de texto.

AnalyzeTextOptions

O pedido de análise de texto.

Name	Tipo	Default value	Description
blocklistNames	string[]		Os nomes das listas de bloqueio.
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 verdadeiro, não serão realizadas análises adicionais de conteúdo nocivo nos casos em que as listas de bloqueio são atingidas. Quando definido como false, todas as análises de conteúdo nocivo serão realizadas, independentemente de as listas de bloqueio serem ou não atingidas.
outputType	AnalyzeTextOutputType	FourSeverityLevels	Isto refere-se ao tipo de saída de análise de texto. Se nenhum valor for atribuído, o valor padrão será "FourSeverityLevels".
text	string		O texto a ser analisado. Suportamos um máximo de 10k caracteres Unicode (pontos de código Unicode) no texto de uma solicitação.

AnalyzeTextOutputType

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

Name	Tipo	Description
EightSeverityLevels	string	Severidades de produção em oito níveis, o valor poderia ser 0,1,2,3,4,5,6,7.
FourSeverityLevels	string	Severidades de produção em quatro níveis, o valor poderia ser 0,2,4,6.

AnalyzeTextResult

A resposta da análise de texto.

Name	Tipo	Description
blocklistsMatch	TextBlocklistMatch[]	Os detalhes da lista de bloqueio correspondem.
categoriesAnalysis	TextCategoriesAnalysis[]	Resultado da análise por categorias.

Azure.Core.Foundations.Error

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
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 por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de 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/Guidelines.md#7102-error-condition-responses.

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

TextBlocklistMatch

O resultado da correspondência da lista de bloqueios.

Name	Tipo	Description
blocklistItemId	string	A ID do item correspondente.
blocklistItemText	string	O conteúdo do item correspondente.
blocklistName	string	O nome da lista de bloqueio correspondente.

TextCategoriesAnalysis

Resultado da análise de texto.

Name	Tipo	Description
category	TextCategory	A categoria de análise de texto.
severity	integer	O valor aumenta com a severidade do conteúdo de entrada. O valor deste 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

A categoria de dano suportada na análise de conteúdo de texto.

Name	Tipo	Description
Hate	string	A categoria de dano para Texto - Ódio.
SelfHarm	string	A categoria de dano para Texto - Automutilação.
Sexual	string	A categoria de dano para Texto - Sexual.
Violence	string	A categoria dano para Texto - Violência.

Partilhar via

Text Operations - Analyze Text

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Analyze Text

Pedido de amostra

Resposta da amostra

Definições

AnalyzeTextOptions

AnalyzeTextOutputType

AnalyzeTextResult

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

TextBlocklistMatch

TextCategoriesAnalysis

TextCategory

Recursos adicionais