Text Analysis Runtime - Analyze Text

Service:

Cognitive Services - Language

API Version:

2023-04-01

Solicitar análisis de texto sobre una colección de documentos.

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01

With optional parameters:

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01&showStats={showStats}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versión de API que se usará para la operación.
showStats	query		boolean	(Opcional) si se establece en true, la respuesta contendrá estadísticas de nivel de documento y solicitud.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

El cuerpo de la solicitud puede ser uno de los siguientes:

Nombre	Description
AnalyzeTextEntityLinkingInput	Contiene la entrada de vinculación de entidad de análisis de texto.
AnalyzeTextEntityRecognitionInput	El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.
AnalyzeTextKeyPhraseExtractionInput	Contiene la entrada de tarea Analizar texto KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contiene la entrada de la tarea de análisis de documentos de detección de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.
AnalyzeTextSentimentAnalysisInput	Contiene la entrada de tarea Analizar texto SentimentAnalysis.

AnalyzeTextEntityLinkingInput

Contiene la entrada de vinculación de entidad de análisis de texto.

Nombre	Requerido	Tipo	Description
kind	True	string: EntityLinking	Tipo de tarea que se va a realizar.
analysisInput		MultiLanguageAnalysisInput	Contiene la entrada de análisis que va a controlar el servicio.
parameters		EntityLinkingTaskParameters	Parámetros de tarea.

AnalyzeTextEntityRecognitionInput

El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.

Nombre	Requerido	Tipo	Description
kind	True	string: EntityRecognition	Tipo de tarea que se va a realizar.
analysisInput		MultiLanguageAnalysisInput	Entrada que se va a analizar.
parameters		EntitiesTaskParameters	Parámetros de tarea.

AnalyzeTextKeyPhraseExtractionInput

Contiene la entrada de tarea Analizar texto KeyPhraseExtraction.

Nombre	Requerido	Tipo	Description
kind	True	string: KeyPhraseExtraction	Tipo de tarea que se va a realizar.
analysisInput		MultiLanguageAnalysisInput	Contiene los documentos de entrada.
parameters		KeyPhraseTaskParameters	Parámetros de tarea de extracción de frases clave.

AnalyzeTextLanguageDetectionInput

Contiene la entrada de la tarea de análisis de documentos de detección de idioma.

Nombre	Requerido	Tipo	Description
kind	True	string: LanguageDetection	Tipo de tarea que se va a realizar.
analysisInput		LanguageDetectionAnalysisInput	Documentos que se van a analizar.
parameters		LanguageDetectionTaskParameters	parámetros de tarea.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.

Nombre	Requerido	Tipo	Description
kind	True	string: PiiEntityRecognition	Tipo de tarea que se va a realizar.
analysisInput		MultiLanguageAnalysisInput	Contiene los documentos de entrada.
parameters		PiiTaskParameters	Parámetros de la tarea Pii.

AnalyzeTextSentimentAnalysisInput

Contiene la entrada de tarea Analizar texto SentimentAnalysis.

Nombre	Requerido	Tipo	Description
kind	True	string: SentimentAnalysis	Tipo de tarea que se va a realizar.
analysisInput		MultiLanguageAnalysisInput	Contiene los documentos de entrada.
parameters		SentimentAnalysisTaskParameters	Parámetros de la tarea Análisis de sentimiento.

Respuestas

Nombre	Tipo	Description
200 OK	AnalyzeTextTaskResult: EntitiesTaskResult EntityLinkingTaskResult KeyPhraseTaskResult LanguageDetectionTaskResult PiiTaskResult SentimentTaskResult	La solicitud se ha realizado correctamente.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada. Headers x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Ejemplos

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "EntityLinking",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "EntityLinkingResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Bill Gates",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.52,
                "length": 10,
                "offset": 25,
                "text": "Bill Gates"
              }
            ],
            "name": "Bill Gates",
            "url": "https://en.wikipedia.org/wiki/Bill_Gates"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Paul Allen",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.54,
                "length": 10,
                "offset": 40,
                "text": "Paul Allen"
              }
            ],
            "name": "Paul Allen",
            "url": "https://en.wikipedia.org/wiki/Paul_Allen"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Microsoft",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.49,
                "length": 9,
                "offset": 0,
                "text": "Microsoft"
              }
            ],
            "name": "Microsoft",
            "url": "https://en.wikipedia.org/wiki/Microsoft"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "dataSource": "Wikipedia",
            "id": "Pike Place Market",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.86,
                "length": 17,
                "offset": 0,
                "text": "Pike place market"
              }
            ],
            "name": "Pike Place Market",
            "url": "https://en.wikipedia.org/wiki/Pike_Place_Market"
          },
          {
            "dataSource": "Wikipedia",
            "id": "Seattle",
            "language": "en",
            "matches": [
              {
                "confidenceScore": 0.27,
                "length": 7,
                "offset": 33,
                "text": "Seattle"
              }
            ],
            "name": "Seattle",
            "url": "https://en.wikipedia.org/wiki/Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-02-01"
  }
}

SuccessfulEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Pike place market is my favorite Seattle attraction."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "category": "Organization",
            "confidenceScore": 0.84,
            "length": 9,
            "offset": 0,
            "text": "Microsoft"
          },
          {
            "category": "Person",
            "confidenceScore": 0.85,
            "length": 10,
            "offset": 25,
            "text": "Bill Gates"
          },
          {
            "category": "Person",
            "confidenceScore": 0.9,
            "length": 10,
            "offset": 40,
            "text": "Paul Allen"
          }
        ],
        "id": "1",
        "warnings": []
      },
      {
        "entities": [
          {
            "category": "Location",
            "confidenceScore": 0.55,
            "length": 7,
            "offset": 33,
            "subcategory": "GPE",
            "text": "Seattle"
          }
        ],
        "id": "2",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2020-04-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "KeyPhraseExtraction",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Microsoft was founded by Bill Gates and Paul Allen."
      },
      {
        "id": "2",
        "language": "en",
        "text": "Text Analytics is one of the Azure Cognitive Services."
      },
      {
        "id": "3",
        "language": "en",
        "text": "My cat might need to see a veterinarian."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "KeyPhraseExtractionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "keyPhrases": [
          "Bill Gates",
          "Paul Allen",
          "Microsoft"
        ],
        "warnings": []
      },
      {
        "id": "2",
        "keyPhrases": [
          "Azure Cognitive Services",
          "Text Analytics"
        ],
        "warnings": []
      },
      {
        "id": "3",
        "keyPhrases": [
          "cat",
          "veterinarian"
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulLanguageDetectionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "LanguageDetection",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "text": "Hello world"
      },
      {
        "id": "2",
        "text": "Bonjour tout le monde"
      },
      {
        "id": "3",
        "text": "Hola mundo"
      },
      {
        "id": "4",
        "text": "Tumhara naam kya hai?"
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "LanguageDetectionResults",
  "results": {
    "documents": [
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "en",
          "name": "English"
        },
        "id": "1",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "fr",
          "name": "French"
        },
        "id": "2",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "es",
          "name": "Spanish"
        },
        "id": "3",
        "warnings": []
      },
      {
        "detectedLanguage": {
          "confidenceScore": 1,
          "iso6391Name": "hi",
          "name": "Hindi"
        },
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-05"
  }
}

SuccessfulPiiEntityRecognitionRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "PiiEntityRecognition",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "My SSN is 859-98-0987"
      },
      {
        "id": "2",
        "language": "en",
        "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check."
      },
      {
        "id": "3",
        "language": "en",
        "text": "Is 998.214.865-68 your Brazilian CPF number?"
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "PiiEntityRecognitionResults",
  "results": {
    "documents": [
      {
        "id": "1",
        "redactedText": "My SSN is ***********",
        "entities": [
          {
            "category": "USSocialSecurityNumber",
            "confidenceScore": 0.65,
            "length": 11,
            "offset": 28,
            "text": "859-98-0987"
          }
        ],
        "warnings": []
      },
      {
        "id": "2",
        "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.",
        "entities": [
          {
            "category": "ABARoutingNumber",
            "confidenceScore": 0.75,
            "length": 9,
            "offset": 18,
            "text": "111000025"
          }
        ],
        "warnings": []
      },
      {
        "id": "3",
        "redactedText": "Is ************** your Brazilian CPF number?",
        "entities": [
          {
            "category": "BRCPFNumber",
            "confidenceScore": 0.85,
            "length": 14,
            "offset": 3,
            "text": "998.214.865-68"
          }
        ],
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-01-15"
  }
}

SuccessfulSentimentAnalysisRequest

Sample Request

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2023-04-01


{
  "kind": "SentimentAnalysis",
  "parameters": {
    "modelVersion": "latest"
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful."
      }
    ]
  }
}

Sample Response

Status code:

200

{
  "kind": "SentimentAnalysisResults",
  "results": {
    "documents": [
      {
        "confidenceScores": {
          "negative": 0,
          "neutral": 0,
          "positive": 1
        },
        "id": "1",
        "sentences": [
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "length": 10,
                "offset": 6,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/0/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "atmosphere"
              }
            ],
            "confidenceScores": {
              "negative": 0,
              "neutral": 0,
              "positive": 1
            },
            "length": 17,
            "offset": 0,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0,
                  "positive": 1
                },
                "isNegated": false,
                "length": 5,
                "offset": 0,
                "sentiment": "positive",
                "text": "great"
              }
            ],
            "sentiment": "positive",
            "text": "Great atmosphere."
          },
          {
            "targets": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 11,
                "offset": 37,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "restaurants"
              },
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "length": 6,
                "offset": 50,
                "relations": [
                  {
                    "ref": "#/documents/0/sentences/1/assessments/0",
                    "relationType": "assessment"
                  }
                ],
                "sentiment": "positive",
                "text": "hotels"
              }
            ],
            "confidenceScores": {
              "negative": 0.01,
              "neutral": 0.86,
              "positive": 0.13
            },
            "length": 52,
            "offset": 18,
            "assessments": [
              {
                "confidenceScores": {
                  "negative": 0.01,
                  "positive": 0.99
                },
                "isNegated": false,
                "length": 15,
                "offset": 18,
                "sentiment": "positive",
                "text": "Close to plenty"
              }
            ],
            "sentiment": "neutral",
            "text": "Close to plenty of restaurants, hotels, and transit!"
          }
        ],
        "sentiment": "positive",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-10-01"
  }
}

Definiciones

