Analyze Text - Analyze Text

Servicio:: Azure AI Services

Versión de la API:: 2025-11-01

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

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string (uri)	Punto de conexión de Cognitive Services admitido (por ejemplo, https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.
showStats	query		boolean	(Opcional) si se establece en true, la respuesta contendrá estadísticas de nivel de documento y solicitud.

Cuerpo de la solicitud

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

Nombre	Description
AnalyzeTextEntityLinkingInput	Contiene la entrada de enlace de entidad de texto de análisis.
AnalyzeTextEntityRecognitionInput	La solicitud de tarea de entrada de texto de análisis de reconocimiento de entidades.
AnalyzeTextKeyPhraseExtractionInput	Contiene la entrada de tarea de análisis de 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 de texto PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contiene la entrada de tarea SentimentAnalysis de texto de análisis.

AnalyzeTextEntityLinkingInput

Contiene la entrada de enlace de entidad de texto de análisis.

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

AnalyzeTextEntityRecognitionInput

La solicitud de tarea de entrada de texto de análisis de reconocimiento de entidades.

Nombre	Requerido	Tipo	Description
kind	True	string: EntityRecognition	El tipo de tarea a realizar.
analysisInput		MultiLanguageAnalysisInput	La entrada a analizar.
parameters		EntitiesTaskParameters	Parámetros de la tarea.

AnalyzeTextKeyPhraseExtractionInput

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

Nombre	Requerido	Tipo	Description
kind	True	string: KeyPhraseExtraction	El tipo de tarea a realizar.
analysisInput		MultiLanguageAnalysisInput	Contiene los documentos de entrada.
parameters		KeyPhraseTaskParameters	Parámetros de la 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	El tipo de tarea a realizar.
analysisInput		LanguageDetectionAnalysisInput	Documentos a analizar.
parameters		LanguageDetectionTaskParameters	task parámetros.

AnalyzeTextPiiEntitiesRecognitionInput

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

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

AnalyzeTextSentimentAnalysisInput

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

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

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. Encabezados x-ms-error-code: string

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.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize
Dirección URL del token: https://login.microsoftonline.com/common/oauth2/token

Ámbitos

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

Ejemplos

SuccessfulEntityLinkingRequest

SuccessfulEntityRecognitionExclusionRequest

SuccessfulEntityRecognitionInclusionRequest

SuccessfulEntityRecognitionInferenceOptionsRequest

SuccessfulEntityRecognitionOverlapPolicy

SuccessfulEntityRecognitionRequest

SuccessfulKeyPhraseExtractionRequest

SuccessfulLanguageDetectionRequest

SuccessfulPiiEntityRecognitionRequest

SuccessfulSentimentAnalysisRequest

SuccessfulEntityLinkingRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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."
      }
    ]
  }
}

Respuesta de muestra

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

SuccessfulEntityRecognitionExclusionRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "exclusionList": [
      "Numeric"
    ],
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Airport",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInclusionRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inclusionList": [
      "Location"
    ]
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionInferenceOptionsRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "inferenceOptions": {
      "excludeNormalizedValues": true
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "1",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ]
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ]
          }
        ],
        "id": "1",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2023-09-01"
  }
}

SuccessfulEntityRecognitionOverlapPolicy

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "matchLongest"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.59,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.59
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulEntityRecognitionRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-01

{
  "kind": "EntityRecognition",
  "parameters": {
    "modelVersion": "latest",
    "overlapPolicy": {
      "policyKind": "allowOverlap"
    }
  },
  "analysisInput": {
    "documents": [
      {
        "id": "2",
        "language": "en",
        "text": "When I was 5 years old I had $90.00 dollars to my name."
      },
      {
        "id": "3",
        "language": "en",
        "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile."
      },
      {
        "id": "4",
        "language": "en",
        "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup"
      },
      {
        "id": "5",
        "language": "en",
        "text": "My IP is 127.12.1.1 and my phone   number is 5555555555"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

{
  "kind": "EntityRecognitionResults",
  "results": {
    "documents": [
      {
        "entities": [
          {
            "text": "5 years old",
            "category": "Numeric",
            "type": "Age",
            "offset": 11,
            "length": 11,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Age",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "AgeMetadata",
              "unit": "Year",
              "value": 5
            }
          },
          {
            "text": "$90.00",
            "category": "Numeric",
            "type": "Currency",
            "offset": 29,
            "length": 14,
            "confidenceScore": 0.99,
            "tags": [
              {
                "name": "Numeric",
                "confidenceScore": 0.99
              },
              {
                "name": "Currency",
                "confidenceScore": 0.99
              }
            ],
            "metadata": {
              "metadataKind": "CurrencyMetadata",
              "unit": "Dollar",
              "iso4217": "USD",
              "value": 90
            }
          }
        ],
        "id": "2",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "LAX",
            "category": "Location",
            "type": "Structural",
            "offset": 18,
            "length": 3,
            "confidenceScore": 0.72,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.72
              }
            ]
          },
          {
            "text": "10 meters per second",
            "category": "Numeric",
            "type": "Speed",
            "offset": 55,
            "length": 20,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Dimension",
                "confidenceScore": 0.84
              },
              {
                "name": "Numeric",
                "confidenceScore": 0.84
              },
              {
                "name": "Speed",
                "confidenceScore": 0.8
              }
            ],
            "metadata": {
              "metadataKind": "SpeedMetadata",
              "unit": "MetersPerSecond",
              "value": 10
            }
          },
          {
            "text": "Amsterdam",
            "category": "Location",
            "type": "City",
            "offset": 96,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.84
              },
              {
                "name": "GPE",
                "confidenceScore": 0.84
              },
              {
                "name": "City",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "Eiffel Tower",
            "category": "Location",
            "type": "Structural",
            "offset": 107,
            "length": 12,
            "confidenceScore": 0.9,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Structural",
                "confidenceScore": 0.9
              }
            ]
          },
          {
            "text": "Nile",
            "category": "Location",
            "type": "Geological",
            "offset": 129,
            "length": 4,
            "confidenceScore": 0.63,
            "tags": [
              {
                "name": "Location",
                "confidenceScore": 0.9
              },
              {
                "name": "Geological",
                "confidenceScore": 0.63
              }
            ]
          }
        ],
        "id": "3",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "25th April",
            "category": "Temporal",
            "type": "Date",
            "offset": 0,
            "length": 10,
            "confidenceScore": 0.58,
            "tags": [
              {
                "name": "Temporal",
                "confidenceScore": 0.9
              },
              {
                "name": "Date",
                "confidenceScore": 0.58
              }
            ],
            "metadata": {
              "metadataKind": "DateMetadata",
              "dateValues": [
                {
                  "timex": "XXXX-04-25",
                  "value": "2022-04-25"
                },
                {
                  "timex": "XXXX-04-25",
                  "value": "2023-04-25"
                }
              ]
            }
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "Event",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "25th April Meeting",
            "category": "Event",
            "type": "CulturalEvent",
            "offset": 0,
            "length": 18,
            "confidenceScore": 0.55,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "CulturalEvent",
                "confidenceScore": 0.55
              }
            ]
          },
          {
            "text": "Worldcup",
            "category": "Event",
            "type": "SportsEvent",
            "offset": 0,
            "length": 8,
            "confidenceScore": 0.51,
            "tags": [
              {
                "name": "Event",
                "confidenceScore": 0.55
              },
              {
                "name": "SportsEvent",
                "confidenceScore": 0.51
              }
            ]
          }
        ],
        "id": "4",
        "warnings": []
      },
      {
        "entities": [
          {
            "text": "127.12.1.1",
            "category": "IP",
            "type": "IP",
            "offset": 9,
            "length": 10,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "IP",
                "confidenceScore": 0.8
              }
            ]
          },
          {
            "text": "5555555555",
            "category": "PhoneNumber",
            "type": "PhoneNumber",
            "offset": 45,
            "length": 9,
            "confidenceScore": 0.8,
            "tags": [
              {
                "name": "PhoneNumber",
                "confidenceScore": 0.8
              }
            ]
          }
        ],
        "id": "5",
        "warnings": []
      }
    ],
    "errors": [],
    "modelVersion": "2021-06-01"
  }
}

SuccessfulKeyPhraseExtractionRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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."
      }
    ]
  }
}

Respuesta de muestra

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

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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?"
      }
    ]
  }
}

Respuesta de muestra

status code:: 200

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

SuccessfulPiiEntityRecognitionRequest

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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?"
      }
    ]
  }
}

Respuesta de muestra

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

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:analyze-text?api-version=2025-11-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."
      }
    ]
  }
}

Respuesta de muestra

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
AgeMetadata	Representa el modelo de metadatos de la entidad Age.
AgeUnit	Unidad de medición de edad
AllowOverlapEntityPolicyType	Representa la directiva de superposición de permisos. No aplicará ninguna lógica de procesamiento posterior para las entidades. Lo que predice el modelo es lo que se devolverá al usuario. Esto permite al usuario obtener una vista completa de los valores posibles de cada modelo y aplicar su propia lógica personalizada en la selección de entidades
AnalyzeTextEntityLinkingInput	Contiene la entrada de enlace de entidad de texto de análisis.
AnalyzeTextEntityRecognitionInput	La solicitud de tarea de entrada de texto de análisis de reconocimiento de entidades.
AnalyzeTextKeyPhraseExtractionInput	Contiene la entrada de tarea de análisis de 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 de texto PIIEntityRecognition.
AnalyzeTextSentimentAnalysisInput	Contiene la entrada de tarea SentimentAnalysis de texto de análisis.
AnalyzeTextTaskKind	El tipo de tareas de análisis de texto admitidas.
AnalyzeTextTaskResultsKind	El tipo de objeto de respuesta devuelto por la tarea analyze-text.
AreaMetadata	Representa el modelo de metadatos de la entidad Area.
AreaUnit	Unidad de medida de área.
CurrencyMetadata	Representa el modelo de metadatos de la entidad Currency).
DateMetadata	A Metadatos para instancias de entidad de fecha.
DateTimeMetadata	Metadatos para instancias de entidad de fecha y hora.
DateValue	Representa el valor de fecha.
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 las advertencias encontradas para el documento procesado.
EntitiesDocumentResultWithMetadata	Los documentos de entidad dan como resultado metadatos.
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.
EntityCategory	Contiene todas las categorías de entidades detectadas por el reconocimiento de entidades.
EntityInferenceOptions	La clase que aloja las opciones de inferencia permitidas para el reconocimiento de entidades con nombre.
EntityLinkingResult	Resultado de la vinculación de entidades.
EntityLinkingTaskParameters	Parámetros admitidos para una tarea de vinculación de entidades.
EntityLinkingTaskResult	Contiene el texto de análisis Resultado de la tarea de vinculación de entidades.
EntityTag	Objeto de etiqueta de entidad que contiene el nombre de las etiquetas y cualquier puntuación de confianza asociada. Las etiquetas de entidad se utilizan para expresar algunas similitudes / afinidad entre entidades.
EntityWithMetadata	Objeto de entidad con etiquetas y metadatos.
Error	El objeto de respuesta de error que se devuelve cuando el servicio encuentra algunos errores durante el procesamiento de la solicitud.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InformationMetadata	Representa el modelo de metadatos de la entidad de información (datos).
InformationUnit	Unidad de medición de información (datos).
InnerErrorCode	Código de error legible para personas.
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 la extracción de frases clave para un documento.
KeyPhraseTaskParameters	Parámetros admitidos para una tarea de extracción de frases clave.
KeyPhraseTaskResult	Contiene el resultado de la tarea de análisis de texto KeyPhraseExtraction.
LanguageDetectionAnalysisInput	Contiene la entrada de análisis del documento de detección de idioma.
LanguageDetectionDocumentResult	Contiene la detección de idioma de un documento.
LanguageDetectionResult	Contiene el resultado de la detección de idioma de la solicitud.
LanguageDetectionTaskParameters	Parámetros admitidos para una tarea de 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.
LengthMetadata	Representa el modelo de metadatos de la entidad Length.
LengthUnit	Unidad de medida de longitud.
LinkedEntitiesDocumentResult	Resultado del documento de vinculación de entidades.
LinkedEntity	El objeto LinkedEntity que contiene la entidad detectada con los orígenes o vínculos asociados.
Match	El objeto Match que contiene el texto de la entidad detectada con el desplazamiento y la longitud.
MatchLongestEntityPolicyType	Representa la directiva Coincidir con superposición más larga. No se superponen entidades en la medida de lo posible. 1. Si hay entidades superpuestas, se devolverá la más larga. 2. Si el conjunto de caracteres predicho para 2 o más entidades es exactamente el mismo, seleccione la entidad que tenga la puntuación de confianza más alta.3. Si las puntuaciones de entidad son idénticas, devuelva todas las entidades que aún estén presentes después de aplicar las reglas anteriores. 3. Si hay una superposición parcial (como en Hello Text Analytics), siga los pasos anteriores a partir de 1.
MetadataKind	Tipo de objeto de metadatos de la entidad.
MultiLanguageAnalysisInput	Recopilación de documentos de entrada para ser analizados por el servicio.
MultiLanguageInput	Contiene un documento de entrada para que el servicio lo analice.
NumberKind	Tipo de la entidad numérica extraída.
NumberMetadata	Metadatos para instancias de entidades numéricas.
NumericRangeMetadata	representa los metadatos de los intervalos numéricos.
OrdinalMetadata	Metadatos para instancias de entidades numéricas.
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 el PiiResult.
PiiTaskParameters	Parámetros admitidos para una tarea de reconocimiento de entidades PII.
PiiTaskResult	Contiene la tarea LRO de análisis de texto PIIEntityRecognition.
RangeInclusivity	El rango de inclusión de esta propiedad inmobiliaria.
RangeKind	El tipo de entidad de rango de números.
RelativeTo	Punto de referencia que indica el número ordinal.
RequestStatistics	si se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.
ScriptCode	Identifica el script del documento de entrada. Se asigna al código de script estándar ISO 15924.
ScriptKind	Identifica el script del documento de entrada. Se asigna al nombre formal de la norma ISO 15924.
SentenceAssessment	Representa una evaluación de oración y las evaluaciones u objetos de destino relacionados con ella.
SentenceSentiment	El sentimiento de la oración de un documento.
SentenceSentimentValue	Opinión predicha para la frase.
SentenceTarget	Representa un destino de oración y las evaluaciones u objetos de destino relacionados con él.
SentimentAnalysisTaskParameters	Parámetros admitidos para una tarea de análisis de opiniones.
SentimentConfidenceScores	Representa las puntuaciones de confianza entre 0 y 1 en todas las clases de sentimiento: positivas, neutrales y negativas.
SentimentDocumentResult	Un objeto que representa los resultados del análisis de sentimiento precompilados de cada documento.
SentimentResponse	Resultados del análisis de opiniones para los documentos de entrada.
SentimentTaskResult	Contiene el resultado de la tarea LRO de análisis de sentimiento de texto.
SpeedMetadata	Representa el modelo de metadatos de la entidad Velocidad.
SpeedUnit	Unidad de medida de velocidad
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 y/o metas.
TargetRelationType	Tipo relacionado con el destino.
TemperatureMetadata	Representa el modelo de metadatos de la entidad de información.
TemperatureUnit	Unidad de medición de temperatura.
TemporalModifier	Un modificador opcional de una instancia de fecha y hora.
TemporalSetMetadata	A Metadatos para instancias de entidad de conjunto temporal.
TemporalSpanMetadata	representa los metadatos de un intervalo de fecha o tiempo.
TemporalSpanValues	Objeto de intervalo temporal.
TimeMetadata	Metadatos para instancias de entidad de tiempo.
TokenSentimentValue	Opinión predicha para la frase.
VolumeMetadata	Representa el modelo de metadatos de la entidad de volumen.
VolumeUnit	Unidad de volumen de medida
WarningCodeValue	Define la lista de códigos de advertencia.
WeightMetadata	Representa el modelo de metadatos de la entidad Peso.
WeightUnit	Unidad de medida de peso.

AgeMetadata

Objeto

Representa el modelo de metadatos de la entidad Age.

