Text Operations - Detect Text Protected Material

Serviço:

Azure AI Services

Versão da API:

2024-09-01

Detetar material protegido para texto
Uma API síncrona para detetar material protegido no texto fornecido.

POST {endpoint}/contentsafety/text:detectProtectedMaterial?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, que pode conter material protegido. Os caracteres serão contados em pontos de código Unicode.

Respostas

Name	Tipo	Description
200 OK	DetectTextProtectedMaterialResult	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

Detect Protected Material for Text

Pedido de amostra

HTTP

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

{
  "text": "to everyone, the best things in life are free. the stars belong to everyone, they gleam there for you and me. the flowers in spring, the robins that sing, the sunbeams that shine"
}

Resposta da amostra

Código de estado:

200

{
  "protectedMaterialAnalysis": {
    "detected": true
  }
}

Definições

Name	Description
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.
DetectTextProtectedMaterialOptions	O pedido de deteção de potencial material protegido presente no texto dado.
DetectTextProtectedMaterialResult	A deteção combinada resulta de material potencialmente protegido.
TextProtectedMaterialAnalysisResult	O resultado da deteção individual de material potencialmente protegido.

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.

DetectTextProtectedMaterialOptions

O pedido de deteção de potencial material protegido presente no texto dado.

Name	Tipo	Description
text	string	O texto a ser analisado, que pode conter material protegido. Os caracteres serão contados em pontos de código Unicode.

DetectTextProtectedMaterialResult

A deteção combinada resulta de material potencialmente protegido.

Name	Tipo	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Resultado da análise para o texto dado.

TextProtectedMaterialAnalysisResult

O resultado da deteção individual de material potencialmente protegido.

Name	Tipo	Description
detected	boolean	Se o potencial material protegido é detetado ou não.