Nombre	Description
AnalyzeTextEntityLinkingInput	Contiene la entrada de vinculación de entidad de análisis de texto.
AnalyzeTextEntityRecognitionInput	El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.
AnalyzeTextKeyPhraseExtractionInput	Contiene la entrada de tarea Analizar texto KeyPhraseExtraction.
AnalyzeTextLanguageDetectionInput	Contiene la entrada de la tarea de análisis de documentos de detección de idioma.
AnalyzeTextPiiEntitiesRecognitionInput	Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.
AnalyzeTextSentimentAnalysisInput	Contiene la entrada de tarea Analizar texto SentimentAnalysis.
AnalyzeTextTaskKind	Tipo de las tareas de análisis de texto admitidas.
AnalyzeTextTaskResultsKind	Tipo del objeto de respuesta devuelto por la tarea analyze-text.
DetectedLanguage	Contiene los detalles del idioma detectado para el texto.
DocumentError	Contiene detalles de los errores detectados durante la ejecución de un trabajo.
DocumentSentimentValue	Opinión prevista para el documento (Negativo, Neutro, Positivo o Mixto).
DocumentStatistics	si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.
DocumentWarning	Contiene el objeto warnings con advertencias encontradas para el documento procesado.
EntitiesDocumentResult	Contiene el resultado de la tarea de reconocimiento de entidades para el documento.
EntitiesResult	Contiene el resultado de la tarea de reconocimiento de entidades.
EntitiesTaskParameters	Parámetros admitidos para una tarea de reconocimiento de entidades.
EntitiesTaskResult	Contiene la tarea de entidad
Entity	Define el objeto de entidad detectado que contiene la categoría de entidad y el texto de entidad detectados, etc.
EntityLinkingResult	Resultado de vinculación de entidades.
EntityLinkingTaskParameters	Parámetros admitidos para una tarea De vinculación de entidades.
EntityLinkingTaskResult	Contiene el resultado de la tarea analizar la vinculación de entidades.
Error	Objeto de respuesta de error devuelto cuando el servicio encuentra algunos errores durante el procesamiento de la solicitud.
ErrorCode	Código de error legible.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible.
InnerErrorModel	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.
KeyPhraseResult	Contiene keyPhraseResult.
KeyPhrasesDocumentResult	Contiene los resultados de extracción de frases clave de un documento.
KeyPhraseTaskParameters	Parámetros admitidos para una tarea extracción de frases clave.
KeyPhraseTaskResult	Contiene el resultado de la tarea Analizar texto KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contiene la entrada de análisis de documentos de detección de idioma.
LanguageDetectionDocumentResult	Contiene la detección de idioma de un documento.
LanguageDetectionResult	Contiene el resultado de detección de idioma para la solicitud.
LanguageDetectionTaskParameters	Parámetros admitidos para una tarea detección de idioma.
LanguageDetectionTaskResult	Contiene el resultado de la tarea de detección de idioma para la solicitud.
LanguageInput	Contiene la entrada de detección de idioma.
LinkedEntitiesDocumentResult	Resultado del documento de vinculación de entidades.
LinkedEntity	Objeto LinkedEntity que contiene la entidad detectada con los orígenes o vínculos asociados.
Match	Objeto Match que contiene el texto de la entidad detectada con el desplazamiento y la longitud.
MultiLanguageAnalysisInput	Colección de documentos de entrada que va a analizar el servicio.
MultiLanguageInput	Contiene un documento de entrada que el servicio va a analizar.
PiiCategory	(Opcional) describe las categorías de PII que se van a devolver.
PiiDomain	Dominio para la tarea PII
PiiEntitiesDocumentResult	Contiene los resultados de PII.
PiiResult	Contiene piiResult.
PiiTaskParameters	Parámetros admitidos para una tarea de reconocimiento de entidades de PII.
PiiTaskResult	Contiene la tarea LRO de análisis de texto PIIEntityRecognition.
RequestStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.
SentenceAssessment	Representa una evaluación de oraciones y las evaluaciones o objetos de destino relacionados con ella.
SentenceSentiment	Opinión de frase de un documento.
SentenceSentimentValue	Opinión prevista para la frase.
SentenceTarget	Representa un destino de oración y las evaluaciones o los objetos de destino relacionados con él.
SentimentAnalysisTaskParameters	Parámetros admitidos para una tarea Análisis de sentimiento.
SentimentConfidenceScores	Representa las puntuaciones de confianza entre 0 y 1 en todas las clases de sentimiento: positivas, neutrales y negativas.
SentimentDocumentResult	Objeto que representa los resultados del análisis de sentimiento pregenerado de cada documento.
SentimentResponse	Resultados del análisis de sentimiento para los documentos de entrada.
SentimentTaskResult	Contiene el texto de análisis SentimentAnalysis LRO resultado de la tarea.
StringIndexType	Tipo de índice de cadena
TargetConfidenceScoreLabel	Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.
TargetRelation	Representa la relación entre evaluaciones o destinos.
TargetRelationType	Tipo relacionado con el destino.
TokenSentimentValue	Opinión prevista para la frase.
WarningCodeValue	Define la lista de códigos de advertencia.

AnalyzeTextEntityLinkingInput

Contiene la entrada de vinculación de entidad de análisis de texto.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contiene la entrada de análisis que va a controlar el servicio.
kind	string: EntityLinking	Tipo de tarea que se va a realizar.
parameters	EntityLinkingTaskParameters	Parámetros de tarea.

AnalyzeTextEntityRecognitionInput

El reconocimiento de entidades analiza la solicitud de tarea de entrada de texto.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Entrada que se va a analizar.
kind	string: EntityRecognition	Tipo de tarea que se va a realizar.
parameters	EntitiesTaskParameters	Parámetros de tarea.

AnalyzeTextKeyPhraseExtractionInput

Contiene la entrada de tarea Analizar texto KeyPhraseExtraction.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contiene los documentos de entrada.
kind	string: KeyPhraseExtraction	Tipo de tarea que se va a realizar.
parameters	KeyPhraseTaskParameters	Parámetros de tarea de extracción de frases clave.

AnalyzeTextLanguageDetectionInput

Contiene la entrada de la tarea de análisis de documentos de detección de idioma.

Nombre	Tipo	Description
analysisInput	LanguageDetectionAnalysisInput	Documentos que se van a analizar.
kind	string: LanguageDetection	Tipo de tarea que se va a realizar.
parameters	LanguageDetectionTaskParameters	parámetros de tarea.

AnalyzeTextPiiEntitiesRecognitionInput

Contiene la entrada de tarea de análisis PIIEntityRecognition de texto.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contiene los documentos de entrada.
kind	string: PiiEntityRecognition	Tipo de tarea que se va a realizar.
parameters	PiiTaskParameters	Parámetros de la tarea Pii.

AnalyzeTextSentimentAnalysisInput

Contiene la entrada de tarea Analizar texto SentimentAnalysis.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contiene los documentos de entrada.
kind	string: SentimentAnalysis	Tipo de tarea que se va a realizar.
parameters	SentimentAnalysisTaskParameters	Parámetros de la tarea Análisis de sentimiento.

AnalyzeTextTaskKind

Tipo de las tareas de análisis de texto admitidas.

Nombre	Tipo	Description
EntityLinking	string	Tarea de vinculación de entidades
EntityRecognition	string	Tarea de reconocimiento de entidades
KeyPhraseExtraction	string	Tarea de extracción de frases clave
LanguageDetection	string	Tarea de detección de idioma
PiiEntityRecognition	string	Tarea de reconocimiento de entidades de PII
SentimentAnalysis	string	Tarea de análisis de sentimiento

AnalyzeTextTaskResultsKind

Tipo del objeto de respuesta devuelto por la tarea analyze-text.