Nombre	Tipo	Description
metadataKind	string: AgeMetadata	Tipo de objeto de metadatos de la entidad.
unit	AgeUnit	Unidad de medida para la edad.
value	number (double)	Valor numérico que indica el texto extraído.

AgeUnit

Enumeración

Unidad de medición de edad

Valor	Description
Unspecified	Período de tiempo no especificado
Year	Período de tiempo de un año
Month	Período de tiempo de un mes
Week	Período de tiempo de una semana
Day	Período de tiempo de un día

AllowOverlapEntityPolicyType

Objeto

Representa la directiva de superposición de permisos. No aplicará ninguna lógica de procesamiento posterior para las entidades. Lo que predice el modelo es lo que se devolverá al usuario. Esto permite al usuario obtener una vista completa de los valores posibles de cada modelo y aplicar su propia lógica personalizada en la selección de entidades

Nombre	Tipo	Valor predeterminado	Description
policyKind	string: allowOverlap	matchLongest	Tipo de objeto OverlapPolicy de entidad.

AnalyzeTextEntityLinkingInput

Objeto

Contiene la entrada de enlace de entidad de texto de análisis.

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

AnalyzeTextEntityRecognitionInput

Objeto

La solicitud de tarea de entrada de texto de análisis de reconocimiento de entidades.

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	La entrada a analizar.
kind	string: EntityRecognition	El tipo de tarea a realizar.
parameters	EntitiesTaskParameters	Parámetros de la tarea.

AnalyzeTextKeyPhraseExtractionInput

Objeto

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

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

AnalyzeTextLanguageDetectionInput

Objeto

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

Nombre	Tipo	Description
analysisInput	LanguageDetectionAnalysisInput	Documentos a analizar.
kind	string: LanguageDetection	El tipo de tarea a realizar.
parameters	LanguageDetectionTaskParameters	task parámetros.

AnalyzeTextPiiEntitiesRecognitionInput

Objeto

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

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

AnalyzeTextSentimentAnalysisInput

Objeto

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

Nombre	Tipo	Description
analysisInput	MultiLanguageAnalysisInput	Contiene los documentos de entrada.
kind	string: SentimentAnalysis	El tipo de tarea a realizar.
parameters	SentimentAnalysisTaskParameters	Parámetros de la tarea Análisis de sentimientos.

AnalyzeTextTaskKind

Enumeración

El tipo de tareas de análisis de texto admitidas.

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

AnalyzeTextTaskResultsKind

Enumeración

El tipo de objeto de respuesta devuelto por la tarea analyze-text.

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

AreaMetadata

Objeto

Representa el modelo de metadatos de la entidad Area.

Nombre	Tipo	Description
metadataKind	string: AreaMetadata	Tipo de objeto de metadatos de la entidad.
unit	AreaUnit	Unidad de medida para el área.
value	number (double)	Valor numérico que indica el texto extraído.

AreaUnit

Enumeración

Unidad de medida de área.

Valor	Description
Unspecified	Unidad de área no especificada
SquareKilometer	Unidad de área en kilómetros cuadrados
SquareHectometer	Unidad de área en hectómetros cuadrados
SquareDecameter	Unidad de área en decámetros cuadrados
SquareDecimeter	Unidad de área en decímetros cuadrados
SquareMeter	Unidad de área en metros cuadrados
SquareCentimeter	Unidad de área en centímetros cuadrados
SquareMillimeter	Unidad de área en milímetros cuadrados
SquareInch	Unidad de área en pulgadas cuadradas
SquareFoot	Unidad de área en pies cuadrados
SquareMile	Unidad de área en millas cuadradas
SquareYard	Unidad de área en yardas cuadradas
Acre	Unidad de área en acres

CurrencyMetadata

Objeto

Representa el modelo de metadatos de la entidad Currency).

Nombre	Tipo	Description
iso4217	string	El código alfabético basado en otro estándar ISO, ISO 3166, que enumera los códigos de los nombres de país. Las dos primeras letras del código de tres letras ISO 4217 son las mismas que el código del nombre del país y, siempre que sea posible, la tercera letra corresponde a la primera letra del nombre de moneda.
metadataKind	string: CurrencyMetadata	Tipo de objeto de metadatos de la entidad.
unit	string	Unidad monetaria.
value	number (double)	Valor numérico que indica el texto extraído.

DateMetadata

Objeto

A Metadatos para instancias de entidad de fecha.

Nombre	Tipo	Description
dateValues	DateValue[]	Lista de valores de fecha.
metadataKind	string: DateMetadata	Tipo de objeto de metadatos de la entidad.

DateTimeMetadata

Objeto

Metadatos para instancias de entidad de fecha y hora.

Nombre	Tipo	Description
dateValues	DateValue[]	Lista de valores de fecha.
metadataKind	string: DateTimeMetadata	Tipo de objeto de metadatos de la entidad.

DateValue

Objeto

Representa el valor de fecha.

Nombre	Tipo	Description
modifier	TemporalModifier	Modificador para la fecha y hora para indicar el punto de referencia como antes, después, etc.
timex	string	Representación extendida de fecha y hora ISO 8601 como se describe en (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)
value	string	Tiempo real que indica el texto extraído.

DetectedLanguage

Objeto

Contiene los detalles del idioma detectado para el texto.

Nombre	Tipo	Description
confidenceScore	number (double)	Puntuación de confianza entre 0 y 1. Las puntuaciones cercanas a 1 indican 100% certeza de que el idioma identificado es true.
iso6391Name	string	Una representación de 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).
scriptIso15924Code	ScriptCode	Identifica el código de script del documento de entrada según la norma ISO 15924.
scriptName	ScriptKind	Identifica el nombre del script del documento de entrada según la norma ISO 15924.

DocumentError

Objeto

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

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

DocumentSentimentValue

Enumeración

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

Valor	Description
positive	Declaración positiva
neutral	Declaración neutral
negative	Declaración negativa
mixed	Declaración mixta

DocumentStatistics

Objeto

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

Nombre	Tipo	Description
charactersCount	integer (int32)	Número de elementos de texto reconocidos en el documento.
transactionsCount	integer (int32)	Número de transacciones del documento.

DocumentWarning

Objeto

Contiene el objeto warnings con las 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.

EntitiesDocumentResultWithMetadata

Objeto

Los documentos de entidad dan como resultado metadatos.

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

EntitiesResult

Objeto

Contiene el resultado de la tarea de reconocimiento de entidades.

Nombre	Tipo	Description
documents	EntitiesDocumentResultWithMetadata[]	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 se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

EntitiesTaskParameters

Objeto

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

Nombre	Tipo	Valor predeterminado	Description
exclusionList	EntityCategory[]		(Opcional) que filtra las entidades que se incluyen en excludeList. Cuando un usuario especifica un excludeList, no puede obtener una predicción devuelta con una entidad de esa lista. Aplicaremos inclusionList antes de exclusionList
inclusionList	EntityCategory[]		(Opcional) que limita la salida a los tipos de entidad solicitados incluidos en esta lista. Aplicaremos inclusionList antes de exclusionList
inferenceOptions	EntityInferenceOptions		(Opcional) que permite al usuario proporcionar la configuración para ejecutar la inferencia.
loggingOptOut	boolean	False	Exclusión de registro
modelVersion	string	latest	Versión del modelo
overlapPolicy	BaseEntityOverlapPolicy: AllowOverlapEntityPolicyType MatchLongestEntityPolicyType		(Opcional) describe el tipo de política de superposición que se aplicará a la salida ner.
stringIndexType	StringIndexType	TextElements_v8	(Opcional) para proporcionar el tipo de índice de cadena utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es TextElements (Graphemes).

EntitiesTaskResult

Objeto

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

Objeto

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 (double)	Puntuación de confianza entre 0 y 1 de la entidad extraída.
length	integer (int32)	Longitud del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar a la longitud devuelta.
offset	integer (int32)	Posición inicial del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar al desplazamiento devuelto.
subcategory	string	(Opcional) Subtipo de entidad.
text	string	Texto de entidad como aparece en la solicitud.

EntityCategory

Enumeración

Contiene todas las categorías de entidades detectadas por el reconocimiento de entidades.

