Cómo llamar a la API REST de Text AnalyticsHow to call the Text Analytics REST API

Las llamadas a Text Analytics API son llamadas HTTP POST o GET, que se pueden formular en cualquier lenguaje.Calls to the Text Analytics API are HTTP POST/GET calls, which you can formulate in any language. En este artículo, se usan REST y Postman para demostrar los conceptos clave.In this article, we use REST and Postman to demonstrate key concepts.

Cada solicitud debe incluir la clave de acceso y un punto de conexión HTTP.Each request must include your access key and an HTTP endpoint. El punto de conexión especifica la región seleccionada durante el registro, la dirección URL del servicio y un recurso que se usa en la solicitud: sentiment, keyphrases, languages y entities.The endpoint specifies the region you chose during sign up, the service URL, and a resource used on the request: sentiment, keyphrases, languages, and entities.

Recuerde que Text Analytics no tiene estado, por lo que no hay ningún recurso de datos para administrar.Recall that Text Analytics is stateless so there are no data assets to manage. El texto se carga, se analiza tras la recepción, y los resultados se devuelven inmediatamente a la aplicación que realiza la llamada.Your text is uploaded, analyzed upon receipt, and results are returned immediately to the calling application.

Sugerencia

Para obtener documentación técnica detallada de la API y verla en acción, use los vínculos siguientes.For detailed API technical documentation and to see it in action, use the following links. También puede enviar solicitudes POST desde la consola de prueba de la API integrada.You can also send POST requests from the built-in API test console. No se requiere ninguna configuración, simplemente pegue la clave del recurso y los documentos JSON en la solicitud:No setup is required, simply paste your resource key and JSON documents into the request:

PrerequisitesPrerequisites

Una clave y un punto de conexión para un recurso de Text Analytics.A key and endpoint for a Text Analytics resource. Los servicios de Azure Cognitive Services se representan por medio de recursos de Azure a los que se suscribe.Azure Cognitive Services are represented by Azure resources that you subscribe to. Cree un recurso para Text Analytics mediante Azure Portal o la CLI de Azure en la máquina local.Create a resource for Text Analytics using the Azure portal or Azure CLI on your local machine. También puede:You can also:

Definición de esquema JSONJSON schema definition

La entrada debe ser JSON en texto no estructurado sin formato.Input must be JSON in raw unstructured text. XML no se admite.XML is not supported. El esquema es sencillo y consta de los elementos descritos en la lista siguiente.The schema is simple, consisting of the elements described in the following list.

Actualmente puede enviar los mismos documentos para todas las operaciones de Text Analytics: opiniones, frases clave, detección de idioma e identificación de la entidad.You can currently submit the same documents for all Text Analytics operations: sentiment, key phrase, language detection, and entity identification. (Es probable que el esquema varíe para cada análisis en el futuro).(The schema is likely to vary for each analysis in the future.)

ElementoElement Valores válidosValid values ¿Necesario?Required? UsoUsage
id El tipo de datos es una cadena, pero en la práctica, los identificadores de documento tienden a ser números enteros.The data type is string, but in practice document IDs tend to be integers. ObligatorioRequired El sistema usa los identificadores que proporcione para estructurar la salida.The system uses the IDs you provide to structure the output. Se generan códigos de idioma, frases clave y puntuaciones de opinión para cada identificador de la solicitud.Language codes, key phrases, and sentiment scores are generated for each ID in the request.
text Texto sin formato no estructurado, hasta 5120 caracteres.Unstructured raw text, up to 5,120 characters. ObligatorioRequired Para la detección de idioma, el texto se puede expresar en cualquier idioma.For language detection, text can be expressed in any language. Para el análisis de opiniones, la extracción de frases clave y la identificación de entidades, el texto debe estar en un idioma admitido.For sentiment analysis, key phrase extraction and entity identification, the text must be in a supported language.
language Código ISO 639-1 de dos caracteres para un idioma admitido2-character ISO 639-1 code for a supported language VaríaVaries Análisis de opiniones, extracción de frases clave, detección de idioma y vinculación de entidades; opcional para la detección de idioma.Required for sentiment analysis, key phrase extraction, and entity linking; optional for language detection. No hay ningún error si se excluye, pero sin él se debilita el análisis.There is no error if you exclude it, but the analysis is weakened without it. El código de idioma se debe corresponder al text que proporcione.The language code should correspond to the text you provide.

Para obtener más información sobre los límites, vea Información general de Text Analytics > Límites de datos.For more information about limits, see Text Analytics Overview > Data limits.

Configuración de una solicitud en PostmanSet up a request in Postman

El servicio acepta solicitudes de hasta 1 MB de tamaño.The service accepts request up to 1 MB in size. Si usa Postman (u otra herramienta de prueba de API web), configure el punto de conexión para incluir el recurso que quiera usar, y proporcione la clave de acceso en un encabezado de solicitud.If you are using Postman (or another Web API test tool), set up the endpoint to include the resource you want to use, and provide the access key in a request header. Cada operación requiere que anexe el recurso apropiado para el punto de conexión.Each operation requires that you append the appropriate resource to the endpoint.

  1. En Postman:In Postman:

    • Elija Post como el tipo de solicitud.Choose Post as the request type.
    • Pegue el punto de conexión que copió de la página del portal.Paste in the endpoint you copied from the portal page.
    • Anexe un recurso.Append a resource.

    Los puntos de conexión de recursos son los siguientes (la región puede variar):Resource endpoints are as follows (your region may vary):

    • https://westus.api.cognitive.microsoft.com/text/analytics/v2.1/sentiment
    • https://westus.api.cognitive.microsoft.com/text/analytics/v2.1/keyPhrases
    • https://westus.api.cognitive.microsoft.com/text/analytics/v2.1/languages
    • https://westus.api.cognitive.microsoft.com/text/analytics/v2.1/entities
  2. Establezca los tres encabezados de solicitud:Set the three request headers:

    • Ocp-Apim-Subscription-Key: la clave de acceso obtenida de Azure Portal.Ocp-Apim-Subscription-Key: your access key, obtained from Azure portal.
    • Content-Type: application/json.Content-Type: application/json.
    • Accept: application/json.Accept: application/json.

    La solicitud debe ser similar a la captura de pantalla siguiente, en la que se asume un recurso /keyPhrases.Your request should look similar to the following screenshot, assuming a /keyPhrases resource.

    Captura de pantalla de solicitud con el punto de conexión y los encabezados

  3. Haga clic en Body (Cuerpo) y elija raw (sin formato) para el formato.Click Body and choose raw for the format.

    Captura de pantalla de la solicitud con la configuración del cuerpo

  4. Pegue algunos documentos JSON en un formato válido para el análisis previsto.Paste in some JSON documents in a format that is valid for the intended analysis. Para obtener más información sobre un análisis determinado, vea los temas siguientes:For more information about a particular analysis, see the topics below:

  1. Haga clic en Send (Enviar) para enviar la solicitud.Click Send to submit the request. Consulte la sección sobre límites de datos de la introducción para obtener información sobre el número de solicitudes que puede enviar por minuto y segundo.See the data limits section in the overview for information on the number of requests you can send per minute and second.

    En Postman, la respuesta se muestra en la ventana siguiente, como un solo documento JSON, con un elemento para cada identificador de documento proporcionado en la solicitud.In Postman, the response is displayed in the next window down, as a single JSON document, with an item for each document ID provided in the request.

Consulte tambiénSee also

Introducción a Text AnalyticsText Analytics Overview
Preguntas más frecuentesFrequently asked questions (FAQ)

Pasos siguientesNext steps