Nombre	Tipo	Description
EntityLinkingResults	string	Resultados de vinculación de entidades
EntityRecognitionResults	string	Resultados del reconocimiento de entidades
KeyPhraseExtractionResults	string	Resultados de extracción de frases clave
LanguageDetectionResults	string	Resultados de detección de idioma
PiiEntityRecognitionResults	string	Resultados del reconocimiento de entidades PII
SentimentAnalysisResults	string	Resultados del análisis de sentimiento

DetectedLanguage

Contiene los detalles del idioma detectado para el texto.

Nombre	Tipo	Description
confidenceScore	number	Puntuación de confianza entre 0 y 1. Las puntuaciones cercanas a 1 indican una certeza del 100 % de que el idioma identificado es verdadero.
iso6391Name	string	Representación en dos letras del idioma detectado según el estándar ISO 639-1 (por ejemplo, en, fr).
name	string	Nombre largo de un idioma detectado (por ejemplo, inglés, francés).

DocumentError

Contiene detalles de los errores detectados durante la ejecución de un trabajo.

Nombre	Tipo	Description
error	Error	Error encontrado.
id	string	Identificador del documento de entrada.

DocumentSentimentValue

Opinión prevista para el documento (Negativo, Neutro, Positivo o Mixto).

Nombre	Tipo	Description
mixed	string	Instrucción mixta
negative	string	Instrucción Negativa
neutral	string	Instrucción neutral
positive	string	Instrucción positiva

DocumentStatistics

si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.

Nombre	Tipo	Description
charactersCount	integer	Número de elementos de texto reconocidos en el documento.
transactionsCount	integer	Número de transacciones para el documento.

DocumentWarning

Contiene el objeto warnings con advertencias encontradas para el documento procesado.

Nombre	Tipo	Description
code	WarningCodeValue	Código de advertencia.
message	string	Mensaje de advertencia.
targetRef	string	Referencia de puntero JSON que indica el objeto de destino.

EntitiesDocumentResult

Contiene el resultado de la tarea de reconocimiento de entidades para el documento.

Nombre	Tipo	Description
entities	Entity[]	Entidades reconocidas en el documento.
id	string	Identificador de documento único y no vacío.
statistics	DocumentStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

EntitiesResult

Contiene el resultado de la tarea de reconocimiento de entidades.

Nombre	Tipo	Description
documents	EntitiesDocumentResult[]	Respuesta por documento
errors	DocumentError[]	Errores por identificador de documento.
modelVersion	string	Este campo indica qué modelo se usa para la puntuación.
statistics	RequestStatistics	si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga de la solicitud.

EntitiesTaskParameters

Parámetros admitidos para una tarea de reconocimiento de entidades.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	No participar en el registro
modelVersion	string	latest	versión del modelo
stringIndexType	StringIndexType	TextElements_v8	(Opcional) parámetro para proporcionar el tipo de índice de cadena usado para interpretar los desplazamientos de cadena. El valor predeterminado es TextElements (Graphemes).

EntitiesTaskResult

Contiene la tarea de entidad

Nombre	Tipo	Description
kind	string: EntityRecognitionResults	El tipo de resultado de la tarea.
results	EntitiesResult	Resultados para el reconocimiento de entidades.

Entity

Define el objeto de entidad detectado que contiene la categoría de entidad y el texto de entidad detectados, etc.

Nombre	Tipo	Description
category	string	Tipo de entidad.
confidenceScore	number	Puntuación de confianza entre 0 y 1 de la entidad extraída.
length	integer	Longitud del texto de la entidad. El uso de diferentes valores "stringIndexType" puede afectar a la longitud devuelta.
offset	integer	Posición inicial del texto de la entidad. El uso de diferentes valores "stringIndexType" puede afectar al desplazamiento devuelto.
subcategory	string	(Opcional) Subtipo de entidad.
text	string	Texto de entidad como aparece en la solicitud.

EntityLinkingResult

Resultado de vinculación de entidades.

Nombre	Tipo	Description
documents	LinkedEntitiesDocumentResult[]	Respuesta por documento
errors	DocumentError[]	Errores por identificador de documento.
modelVersion	string	Este campo indica qué modelo se usa para la puntuación.
statistics	RequestStatistics	si showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga de la solicitud.

EntityLinkingTaskParameters

Parámetros admitidos para una tarea De vinculación de entidades.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	No participar en el registro
modelVersion	string	latest	versión del modelo
stringIndexType	StringIndexType	TextElements_v8	Parámetro opcional para proporcionar el tipo de índice de cadena usado para interpretar los desplazamientos de cadena. El valor predeterminado es TextElements (Graphemes).

EntityLinkingTaskResult

Contiene el resultado de la tarea analizar la vinculación de entidades.

Nombre	Tipo	Description
kind	string: EntityLinkingResults	El tipo de resultado de la tarea.
results	EntityLinkingResult	Resultado de vinculación de entidades.

Error

Objeto de respuesta de error devuelto cuando el servicio encuentra algunos errores durante el procesamiento de la solicitud.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	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.

ErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string	error de Azure Cognitive Search límite de índice alcanzado
AzureCognitiveSearchIndexNotFound	string	error de Azure Cognitive Search índice no encontrado
AzureCognitiveSearchNotFound	string	Azure Cognitive Search error no encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search error de limitación
Conflict	string	Error de conflicto
Forbidden	string	Error de acceso prohibido
InternalServerError	string	Error interno del servidor
InvalidArgument	string	Error de argumento no válido
InvalidRequest	string	Error de solicitud no válido
NotFound	string	Error no encontrado
OperationNotFound	string	Error de operación no encontrada
ProjectNotFound	string	Error de proyecto no encontrado
QuotaExceeded	string	Cuota de errores superada
ServiceUnavailable	string	Error de servicio no disponible
Timeout	string	Error de tiempo de espera
TooManyRequests	string	Error de demasiadas solicitudes
Unauthorized	string	Error de acceso no autorizado
Warning	string	Error de advertencia

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchNotFound	string	Azure Cognitive Search error no encontrado
AzureCognitiveSearchThrottling	string	Azure Cognitive Search error de limitación
EmptyRequest	string	Error de solicitud vacía
ExtractionFailure	string	Error de error de extracción
InvalidCountryHint	string	Error de sugerencia de país no válido
InvalidDocument	string	Error de documento no válido
InvalidDocumentBatch	string	Error de lote de documento no válido
InvalidParameterValue	string	Error de valor de parámetro no válido
InvalidRequest	string	Error de solicitud no válido
InvalidRequestBodyFormat	string	Error de formato de cuerpo de la solicitud no válido
KnowledgeBaseNotFound	string	Error de base de conocimiento no encontrado
MissingInputDocuments	string	Error de documentos de entrada que faltan
ModelVersionIncorrect	string	Error incorrecto de la versión del modelo
UnsupportedLanguageCode	string	Error de código de idioma no admitido