Valor	Description
Address	Menciones específicas a nivel de calle de ubicaciones: números de casas/edificios, calles, avenidas, carreteras, intersecciones a las que se hace referencia por su nombre.
Numeric	Valores numéricos, incluidos dígitos y palabras numéricas.
Age	Valores relacionados con la edad.
Currency	Valores relacionados con la moneda.
Number	Números sin unidad
NumberRange	Rango de números
Percentage	Valores relacionados con porcentajes.
Ordinal	Números ordinales.
Temperature	Valores relacionados con la temperatura.
Dimension	Dimensión de las medidas
Length	Longitud de un objeto.
Weight	Peso de un objeto.
Height	Altura de un objeto.
Speed	Velocidad de un objeto.
Area	Área de un objeto.
Volume	Volumen de un objeto.
Information	Unidad de medida de la información digital.
Temporal	Elementos relacionados con el tiempo.
Date	Fechas del calendario.
Time	Momentos del día.
DateTime	Calendario fechas con tiempo.
DateRange	Rango de fechas.
TimeRange	Rango de tiempos.
DateTimeRange	Rango de fecha y hora.
Duration	Duración del tiempo.
SetTemporal	Conjunto de valores relacionados con el tiempo.
Event	Eventos sociales, deportivos, empresariales, políticos, educativos, naturales, históricos, criminales, violentos, legales, militares con un período de tiempo.
SportsEvent	Valores relacionados con eventos deportivos.
CulturalEvent	Valores relacionados con eventos culturales.
NaturalEvent	Valores relacionados con eventos naturales.
Location	Punto o lugar particular en el espacio físico.
GPE	Ciudades, países/regiones, estados.
City	Valores relacionados con la ciudad.
State	Valores relacionados con el estado.
CountryRegion	Valores relacionados con el país o la región.
Continent	Valores relacionados con el continente.
Structural	Estructuras hechas por el hombre.
Airport	Aeropuertos.
Geological	Características geográficas y naturales como ríos, océanos y desiertos.
Organization	Corporaciones, agencias y otros grupos de personas definidos por alguna estructura organizativa establecida. Estas etiquetas pueden incluir empresas, partidos/movimientos políticos, bandas musicales, clubes deportivos, organismos gubernamentales y organizaciones públicas. Las nacionalidades o religiones no son ORGANIZACIÓN.
OrganizationMedical	Empresas y grupos médicos.
OrganizationStockExchange	Grupos de bolsa de valores.
OrganizationSports	Organizaciones relacionadas con los deportes.
Person	Nombre, apellido y segundo nombre, nombres de personajes ficticios y alias. Los títulos, como 'Sr.' o 'Presidente', no se consideran parte de la entidad nombrada.
PersonType	Roles humanos clasificados por pertenencia a un grupo.
Email	Direcciones de correo.
URL	Direcciones URL de sitios web.
IP	direcciones IP de red.
PhoneNumber	Números de teléfono (solo números de teléfono de EE. UU y la UE).
Product	Individual o grupo de objetos comerciales, consumibles, electrónicos, vehículos, grupos de alimentos.
ComputingProduct	Productos informáticos.
Skill	Una capacidad, habilidad o experiencia.

EntityInferenceOptions

Objeto

La clase que aloja las opciones de inferencia permitidas para el reconocimiento de entidades con nombre.

Nombre	Tipo	Valor predeterminado	Description
excludeNormalizedValues	boolean	False	Opción para incluir/excluir los valores de entidad detectados que se normalizarán e incluirán en los metadatos. Los tipos de entidad numérica y temporal admiten la normalización de valores.

EntityLinkingResult

Objeto

Resultado de la 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 se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

EntityLinkingTaskParameters

Objeto

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

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

EntityLinkingTaskResult

Objeto

Contiene el texto de análisis Resultado de la tarea de vinculación de entidades.

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

EntityTag

Objeto

Objeto de etiqueta de entidad que contiene el nombre de las etiquetas y cualquier puntuación de confianza asociada. Las etiquetas de entidad se utilizan para expresar algunas similitudes / afinidad entre entidades.

Nombre	Tipo	Description
confidenceScore	number (double)	Puntuación de detección entre 0 y 1 de la entidad extraída.
name	string	Nombre de la etiqueta. Los nombres de las etiquetas de entidad serán únicos a nivel mundial.

EntityWithMetadata

Objeto

Objeto de entidad con etiquetas y metadatos.

Nombre	Tipo	Description
category	string	Tipo de entidad.
confidenceScore	number (double)	Puntuación de confianza entre 0 y 1 de la entidad extraída.
length	integer (int32)	Longitud del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar a la longitud devuelta.
metadata	BaseMetadata: AgeMetadata AreaMetadata CurrencyMetadata DateMetadata DateTimeMetadata InformationMetadata LengthMetadata NumberMetadata NumericRangeMetadata OrdinalMetadata SpeedMetadata TemperatureMetadata TemporalSetMetadata TemporalSpanMetadata TimeMetadata VolumeMetadata WeightMetadata	El objeto de metadatos de entidad.
offset	integer (int32)	Posición inicial del texto de la entidad. El uso de valores 'stringIndexType' diferentes puede afectar al desplazamiento devuelto.
subcategory	string	(Opcional) Subtipo de entidad.
tags	EntityTag[]	Lista de etiquetas de entidad. Las etiquetas deben expresar algunas similitudes / afinidad entre entidades.
text	string	Texto de entidad como aparece en la solicitud.
type	string	Un tipo de entidad es la granularidad más baja (o más fina) en la que se ha detectado la entidad. El tipo se asigna a los atributos de metadatos específicos asociados a la entidad detectada.

Error

Objeto

El objeto de respuesta de error que se devuelve 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

Enumeración

Código de error legible para personas.

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

ErrorResponse

Objeto

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InformationMetadata

Objeto

Representa el modelo de metadatos de la entidad de información (datos).

Nombre	Tipo	Description
metadataKind	string: InformationMetadata	Tipo de objeto de metadatos de la entidad.
unit	InformationUnit	Unidad de medida de la información.
value	number (double)	Valor numérico que indica el texto extraído.

InformationUnit

Enumeración

Unidad de medición de información (datos).

Valor	Description
Unspecified	Unidad de tamaño de datos no especificada
Bit	Unidad de tamaño de datos en bits
Kilobit	Unidad de tamaño de datos en kilobits
Megabit	Unidad de tamaño de datos en megabits
Gigabit	Unidad de tamaño de datos en gigabits
Terabit	Unidad de tamaño de datos en terabits
Petabit	Unidad de tamaño de datos en petabits
Byte	Unidad de tamaño de datos en bytes
Kilobyte	Unidad de tamaño de datos en kilobytes
Megabyte	Unidad de tamaño de datos en megabytes
Gigabyte	Unidad de tamaño de datos en gigabytes
Terabyte	Unidad de tamaño de datos en terabytes
Petabyte	Unidad de tamaño de datos en petabytes

InnerErrorCode

Enumeración

Código de error legible para personas.

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

InnerErrorModel

Objeto

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 un conjunto definido por el servidor de códigos de error.
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

Objeto

Contiene KeyPhraseResult.

Nombre	Tipo	Description
documents	KeyPhrasesDocumentResult[]	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 se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

KeyPhrasesDocumentResult

Objeto

Contiene los resultados de la extracción de frases clave para 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 showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

KeyPhraseTaskParameters

Objeto

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

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	Exclusión de registro
modelVersion	string	latest	Versión del modelo

KeyPhraseTaskResult

Objeto

Contiene el resultado de la tarea de análisis de texto KeyPhraseExtraction.

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

LanguageDetectionAnalysisInput

Objeto

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

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

LanguageDetectionDocumentResult

Objeto

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 showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

LanguageDetectionResult

Objeto

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

Nombre	Tipo	Description
documents	LanguageDetectionDocumentResult[]	Enumeración de los resultados de la detección de idioma para cada documento de entrada.
errors	DocumentError[]	Errores por identificador 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

Objeto

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

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	Exclusión de registro
modelVersion	string	latest	Versión del modelo

LanguageDetectionTaskResult

Objeto

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 la detección de idioma.

LanguageInput

Objeto

Contiene la entrada de detección de idioma.

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

LengthMetadata

Objeto

Representa el modelo de metadatos de la entidad Length.

