Text Operations - Detect Text Protected Material

Serviço:

Azure AI Services

Versão da API:

2024-09-01

Detectar material protegido para texto
Uma API síncrona para detectar material protegido no texto especificado.

POST {endpoint}/contentsafety/text:detectProtectedMaterial?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	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigató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

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

Detect Protected Material for Text

Solicitação de exemplo

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 de exemplo

Código de status:

200

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

Definições

Nome	Description
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/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	A solicitação de detecção de material protegido potencial presente no texto especificado.
DetectTextProtectedMaterialResult	Os resultados combinados de detecção de material protegido potencial.
TextProtectedMaterialAnalysisResult	O resultado da detecção individual de material protegido em potencial.

Azure.Core.Foundations.Error

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

Uma resposta que contém detalhes do erro.

Nome	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.

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

DetectTextProtectedMaterialOptions

A solicitação de detecção de material protegido potencial presente no texto especificado.

Nome	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

Os resultados combinados de detecção de material protegido potencial.

Nome	Tipo	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Resultado da análise do texto especificado.

TextProtectedMaterialAnalysisResult

O resultado da detecção individual de material protegido em potencial.

Nome	Tipo	Description
detected	boolean	Se o material protegido potencial é detectado ou não.