InnerErrorModel

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	InnerErrorCode	Uno de los conjuntos de códigos de error definidos por el servidor.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

KeyPhraseResult

Contiene keyPhraseResult.

Nombre	Tipo	Description
documents	KeyPhrasesDocumentResult[]	Respuesta por documento
errors	DocumentError[]	Errores por id. de documento.
modelVersion	string	Este campo indica qué modelo se usa para la puntuación.
statistics	RequestStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

KeyPhrasesDocumentResult

Contiene los resultados de extracción de frases clave de un documento.

Nombre	Tipo	Description
id	string	Identificador de documento único y no vacío.
keyPhrases	string[]	Lista de palabras o frases representativas. El número de frases clave devueltas es proporcional al número de palabras del documento de entrada.
statistics	DocumentStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

KeyPhraseTaskParameters

Parámetros admitidos para una tarea extracción de frases clave.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	No participar en el registro
modelVersion	string	latest	versión del modelo

KeyPhraseTaskResult

Contiene el resultado de la tarea Analizar texto KeyPhraseExtraction.

Nombre	Tipo	Description
kind	string: KeyPhraseExtractionResults	El tipo de resultado de la tarea.
results	KeyPhraseResult	Lista de resultados de extracción de frases clave

LanguageDetectionAnalysisInput

Contiene la entrada de análisis de documentos de detección de idioma.

Nombre	Tipo	Description
documents	LanguageInput[]	Lista de documentos que se van a analizar.

LanguageDetectionDocumentResult

Contiene la detección de idioma de un documento.

Nombre	Tipo	Description
detectedLanguage	DetectedLanguage	Idioma detectado.
id	string	Identificador de documento único y no vacío.
statistics	DocumentStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

LanguageDetectionResult

Contiene el resultado de detección de idioma para la solicitud.

Nombre	Tipo	Description
documents	LanguageDetectionDocumentResult[]	Enumeración de los resultados de detección de idioma para cada documento de entrada.
errors	DocumentError[]	Errores por id. de documento.
modelVersion	string	Este campo indica qué modelo se usa para la puntuación.
statistics	RequestStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

LanguageDetectionTaskParameters

Parámetros admitidos para una tarea detección de idioma.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	No participar en el registro
modelVersion	string	latest	versión del modelo

LanguageDetectionTaskResult

Contiene el resultado de la tarea de detección de idioma para la solicitud.

Nombre	Tipo	Description
kind	string: LanguageDetectionResults	El tipo de resultado de la tarea.
results	LanguageDetectionResult	Contiene los resultados de detección de idioma.

LanguageInput

Contiene la entrada de detección de idioma.

Nombre	Tipo	Description
countryHint	string	Sugerencia de país para ayudar con la detección de idioma del texto.
id	string	Identificador de documento único y no vacío.
text	string	Texto de entrada que se va a procesar.

LinkedEntitiesDocumentResult

Resultado del documento de vinculación de entidades.

Nombre	Tipo	Description
entities	LinkedEntity[]	Entidades conocidas reconocidas en el documento.
id	string	Identificador de documento único y no vacío.
statistics	DocumentStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

LinkedEntity

Objeto LinkedEntity que contiene la entidad detectada con los orígenes o vínculos asociados.

Nombre	Tipo	Description
bingId	string	Bing Entity Búsqueda identificador único de la API de la entidad reconocida.
dataSource	string	Origen de datos usado para extraer la vinculación de entidades, como Wiki/Bing, etc.
id	string	Identificador único de la entidad reconocida del origen de datos.
language	string	Idioma usado en el origen de datos.
matches	Match[]	Lista de instancias que esta entidad aparece en el texto.
name	string	Nombre formal de vinculación de entidad.
url	string	Dirección URL de la página de la entidad desde el origen de datos.

Match

Objeto Match que contiene el texto de la entidad detectada con el desplazamiento y la longitud.

Nombre	Tipo	Description
confidenceScore	number	Si se reconoce un elemento conocido, se devolverá un número decimal que indica el nivel de confianza entre 0 y 1.
length	integer	Longitud del texto de coincidencia de entidad.
offset	integer	Posición inicial para el texto de coincidencia de entidad.
text	string	Texto de entidad como aparece en la solicitud.

MultiLanguageAnalysisInput

Colección de documentos de entrada que va a analizar el servicio.

Nombre	Tipo	Description
documents	MultiLanguageInput[]	Documentos de entrada que se van a analizar.

MultiLanguageInput

Contiene un documento de entrada que el servicio va a analizar.

Nombre	Tipo	Description
id	string	Identificador de documento único y no vacío.
language	string	(Opcional) Esta es la representación ISO 639-1 de dos letras de un idioma. Por ejemplo, use "en" para inglés; "es" para español, etc. Si no se establece, use "en" para inglés como valor predeterminado. (Después solo se aplica a 2023-04-15-preview y versiones posteriores) En Detección automática de idioma, use "auto". Si no se establece, use "en" para inglés como valor predeterminado.
text	string	Texto de entrada que se va a procesar.

PiiCategory

(Opcional) describe las categorías de PII que se van a devolver.