Nombre	Tipo	Description
metadataKind	string: LengthMetadata	Tipo de objeto de metadatos de la entidad.
unit	LengthUnit	Unidad de medida para la longitud.
value	number (double)	Valor numérico que indica el texto extraído.

LengthUnit

Enumeración

Unidad de medida de longitud.

Valor	Description
Unspecified	Unidad de longitud no especificada.
Kilometer	Unidad de longitud en kilómetros.
Hectometer	Unidad de longitud en hectómetros.
Decameter	Unidad de longitud en decámetros.
Meter	Unidad de longitud en metros.
Decimeter	Unidad de longitud en decímetros.
Centimeter	Unidad de longitud en centímetros.
Millimeter	Unidad de longitud en milímetros.
Micrometer	Unidad de longitud en micrómetros.
Nanometer	Unidad de longitud en nanómetros.
Picometer	Unidad de longitud en picómetros.
Mile	Unidad de longitud en millas.
Yard	Unidad de longitud en yardas.
Inch	Unidad de longitud en pulgadas.
Foot	Unidad de longitud en pies.
LightYear	Unidad de longitud en años luz.
Point	Unidad de longitud en puntos.

LinkedEntitiesDocumentResult

Objeto

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 showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

LinkedEntity

Objeto

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

Nombre	Tipo	Description
bingId	string	Identificador único de Bing Entity Search 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 de 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

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

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

MatchLongestEntityPolicyType

Objeto

Representa la directiva Coincidir con superposición más larga. No se superponen entidades en la medida de lo posible. 1. Si hay entidades superpuestas, se devolverá la más larga. 2. Si el conjunto de caracteres predicho para 2 o más entidades es exactamente el mismo, seleccione la entidad que tenga la puntuación de confianza más alta.3. Si las puntuaciones de entidad son idénticas, devuelva todas las entidades que aún estén presentes después de aplicar las reglas anteriores. 3. Si hay una superposición parcial (como en Hello Text Analytics), siga los pasos anteriores a partir de 1.

Nombre	Tipo	Valor predeterminado	Description
policyKind	string: matchLongest	matchLongest	Tipo de objeto OverlapPolicy de entidad.

MetadataKind

Enumeración

Tipo de objeto de metadatos de la entidad.

Valor	Description
DateMetadata	Metadatos para valores relacionados con la fecha.
DateTimeMetadata	Metadatos para valores relacionados con la fecha y la hora.
TimeMetadata	Metadatos para valores relacionados con el tiempo.
TemporalSetMetadata	Metadatos para un conjunto de valores relacionados con el tiempo.
NumberMetadata	Metadatos para valores numéricos.
OrdinalMetadata	Metadatos para números ordinales.
SpeedMetadata	Metadatos para valores relacionados con la velocidad.
WeightMetadata	Metadatos para valores relacionados con el peso.
LengthMetadata	Metadatos para valores relacionados con la longitud.
VolumeMetadata	Metadatos para valores relacionados con el volumen.
AreaMetadata	Metadatos para valores relacionados con el área.
AgeMetadata	Metadatos para valores relacionados con la edad.
InformationMetadata	Metadatos para valores relacionados con la información.
TemperatureMetadata	Metadatos para valores relacionados con la temperatura.
CurrencyMetadata	Metadatos para valores relacionados con la moneda.
NumericRangeMetadata	Metadatos para valores de rango numérico.
TemporalSpanMetadata	Metadatos para valores de intervalo temporal.

MultiLanguageAnalysisInput

Objeto

Recopilación de documentos de entrada para ser analizados por el servicio.

Nombre	Tipo	Description
documents	MultiLanguageInput[]	Los documentos de entrada a analizar.

MultiLanguageInput

Objeto

Contiene un documento de entrada para que el servicio lo analice.

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. (Lo siguiente solo se aplica a 2023-04-15-preview y superior) Para la detección automática de idioma, use "auto". Si no se establece, use "en" para el inglés como valor predeterminado.
text	string	Texto de entrada que se va a procesar.

NumberKind

Enumeración

Tipo de la entidad numérica extraída.

Valor	Description
Integer	Número entero
Decimal	Número decimal
Power	Número de energía
Fraction	Número de fracción
Percent	Número de porcentaje
Unspecified	Tipo de número no especificado

NumberMetadata

Objeto

Metadatos para instancias de entidades numéricas.

Nombre	Tipo	Description
metadataKind	string: NumberMetadata	Tipo de objeto de metadatos de la entidad.
numberKind	NumberKind	Algo así como el tipo de número.
value	number (double)	Representación numérica de lo que indica el texto extraído.

NumericRangeMetadata

Objeto

representa los metadatos de los intervalos numéricos.

Nombre	Tipo	Description
maximum	number (double)	Valor final del intervalo.
metadataKind	string: NumericRangeMetadata	Tipo de objeto de metadatos de la entidad.
minimum	number (double)	Valor inicial del intervalo.
rangeInclusivity	RangeInclusivity	La inclusividad de esta gama.
rangeKind	RangeKind	Tipo de rangos numéricos admitidos, como Número, Velocidad, etc.

OrdinalMetadata

Objeto

Metadatos para instancias de entidades numéricas.

Nombre	Tipo	Description
metadataKind	string: OrdinalMetadata	Tipo de objeto de metadatos de la entidad.
offset	string	Desplazamiento con respecto a la referencia (por ejemplo, desplazamiento = -1 indica el segundo al último)
relativeTo	RelativeTo	Punto de referencia que indica el número ordinal.
value	string	Expresión aritmética simple que denota el ordinal.

PiiCategory

Enumeración

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

