Text Operations - Detect Text Protected Material

Servicio:

Azure AI Services

Versión de la API:

2024-09-01

Detectar material protegido para texto
API sincrónica para detectar material protegido en el texto especificado.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string	Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://.cognitiveservices.azure.com).
api-version	query	True	string	Versión de la API que se va a usar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
text	True	string	Texto que se va a analizar, que puede contener material protegido. Los caracteres se contarán en puntos de código Unicode.

Respuestas

Nombre	Tipo	Description
200 OK	DetectTextProtectedMaterialResult	La solicitud se ha realizado correctamente.
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: application
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/v2.0/token

Ámbitos

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

Ejemplos

Detect Protected Material for Text

Solicitud de ejemplo

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"
}

Respuesta de muestra

status code:

200

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

Definiciones

Nombre	Description
Azure.Core.Foundations.Error	Objeto de error.
Azure.Core.Foundations.ErrorResponse	Respuesta que contiene los detalles del error.
Azure.Core.Foundations.InnerError	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
DetectTextProtectedMaterialOptions	Solicitud de detección de posibles materiales protegidos presentes en el texto especificado.
DetectTextProtectedMaterialResult	Resultados combinados de detección de posibles materiales protegidos.
TextProtectedMaterialAnalysisResult	Resultado de la detección individual del material protegido potencial.

Azure.Core.Foundations.Error

Objeto de error.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
details	Azure.Core.Foundations.Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	Azure.Core.Foundations.InnerError	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

Azure.Core.Foundations.ErrorResponse

Respuesta que contiene los detalles del error.

Nombre	Tipo	Description
error	Azure.Core.Foundations.Error	Objeto de error.

Azure.Core.Foundations.InnerError

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	string	Uno de un conjunto definido por el servidor de códigos de error.
innererror	Azure.Core.Foundations.InnerError	Error interno.

DetectTextProtectedMaterialOptions

Solicitud de detección de posibles materiales protegidos presentes en el texto especificado.

Nombre	Tipo	Description
text	string	Texto que se va a analizar, que puede contener material protegido. Los caracteres se contarán en puntos de código Unicode.

DetectTextProtectedMaterialResult

Resultados combinados de detección de posibles materiales protegidos.

Nombre	Tipo	Description
protectedMaterialAnalysis	TextProtectedMaterialAnalysisResult	Resultado del análisis del texto especificado.

TextProtectedMaterialAnalysisResult

Resultado de la detección individual del material protegido potencial.

Nombre	Tipo	Description
detected	boolean	Indica si se detecta o no material protegido potencial.