Nombre	Tipo	Description
ABARoutingNumber	string	Número de enrutamiento de ABA
ARNationalIdentityNumber	string	Número de identidad nacional de AR
ATIdentityCard	string	Tarjeta de identidad at
ATTaxIdentificationNumber	string	AT Tax Identification Number
ATValueAddedTaxNumber	string	Número fiscal de AT Value Added
AUBankAccountNumber	string	Tarjeta de identidad at
AUBusinessNumber	string	Número de negocio de AU
AUCompanyNumber	string	Número de empresa de AU
AUDriversLicenseNumber	string	Número de licencia de conducir de AU
AUMedicalAccountNumber	string	Número de cuenta médica de AU
AUPassportNumber	string	Número de pasaporte au
AUTaxFileNumber	string	Número de archivo fiscal au
Address	string	Dirección
Age	string	Age
All	string	Todas las categorías de PII.
AzureDocumentDBAuthKey	string	Clave de autenticación de Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	string	Conexión de base de datos iaas de Azure y cadena SQL
AzureIoTConnectionString	string	Cadena de conexión de Azure IoT
AzurePublishSettingPassword	string	Contraseña de configuración de publicación de Azure
AzureRedisCacheString	string	Cadena de Azure Redis Cache
AzureSAS	string	SAS de Azure
AzureServiceBusString	string	cadena de Azure Service Bus
AzureStorageAccountGeneric	string	Genérico de la cuenta de Azure Storage
AzureStorageAccountKey	string	Clave de la cuenta de Azure Storage
BENationalNumber	string	BE National Number
BENationalNumberV2	string	BE National Number V2
BEValueAddedTaxNumber	string	BE Value Added Tax Number
BGUniformCivilNumber	string	Número civil uniforme de BG
BRCPFNumber	string	Número CPF de BR
BRLegalEntityNumber	string	Número de entidad jurídica br
BRNationalIDRG	string	BR National ID RG
CABankAccountNumber	string	Número de cuenta bancaria de CA
CADriversLicenseNumber	string	Número de licencia de conducir de CA
CAHealthServiceNumber	string	Número del servicio de mantenimiento de CA
CAPassportNumber	string	Número de pasaporte de CA
CAPersonalHealthIdentification	string	Identificación de estado personal de CA
CASocialInsuranceNumber	string	Número de seguro social de CA
CHSocialSecurityNumber	string	Número de seguro social de CH
CLIdentityCardNumber	string	Número de tarjeta de identidad cl
CNResidentIdentityCardNumber	string	Número de tarjeta de identidad residente de CN
CYIdentityCard	string	Tarjeta de identidad cy
CYTaxIdentificationNumber	string	Número de identificación fiscal cy
CZPersonalIdentityNumber	string	Número de identidad personal de CZ
CZPersonalIdentityV2	string	CZ Personal Identity V2
CreditCardNumber	string	Número de la tarjeta de crédito
DEDriversLicenseNumber	string	Número de licencia de conducir de DE
DEIdentityCardNumber	string	Número de tarjeta de identidad de DE
DEPassportNumber	string	Número de pasaporte DE
DETaxIdentificationNumber	string	Número de identificación fiscal DE
DEValueAddedNumber	string	Número de valor agregado de DE
DKPersonalIdentificationNumber	string	Número de identificación personal de DK
DKPersonalIdentificationV2	string	Identificación personal V2 de DK
Date	string	Fecha
Default	string	Categorías de PII predeterminadas para el idioma.
DrugEnforcementAgencyNumber	string	Número de agencia de cumplimiento de drogas
EEPersonalIdentificationCode	string	Código de identificación personal ee
ESDNI	string	ES DNI
ESSocialSecurityNumber	string	Número de seguro social de ES
ESTaxIdentificationNumber	string	Número de identificación fiscal de ES
EUDebitCardNumber	string	Número de tarjeta de débito de la UE
EUDriversLicenseNumber	string	Número de permiso de conducir de la UE
EUGPSCoordinates	string	Coordenadas GPS de la UE
EUNationalIdentificationNumber	string	Número de identificación nacional de la UE
EUPassportNumber	string	Número de pasaporte de la UE
EUSocialSecurityNumber	string	Número de seguridad social de la UE
EUTaxIdentificationNumber	string	Número de identificación fiscal de la UE
Email	string	Correo electrónico
FIEuropeanHealthNumber	string	Número europeo de salud fi
FINationalID	string	FI National ID
FINationalIDV2	string	FI National ID V2
FIPassportNumber	string	Número de pasaporte FI
FRDriversLicenseNumber	string	Número de licencia de conducir de FR
FRHealthInsuranceNumber	string	Número de seguro médico de FR
FRNationalID	string	Id. nacional de FR
FRPassportNumber	string	Número de pasaporte de FR
FRSocialSecurityNumber	string	Número de seguridad social de FR
FRTaxIdentificationNumber	string	Número de identificación fiscal de FR
FRValueAddedTaxNumber	string	Número de impuesto de valor añadido de FR
GRNationalIDCard	string	Tarjeta de identificación nacional gr
GRNationalIDV2	string	GR National ID V2
GRTaxIdentificationNumber	string	Número de identificación fiscal gr
HKIdentityCardNumber	string	Número de tarjeta de identidad hk
HRIdentityCardNumber	string	Número de tarjeta de identidad de RR. HH.
HRNationalIDNumber	string	Número de identificación nacional de RR. HH.
HRPersonalIdentificationNumber	string	Número de identificación personal de RR. HH.
HRPersonalIdentificationOIBNumberV2	string	Número OIB de identificación personal de RR. HH. V2
HUPersonalIdentificationNumber	string	Número de identificación personal de HU
HUTaxIdentificationNumber	string	Número de identificación fiscal hu
HUValueAddedNumber	string	Número de valor agregado de HU
IDIdentityCardNumber	string	Id. número de tarjeta de identidad
IEPersonalPublicServiceNumber	string	Número de servicio público personal de IE
IEPersonalPublicServiceNumberV2	string	Número de servicio público personal de IE V2
ILBankAccountNumber	string	Número de cuenta bancaria il
ILNationalID	string	Id. nacional de IL
INPermanentAccount	string	CUENTA PERMANENTE DE IN
INUniqueIdentificationNumber	string	IN Número de identificación único
IPAddress	string	Dirección IP
ITDriversLicenseNumber	string	Número de licencia de conducir de TI
ITFiscalCode	string	Código fiscal de TI
ITValueAddedTaxNumber	string	Número fiscal de valor añadido de TI
InternationalBankingAccountNumber	string	Número de cuenta bancaria internacional
JPBankAccountNumber	string	Número de cuenta bancaria de JP
JPDriversLicenseNumber	string	Número de licencia de conducir de JP
JPMyNumberCorporate	string	JP My Number Corporate
JPMyNumberPersonal	string	JP Mi número personal
JPPassportNumber	string	Número de pasaporte jp
JPResidenceCardNumber	string	Número de tarjeta de residencia JP
JPResidentRegistrationNumber	string	Número de registro residente de JP
JPSocialInsuranceNumber	string	Número de seguro social jp
KRResidentRegistrationNumber	string	Número de registro residente de KR
LTPersonalCode	string	Código personal lt
LUNationalIdentificationNumberNatural	string	Número de identificación nacional de LU Natural
LUNationalIdentificationNumberNonNatural	string	Número de identificación nacional de LU no natural
LVPersonalCode	string	Código personal de LV
MTIdentityCardNumber	string	Número de tarjeta de identidad de MT
MTTaxIDNumber	string	Número de identificación fiscal de MT
MYIdentityCardNumber	string	Mi número de tarjeta de identidad
NLCitizensServiceNumber	string	Número de servicio de ciudadanos de NL
NLCitizensServiceNumberV2	string	Número de servicio de ciudadanos de NL V2
NLTaxIdentificationNumber	string	Número de identificación fiscal nl
NLValueAddedTaxNumber	string	Número de impuesto de valor añadido nl
NOIdentityNumber	string	NO hay número de identidad
NZBankAccountNumber	string	Número de cuenta bancaria de NZ
NZDriversLicenseNumber	string	Número de licencia de conducir de NZ
NZInlandRevenueNumber	string	NZ Inland Revenue Number
NZMinistryOfHealthNumber	string	Número de NZ Ministerio de Salud
NZSocialWelfareNumber	string	NZ Social Welfare Number
Organization	string	Organización
PHUnifiedMultiPurposeIDNumber	string	Número de id. de varios propósitos unificado de PH
PLIdentityCard	string	Tarjeta de identidad de PL
PLNationalID	string	Id. nacional de PL
PLNationalIDV2	string	PL National ID V2
PLPassportNumber	string	Número de pasaporte de PL
PLREGONNumber	string	Número REGON de PL
PLTaxIdentificationNumber	string	Número de identificación fiscal de PL
PTCitizenCardNumber	string	Número de tarjeta de ciudadano PT
PTCitizenCardNumberV2	string	Número de tarjeta de ciudadano PT V2
PTTaxIdentificationNumber	string	Número de identificación fiscal PT
Person	string	Person
PhoneNumber	string	Número de teléfono
ROPersonalNumericalCode	string	Código numérico personal de RO
RUPassportNumberDomestic	string	Número de pasaporte de RU nacional
RUPassportNumberInternational	string	Número de pasaporte ru internacional
SANationalID	string	Identificador nacional de SA
SENationalID	string	SE National ID
SENationalIDV2	string	SE National ID V2
SEPassportNumber	string	Número de pasaporte de SE
SETaxIdentificationNumber	string	Número de identificación fiscal SE
SGNationalRegistrationIdentityCardNumber	string	Número de tarjeta de identidad de registro nacional sg
SITaxIdentificationNumber	string	Número de identificación fiscal de SI
SIUniqueMasterCitizenNumber	string	Número de ciudadano maestro único de SI
SKPersonalNumber	string	SK Personal Number
SQLServerConnectionString	string	Cadena de conexión de SQL Server
SWIFTCode	string	Código SWIFT
THPopulationIdentificationCode	string	Código de identificación de población TH
TRNationalIdentificationNumber	string	Número de identificación nacional tr
TWNationalID	string	Id. nacional de TW
TWPassportNumber	string	Número de pasaporte de TW
TWResidentCertificate	string	Certificado residente de TW
UAPassportNumberDomestic	string	Número de pasaporte nacional de UA
UAPassportNumberInternational	string	Número de pasaporte internacional de UA
UKDriversLicenseNumber	string	Número de licencia de conducir de Reino Unido
UKElectoralRollNumber	string	Número de lista electoral de Reino Unido
UKNationalHealthNumber	string	Número de salud nacional de Reino Unido
UKNationalInsuranceNumber	string	Número de seguro nacional de Reino Unido
UKUniqueTaxpayerNumber	string	Número de contribuyente único de Reino Unido
URL	string	URL
USBankAccountNumber	string	Número de cuenta bancaria de EE. UU.
USDriversLicenseNumber	string	Número de licencia de conducir de EE. UU.
USIndividualTaxpayerIdentification	string	Identificación de contribuyentes individuales de EE. UU.
USSocialSecurityNumber	string	Número de seguro social de EE. UU.
USUKPassportNumber	string	Número de pasaporte de Reino Unido de EE. UU.
ZAIdentificationNumber	string	Número de identificación de ZA