Valor	Description
ABARoutingNumber	Número de ruta ABA
ARNationalIdentityNumber	Número de documento nacional de identidad de la RA
AUBankAccountNumber	Número de cuenta bancaria AT
AUDriversLicenseNumber	Número de licencia de conducir de AU
AUMedicalAccountNumber	Número de cuenta médica de AU
AUPassportNumber	Número de pasaporte de AU
AUTaxFileNumber	Número de archivo de impuestos de AU
AUBusinessNumber	Número de empresa de AU
AUCompanyNumber	Número de empresa de AU
ATIdentityCard	Tarjeta de identidad AT
ATTaxIdentificationNumber	Número de identificación fiscal AT
ATValueAddedTaxNumber	Número de impuesto sobre el valor añadido AT
AzureDocumentDBAuthKey	Clave de autenticación de Azure Document DB
AzureIAASDatabaseConnectionAndSQLString	Conexión de base de datos IAAS de Azure y cadena SQL
AzureIoTConnectionString	Cadena de conexión de Azure IoT
AzurePublishSettingPassword	Contraseña de configuración de publicación de Azure
AzureRedisCacheString	Cadena de caché en Redis de Azure
AzureSAS	SAS de Azure
AzureServiceBusString	Cadena de Azure Service Bus
AzureStorageAccountKey	Clave de la cuenta de Azure Storage
AzureStorageAccountGeneric	Cuenta de Azure Storage genérica
BENationalNumber	Número nacional BE
BENationalNumberV2	Número nacional BE V2
BEValueAddedTaxNumber	Número de impuesto sobre el valor añadido de BE
BRCPFNumber	Número de BR CPF
BRLegalEntityNumber	Número de entidad jurídica de BR
BRNationalIDRG	Documento nacional de identidad de la BR RG
BGUniformCivilNumber	Número civil uniforme BG
CABankAccountNumber	Número de cuenta bancaria de CA
CADriversLicenseNumber	Número de licencia de conducir de CA
CAHealthServiceNumber	Número de servicio de CA Health
CAPassportNumber	Número de pasaporte de CA
CAPersonalHealthIdentification	Identificación personal de salud de CA
CASocialInsuranceNumber	Número de seguro social de CA
CLIdentityCardNumber	Número de documento de identidad CL
CNResidentIdentityCardNumber	Número de tarjeta de identidad de residente de CN
CreditCardNumber	Número de la tarjeta de crédito
HRIdentityCardNumber	Número de tarjeta de identidad de recursos humanos
HRNationalIDNumber	Número de identificación nacional de HR
HRPersonalIdentificationNumber	Número de identificación personal de RRHH
HRPersonalIdentificationOIBNumberV2	Número OIB de identificación personal de RRHH V2
CYIdentityCard	Tarjeta de identidad CY
CYTaxIdentificationNumber	Número de identificación fiscal de CY
CZPersonalIdentityNumber	Número de identidad personal de CZ
CZPersonalIdentityV2	Identidad personal de CZ V2
DKPersonalIdentificationNumber	Número de identificación personal DK
DKPersonalIdentificationV2	Identificación personal DK V2
DrugEnforcementAgencyNumber	Número de la Agencia de Control de Drogas
EEPersonalIdentificationCode	Código de identificación personal EE
EUDebitCardNumber	Número de tarjeta de débito de la UE
EUDriversLicenseNumber	Número de licencia de conducir de la UE
EUGPSCoordinates	Coordenadas GPS de la UE
EUNationalIdentificationNumber	Número de identificación nacional de la UE
EUPassportNumber	Número de pasaporte de la UE
EUSocialSecurityNumber	Número de la Seguridad Social de la UE
EUTaxIdentificationNumber	Número de identificación fiscal de la UE
FIEuropeanHealthNumber	Número sanitario europeo FI
FINationalID	Identificación nacional de FI
FINationalIDV2	Identificación nacional de FI V2
FIPassportNumber	Número de pasaporte FI
FRDriversLicenseNumber	Número de licencia de conducir FR
FRHealthInsuranceNumber	Número de seguro médico FR
FRNationalID	Documento nacional de identidad de FR
FRPassportNumber	Número de pasaporte FR
FRSocialSecurityNumber	Número de Seguro Social FR
FRTaxIdentificationNumber	Número de identificación fiscal de FR
FRValueAddedTaxNumber	Número de impuesto sobre el valor añadido de FR
DEDriversLicenseNumber	Número de licencia de conducir de DE
DEPassportNumber	Número de pasaporte DE
DEIdentityCardNumber	Número de tarjeta de identidad de DE
DETaxIdentificationNumber	Número de identificación fiscal de DE
DEValueAddedNumber	Número de valor agregado de DE
GRNationalIDCard	Tarjeta de identificación nacional GR
GRNationalIDV2	GR Identificación Nacional V2
GRTaxIdentificationNumber	Número de identificación fiscal GR
HKIdentityCardNumber	Número de tarjeta de identidad de HK
HUValueAddedNumber	Número de valor agregado de HU
HUPersonalIdentificationNumber	Número de identificación personal de HU
HUTaxIdentificationNumber	Número de identificación fiscal de HU
INPermanentAccount	IN Cuenta Permanente
INUniqueIdentificationNumber	Número de identificación único de IN
IDIdentityCardNumber	Número de documento de identidad
InternationalBankingAccountNumber	Número de cuenta bancaria internacional
IEPersonalPublicServiceNumber	Número de Servicio Público Personal de IE
IEPersonalPublicServiceNumberV2	Número de servicio público personal de IE V2
ILBankAccountNumber	Número de cuenta bancaria de IL
ILNationalID	Identificación nacional de IL
ITDriversLicenseNumber	Número de licencia de conducir de TI
ITFiscalCode	Código Fiscal de TI
ITValueAddedTaxNumber	Número de impuesto sobre el valor añadido de TI
JPBankAccountNumber	Número de cuenta bancaria de JP
JPDriversLicenseNumber	Número de licencia de conducir de JP
JPPassportNumber	Número de pasaporte JP
JPResidentRegistrationNumber	Número de registro de residente de JP
JPSocialInsuranceNumber	Número de seguro social de JP
JPMyNumberCorporate	JP Mi Número Corporativo
JPMyNumberPersonal	JP Mi número personal
JPResidenceCardNumber	Número de tarjeta de residencia JP
LVPersonalCode	Código personal de LV
LTPersonalCode	Código personal LT
LUNationalIdentificationNumberNatural	Número de identificación nacional de LU Natural
LUNationalIdentificationNumberNonNatural	Número de identificación nacional de LU No natural
MYIdentityCardNumber	Número de documento de identidad de MY
MTIdentityCardNumber	Número de tarjeta de identidad MT
MTTaxIDNumber	Número de identificación fiscal de MT
NLCitizensServiceNumber	Número de Servicio al Ciudadano de NL
NLCitizensServiceNumberV2	Número de Servicio al Ciudadano NL V2
NLTaxIdentificationNumber	Número de identificación fiscal de NL
NLValueAddedTaxNumber	Número de impuesto sobre el valor añadido de los Países Bajos
NZBankAccountNumber	Número de cuenta bancaria de Nueva Zelanda
NZDriversLicenseNumber	Número de licencia de conducir de Nueva Zelanda
NZInlandRevenueNumber	Número de Impuestos Internos de Nueva Zelanda
NZMinistryOfHealthNumber	Número del Ministerio de Salud de Nueva Zelanda
NZSocialWelfareNumber	Número de bienestar social de Nueva Zelanda
NOIdentityNumber	SIN número de identidad
PHUnifiedMultiPurposeIDNumber	Número de identificación multipropósito unificado de PH
PLIdentityCard	Tarjeta de identidad PL
PLNationalID	Identificación nacional de PL
PLNationalIDV2	PL Identificación nacional V2
PLPassportNumber	Número de pasaporte PL
PLTaxIdentificationNumber	Número de identificación fiscal PL
PLREGONNumber	Número PL REGON
PTCitizenCardNumber	Número de tarjeta de ciudadano PT
PTCitizenCardNumberV2	Número de tarjeta de ciudadano PT V2
PTTaxIdentificationNumber	Número de identificación fiscal PT
ROPersonalNumericalCode	Código numérico personal RO
RUPassportNumberDomestic	Número de pasaporte de RU Doméstico
RUPassportNumberInternational	Número de pasaporte RU Internacional
SANationalID	Identificación nacional de SA
SGNationalRegistrationIdentityCardNumber	Número de documento de identidad de registro nacional SG
SKPersonalNumber	Número personal de SK
SITaxIdentificationNumber	Número de identificación fiscal SI
SIUniqueMasterCitizenNumber	Número de ciudadano maestro único SI
ZAIdentificationNumber	Número de identificación ZA
KRResidentRegistrationNumber	Número de registro de residente de KR
ESDNI	ES DNI
ESSocialSecurityNumber	Número de Seguro Social ES
ESTaxIdentificationNumber	Número de identificación fiscal ES
SQLServerConnectionString	Cadena de conexión de SQL Server
SENationalID	SE Identificación Nacional
SENationalIDV2	SE National ID V2
SEPassportNumber	Número de pasaporte SE
SETaxIdentificationNumber	Número de identificación fiscal SE
SWIFTCode	Código SWIFT
CHSocialSecurityNumber	Número de Seguro Social de CH
TWNationalID	Identificación nacional de TW
TWPassportNumber	Número de pasaporte TW
TWResidentCertificate	Certificado de residente de TW
THPopulationIdentificationCode	Código de identificación de población TH
TRNationalIdentificationNumber	Número de identificación nacional de TR
UKDriversLicenseNumber	Número de licencia de conducir del Reino Unido
UKElectoralRollNumber	Número del censo electoral del Reino Unido
UKNationalHealthNumber	Número Nacional de Salud del Reino Unido
UKNationalInsuranceNumber	Número de seguro nacional del Reino Unido
UKUniqueTaxpayerNumber	Número único de contribuyente del Reino Unido
USUKPassportNumber	Número de pasaporte del Reino Unido de EE. UU.
USBankAccountNumber	Número de cuenta bancaria de EE. UU.
USDriversLicenseNumber	Número de licencia de conducir de EE. UU.
USIndividualTaxpayerIdentification	Identificación individual del contribuyente de EE. UU.
USSocialSecurityNumber	Número de seguridad social de EE. UU.
UAPassportNumberDomestic	Número de pasaporte de UA Doméstico
UAPassportNumberInternational	Número de pasaporte internacional de UA
Organization	Organización
Email	Correo Electrónico
URL	URL
Age	Edad
PhoneNumber	Número de teléfono
IPAddress	Dirección IP
Date	Fecha
Person	Persona
Address	Dirección
DateOfBirth	Fecha de nacimiento
BankAccountNumber	Número de cuenta bancaria
PassportNumber	Número de pasaporte
DriversLicenseNumber	Número de licencia de conducir
SortCode	Código de clasificación. Número de 6 dígitos utilizado en el Reino Unido para identificar un banco y una sucursal específicos donde se mantiene una cuenta bancaria
VehicleIdentificationNumber	VIN
All	Todas las categorías de PII.
Default	Categorías de PII predeterminadas para el idioma.

PiiDomain

Enumeración

Dominio para la tarea PII

Valor	Description
phi	Indica que las entidades en el dominio Información de salud personal deben ser censuradas.
none	Indica que no se especifica ningún dominio.

PiiEntitiesDocumentResult

Objeto

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 showStats=true se especificó en la solicitud, este campo contendrá información sobre la carga del documento.
warnings	DocumentWarning[]	Advertencias detectadas al procesar el documento.

PiiResult

Objeto

Contiene el PiiResult.

Nombre	Tipo	Description
documents	PiiEntitiesDocumentResult[]	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 se especificó showStats=true en la solicitud, este campo contendrá información sobre la carga de la solicitud.

PiiTaskParameters

Objeto

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

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

PiiTaskResult

Objeto

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

RangeInclusivity

Enumeración

El rango de inclusión de esta propiedad inmobiliaria.

Valor	Description
NoneInclusive	Sin inclusión
LeftInclusive	Lado izquierdo inclusive
RightInclusive	Lado derecho inclusive
LeftRightInclusive	Ambos lados inclusive

RangeKind

Enumeración

El tipo de entidad de rango de números.

Valor	Description
Number	Rango numérico
Speed	Intervalo de velocidad
Weight	Rango de peso
Length	Intervalo de longitud
Volume	Intervalo de volúmenes
Area	Intervalo de áreas
Age	Intervalo de edad
Information	Intervalo de información
Temperature	Intervalo de temperatura
Currency	Intervalo de moneda

RelativeTo

Enumeración

Punto de referencia que indica el número ordinal.

Valor	Description
Current	Estado o posición actual
End	Estado o posición final
Start	Estado o posición inicial

RequestStatistics

Objeto

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

Nombre	Tipo	Description
documentsCount	integer (int32)	Número de documentos enviados en la solicitud.
erroneousDocumentsCount	integer (int32)	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 (int64)	Número de transacciones de la solicitud.
validDocumentsCount	integer (int32)	Número de documentos válidos. Esto excluye documentos vacíos, de límite de tamaño excesivo o de idiomas no admitidos.

ScriptCode

Enumeración

Identifica el script del documento de entrada. Se asigna al código de script estándar ISO 15924.

Valor	Description
Arab	Código de escritura para el alfabeto árabe.
Armn	Código de escritura para la escritura armenia.
Beng	Código de script para el script bengalí.
Cans	Código de script para el script UnifiedCanadianAboriginalSyllabics.
Cyrl	Código de script para el alfabeto cirílico.
Deva	Código de script para el script devanagari.
Ethi	Código de escritura para la escritura etíope.
Geor	Código de escritura para la escritura georgiana.
Grek	Código de escritura para el alfabeto griego.
Gujr	Código de script para el script gujarati.
Guru	Código de escritura para la escritura Gurmukhi.
Hang	Código de script para el script hangul.
Hani	Código de script para el script HanLiteral.
Hans	Código de script para el script HanSimplificed.
Hant	Código de script para el script HanTraditional.
Hebr	Código de escritura para la escritura hebrea.
Jpan	Código de script para el alfabeto japonés.
Khmr	Código de escritura para la escritura jemer.
Knda	Código de script para el alfabeto kannada.
Laoo	Código de script para el script laosiano.
Latn	Código de escritura para el alfabeto latino.
Mlym	Código de escritura para la escritura malayalam.
Mong	Código de escritura para el alfabeto mongol.
Mtei	Código de script para el script Meitei.
Mymr	Código de script para el script de Myanmar.
Olck	Código de script para el script Santali.
Orya	Código de script para el script Odia.
Sinh	Código de script para el script cingalés.
Shrd	Código de script para el script Sharada.
Taml	Código de script para el alfabeto tamil.
Telu	Código de script para el script telugu.
Thaa	Código de script para el script Thaana.
Thai	Código de escritura para la escritura tailandesa.
Tibt	Código de escritura para la escritura tibetana.

ScriptKind

Enumeración

Identifica el script del documento de entrada. Se asigna al nombre formal de la norma ISO 15924.

Valor	Description
Arabic	Nombre de la escritura para la escritura árabe.
Armenian	Nombre de la escritura para la escritura armenia.
Bangla	Nombre de la escritura para la escritura bengalí.
UnifiedCanadianAboriginalSyllabics	Nombre de script para el script UnifiedCanadianAboriginalSyllabics.
Cyrillic	Nombre de script para el alfabeto cirílico.
Devanagari	Nombre de script para el script devanagari.
Ethiopic	Nombre de la escritura etíope.
Georgian	Nombre de escritura para la escritura georgiana.
Greek	Nombre de la escritura griega.
Gujarati	Nombre de la escritura para la escritura gujarati.
Gurmukhi	Nombre de la escritura para la escritura Gurmukhi.
Hangul	Nombre de script para el script hangul.
HanLiteral	Nombre de script para el script HanLiteral.
HanSimplified	Nombre de script para el script HanSimplificed.
HanTraditional	Nombre de script para el script HanTraditional.
Hebrew	Nombre de escritura para la escritura hebrea.
Japanese	Nombre de la escritura para la escritura japonesa.
Khmer	Nombre de la escritura para la escritura jemer.
Kannada	Nombre de la escritura para la escritura kannada.
Lao	Nombre de script para el script laosiano.
Latin	Nombre de escritura para la escritura latina.
Malayalam	Nombre de la escritura para la escritura malayalam.
Meitei	Nombre de script para el script Meitei.
Mongolian	Nombre de la escritura para la escritura mongola.
Myanmar	Nombre de script para el script de Myanmar.
Odia	Nombre de la escritura para la escritura Odia.
Santali	Nombre de script para el script Santali.
Sharada	Nombre del script Sharada.
Sinhala	Nombre de la escritura cingalés.
Tamil	Nombre de la escritura para la escritura tamil.
Telugu	Nombre del script para el script telugu.
Thaana	Nombre de script para el script Thaana.
Thai	Nombre del alfabeto tailandés.
Tibetan	Nombre de la escritura tibetana.

SentenceAssessment

Objeto

Representa una evaluación de oración y las evaluaciones u 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 (int32)	Longitud del destino.
offset	integer (int32)	Desplazamiento de destino desde el principio de la oración.
sentiment	TokenSentimentValue	El sentimiento de la sentencia.
text	string	Se detectó el texto de destino.

SentenceSentiment

Objeto

El sentimiento de la oración de un documento.

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

SentenceSentimentValue

Enumeración

Opinión predicha para la frase.

Valor	Description
positive	Sentimiento positivo
neutral	Sentimiento neutral
negative	Sentimiento negativo

SentenceTarget

Objeto

Representa un destino de oración y las evaluaciones u 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 (int32)	Longitud del destino.
offset	integer (int32)	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	El sentimiento de la sentencia.
text	string	Se detectó el texto de destino.

SentimentAnalysisTaskParameters

Objeto

Parámetros admitidos para una tarea de análisis de opiniones.

Nombre	Tipo	Valor predeterminado	Description
loggingOptOut	boolean	False	Exclusión de registro
modelVersion	string	latest	Versión del modelo
opinionMining	boolean	False	Si se debe utilizar 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

Objeto

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

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

SentimentDocumentResult

Objeto

Un objeto que representa los resultados del análisis de sentimiento precompilados de cada documento.

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

SentimentResponse

Objeto

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

Nombre	Tipo	Description
documents	SentimentDocumentResult[]	Los resultados del análisis de sentimiento para cada documento de la entrada.
errors	DocumentError[]	Errores por identificador 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

Objeto

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

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

SpeedMetadata

Objeto

Representa el modelo de metadatos de la entidad Velocidad.

Nombre	Tipo	Description
metadataKind	string: SpeedMetadata	Tipo de objeto de metadatos de la entidad.
unit	SpeedUnit	Unidad de medida de la velocidad.
value	number (double)	Valor numérico que indica el texto extraído.