PiiDomain

Dominio para la tarea PII

Nombre	Tipo	Description
none	string	Indica que no se especifica ningún dominio.
phi	string	Indica que se deben censurar las entidades del dominio información de salud personal.

PiiEntitiesDocumentResult

Contiene los resultados de PII.

Nombre	Tipo	Description
entities	Entity[]	Entidades reconocidas en el documento.
id	string	Identificador de documento único y no vacío.
redactedText	string	Devuelve texto censurado.
statistics	DocumentStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

PiiResult

Contiene piiResult.

Nombre	Tipo	Description
documents	PiiEntitiesDocumentResult[]	Respuesta por documento
errors	DocumentError[]	Errores por id. de documento.
modelVersion	string	Este campo indica qué modelo se usa para la puntuación.
statistics	RequestStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

PiiTaskParameters

Parámetros admitidos para una tarea de reconocimiento de entidades de PII.

Nombre	Tipo	Valor predeterminado	Description
domain	PiiDomain	none	Dominio para la tarea PII
loggingOptOut	boolean	False	No participar en el registro
modelVersion	string	latest	versión del modelo
piiCategories	PiiCategory[]		Enumeración de categorías de PII que se van a devolver en la respuesta.
stringIndexType	StringIndexType	TextElements_v8	StringIndexType que se va a usar para el análisis.

PiiTaskResult