SpeedUnit

Enumeración

Unidad de medida de velocidad

Valor	Description
Unspecified	Unidad de velocidad no especificada.
MetersPerSecond	Unidad de velocidad en metros por segundo.
KilometersPerHour	Unidad de velocidad en kilómetros por hora.
KilometersPerMinute	Unidad de velocidad en kilómetros por minuto.
KilometersPerSecond	Unidad de velocidad en kilómetros por segundo.
MilesPerHour	Unidad de velocidad en millas por hora.
Knots	Unidad de velocidad en nudos.
FeetPerSecond	Unidad de velocidad en pies por segundo.
FeetPerMinute	Unidad de velocidad en pies por minuto.
YardsPerMinute	Unidad de velocidad en yardas por minuto.
YardsPerSecond	Unidad de velocidad en yardas por segundo.
MetersPerMillisecond	Unidad de velocidad en metros por milisegundo.
CentimetersPerMillisecond	Unidad de velocidad en centímetros por milisegundo.
KilometersPerMillisecond	Unidad de velocidad en kilómetros por milisegundo.

StringIndexType

Enumeración

Tipo de índice de cadena

Valor	Description
TextElements_v8	Los valores de desplazamiento y longitud devueltos se corresponden con 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	Los valores de desplazamiento y longitud devueltos se corresponden con 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	Los valores de desplazamiento y longitud devueltos corresponden a 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

Objeto

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

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

TargetRelation

Objeto

Representa la relación entre evaluaciones y/o metas.

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

TargetRelationType

Enumeración

Tipo relacionado con el destino.

Valor	Description
assessment	Relación de evaluación.
target	Relación de destino.

TemperatureMetadata

Objeto

Representa el modelo de metadatos de la entidad de información.

Nombre	Tipo	Description
metadataKind	string: TemperatureMetadata	Tipo de objeto de metadatos de la entidad.
unit	TemperatureUnit	Unidad de medida de la temperatura.
value	number (double)	Valor numérico que indica el texto extraído.

TemperatureUnit

Enumeración

Unidad de medición de temperatura.

Valor	Description
Unspecified	Unidad de temperatura no especificada
Fahrenheit	Unidad de temperatura en Fahrenheit
Kelvin	Unidad de temperatura en Kelvin
Rankine	Unidad de temperatura en Rankine
Celsius	Unidad de temperatura en grados Celsius

TemporalModifier

Enumeración

Un modificador opcional de una instancia de fecha y hora.

Valor	Description
AfterApprox	Después de un tiempo aproximado
Before	Antes de una hora específica
BeforeStart	Antes del inicio de un período de tiempo
Approx	Aproximadamente en un momento específico
ReferenceUndefined	Referencia a un tiempo indefinido
SinceEnd	Desde el final de un período de tiempo
AfterMid	Después de la mitad de un período de tiempo
Start	Al comienzo de un período de tiempo
After	Después de un tiempo específico
BeforeEnd	Antes del final de un período de tiempo
Until	Hasta un momento específico
End	Al final de un período de tiempo
Less	Menos de un tiempo específico
Since	Desde un tiempo específico
AfterStart	Después del inicio de un período de tiempo
BeforeApprox	Antes de un tiempo aproximado
Mid	En medio de un período de tiempo
More	Más que un tiempo específico

TemporalSetMetadata

Objeto

A Metadatos para instancias de entidad de conjunto temporal.

Nombre	Tipo	Description
dateValues	DateValue[]	Lista de valores de fecha.
metadataKind	string: TemporalSetMetadata	Tipo de objeto de metadatos de la entidad.

TemporalSpanMetadata

Objeto

representa los metadatos de un intervalo de fecha o tiempo.

Nombre	Tipo	Description
metadataKind	string: TemporalSpanMetadata	Tipo de objeto de metadatos de la entidad.
spanValues	TemporalSpanValues[]	Lista de intervalos temporales detectados.

TemporalSpanValues

Objeto

Objeto de intervalo temporal.

Nombre	Tipo	Description
begin	string	Valor inicial para el intervalo.
duration	string	Valor de duración opcional con formato basado en iso 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)
end	string	Valor final del intervalo.
modifier	TemporalModifier	Modificador para la fecha y hora para indicar el punto de referencia como antes, después, etc.
timex	string	Un triplete opcional que contiene el principio, el final y la duración indicados como cadenas con formato ISO 8601.

TimeMetadata

Objeto

Metadatos para instancias de entidad de tiempo.

Nombre	Tipo	Description
dateValues	DateValue[]	Lista de valores de fecha.
metadataKind	string: TimeMetadata	Tipo de objeto de metadatos de la entidad.

TokenSentimentValue

Enumeración

Opinión predicha para la frase.

Valor	Description
positive	Sentimiento positivo
mixed	Sentimiento mixto
negative	Sentimiento negativo

VolumeMetadata

Objeto

Representa el modelo de metadatos de la entidad de volumen.

Nombre	Tipo	Description
metadataKind	string: VolumeMetadata	Tipo de objeto de metadatos de la entidad.
unit	VolumeUnit	Unidad de medida para el volumen.
value	number (double)	Valor numérico que indica el texto extraído.

VolumeUnit

Enumeración

Unidad de volumen de medida

Valor	Description
Unspecified	Unidad de volumen no especificada.
CubicMeter	Unidad de volumen en metros cúbicos.
CubicCentimeter	Unidad de volumen en centímetros cúbicos.
CubicMillimeter	Unidad de volumen en milímetros cúbicos.
Hectoliter	Unidad de volumen en hectoliters.
Decaliter	Unidad de volumen en descalificadores.
Liter	Unidad de volumen en litros.
Centiliter	Unidad de volumen en centilitros.
Milliliter	Unidad de volumen en mililitros.
CubicYard	Unidad de volumen en patios cúbicos.
CubicInch	Unidad de volumen en pulgadas cúbicas.
CubicFoot	Unidad de volumen en pies cúbicos.
CubicMile	Unidad de volumen en millas cúbicas.
FluidOunce	Unidad de volumen en onzas fluidas.
Teaspoon	Unidad de volumen en cucharas.
Tablespoon	Unidad de volumen en cucharadas.
Pint	Unidad de volumen en pints.
Quart	Unidad de volumen en cuartos.
Cup	Unidad de volumen en tazas.
Gill	Unidad de volumen en gilles.
Pinch	Unidad de volumen en pellizcos.
FluidDram	Unidad de volumen en drams fluidos.
Barrel	Unidad de volumen en barricas.
Minim	Unidad de volumen en minim.
Cord	Unidad de volumen en cables.
Peck	Unidad de volumen en cuellos.
Bushel	Unidad de volumen en carretes.
Hogshead	Unidad de volumen en hogsheads.

WarningCodeValue

Enumeración

Define la lista de códigos de advertencia.

Valor	Description
LongWordsInDocument	Palabras largas en la advertencia del documento
DocumentTruncated	Aviso de documento truncado

WeightMetadata

Objeto

Representa el modelo de metadatos de la entidad Peso.

Nombre	Tipo	Description
metadataKind	string: WeightMetadata	Tipo de objeto de metadatos de la entidad.
unit	WeightUnit	Unidad de medida para el peso.
value	number (double)	Valor numérico que indica el texto extraído.

WeightUnit

Enumeración

Unidad de medida de peso.

Valor	Description
Unspecified	Unidad de peso no especificada
Kilogram	Unidad de peso en kilogramos
Gram	Unidad de peso en gramos
Milligram	Unidad de peso en miligramos
Gallon	Unidad de volumen en galones
MetricTon	Unidad de peso en toneladas métricas
Ton	Unidad de peso en toneladas
Pound	Unidad de peso en libras
Ounce	Unidad de peso en onzas
Grain	Unidad de peso en granos
PennyWeight	Unidad de peso en pennyweights
LongTonBritish	Unidad de peso en toneladas largas (británicas)
ShortTonUS	Unidad de peso en toneladas cortas (EE. UU.)
ShortHundredWeightUS	Unidad de peso en cien pesos cortos (EE. UU.)
Stone	Unidad de peso en piedras
Dram	Unidad de peso en drams