Contiene la tarea LRO de análisis de texto PIIEntityRecognition.

Nombre	Tipo	Description
kind	string: PiiEntityRecognitionResults	El tipo de resultado de la tarea.
results	PiiResult	La lista de resultados de pii

RequestStatistics

si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

Nombre	Tipo	Description
documentsCount	integer	Número de documentos enviados en la solicitud.
erroneousDocumentsCount	integer	Número de documentos no válidos. Esto incluye documentos vacíos, de límite de tamaño excesivo o de idiomas no admitidos.
transactionsCount	integer	Número de transacciones de la solicitud.
validDocumentsCount	integer	Número de documentos válidos. Esto excluye documentos vacíos, de límite de tamaño excesivo o de idiomas no admitidos.

SentenceAssessment

Representa una evaluación de oraciones y las evaluaciones o objetos de destino relacionados con ella.

Nombre	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.
isNegated	boolean	Indicador que representa si la evaluación está negada.
length	integer	Longitud del destino.
offset	integer	Desplazamiento de destino desde el principio de la oración.
sentiment	TokenSentimentValue	Opinión de la frase.
text	string	Se detectó el texto de destino.

SentenceSentiment

Opinión de frase de un documento.

Nombre	Tipo	Description
assessments	SentenceAssessment[]	Matriz de evaluaciones para la oración.
confidenceScores	SentimentConfidenceScores	Puntuación de confianza de sentimiento entre 0 y 1 para la oración de todas las clases.
length	integer	Longitud del destino.
offset	integer	Desplazamiento de destino desde el principio de la oración.
sentiment	SentenceSentimentValue	Opinión prevista para la frase.
targets	SentenceTarget[]	Matriz de destinos de oración para la oración.
text	string	Texto de la oración.

SentenceSentimentValue

Opinión prevista para la frase.

Nombre	Tipo	Description
negative	string	Opinión negativa
neutral	string	Opinión neutral
positive	string	Opinión positiva

SentenceTarget

Representa un destino de oración y las evaluaciones o los objetos de destino relacionados con él.

Nombre	Tipo	Description
confidenceScores	TargetConfidenceScoreLabel	Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.
length	integer	Longitud del destino.
offset	integer	Desplazamiento de destino desde el principio de la oración.
relations	TargetRelation[]	Matriz de objetos de evaluación o de destino relacionados con el destino.
sentiment	TokenSentimentValue	Opinión de la frase.
text	string	Se detectó el texto de destino.

SentimentAnalysisTaskParameters

Parámetros admitidos para una tarea Análisis de sentimiento.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	No participar en el registro
modelVersion	string	latest	versión del modelo
opinionMining	boolean	False	Si se va a usar la minería de opiniones en la solicitud o no.
stringIndexType	StringIndexType	TextElements_v8	Especifica el método utilizado para interpretar los desplazamientos de cadena.

SentimentConfidenceScores

Representa las puntuaciones de confianza entre 0 y 1 en todas las clases de sentimiento: positivas, neutrales y negativas.

Nombre	Tipo	Description
negative	number	Puntuación de confianza para opiniones negativas
neutral	number	Puntuación de confianza para opiniones neutrales
positive	number	Puntuación de confianza para opiniones positivas

SentimentDocumentResult

Objeto que representa los resultados del análisis de sentimiento pregenerado de cada documento.

Nombre	Tipo	Description
confidenceScores	SentimentConfidenceScores	Puntuación de confianza de sentimiento entre 0 y 1 para la oración de todas las clases.
id	string	Identificador de documento único y no vacío.
sentences	SentenceSentiment[]	Opinión de las oraciones del documento.
sentiment	DocumentSentimentValue	Opinión prevista para el documento (Negativo, Neutro, Positivo o Mixto).
statistics	DocumentStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

SentimentResponse

Resultados del análisis de sentimiento para los documentos de entrada.

Nombre	Tipo	Description
documents	SentimentDocumentResult[]	Los resultados del análisis de sentimiento de cada documento de la entrada.
errors	DocumentError[]	Errores por id. de documento.
modelVersion	string	Este campo indica qué modelo se usa para la puntuación.
statistics	RequestStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

SentimentTaskResult

Contiene el texto de análisis SentimentAnalysis LRO resultado de la tarea.

Nombre	Tipo	Description
kind	string: SentimentAnalysisResults	El tipo de resultado de la tarea.
results	SentimentResponse	Resultados del análisis de sentimiento

StringIndexType

Tipo de índice de cadena

Nombre	Tipo	Description
TextElements_v8	string	Los valores de desplazamiento y longitud devueltos corresponden a TextElements (clústeres de Graphemes y Grapheme) que confirman el estándar Unicode 8.0.0. Use esta opción si la aplicación está escrita en .Net Framework o .Net Core y usará StringInfo.
UnicodeCodePoint	string	Los valores de desplazamiento y longitud devueltos corresponden a los puntos de código Unicode. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo, Python.
Utf16CodeUnit	string	Los valores de desplazamiento y longitud devueltos se corresponden con unidades de código UTF-16. Use esta opción si la aplicación está escrita en un lenguaje que admita Unicode, por ejemplo Java, JavaScript.

TargetConfidenceScoreLabel

Representa las puntuaciones de confianza en todas las clases de sentimiento: positivas y negativas.

Nombre	Tipo	Description
negative	number	Puntuación de confianza para opiniones negativas
positive	number	Puntuación de confianza para opiniones positivas

TargetRelation

Representa la relación entre evaluaciones o destinos.

Nombre	Tipo	Description
ref	string	Puntero JSON que indica el objeto vinculado.
relationType	TargetRelationType	Tipo relacionado con el destino.

TargetRelationType

Tipo relacionado con el destino.

Nombre	Tipo	Description
assessment	string
target	string

TokenSentimentValue

Opinión prevista para la frase.

Nombre	Tipo	Description
mixed	string	Opinión mixta
negative	string	Opinión negativa
positive	string	Opinión positiva

WarningCodeValue

Define la lista de códigos de advertencia.

Nombre	Tipo	Description
DocumentTruncated	string	Advertencia truncada del documento
LongWordsInDocument	string	Palabras largas en la advertencia del documento