Compartir a través de


API pregenerada

La API precompilada de respuesta a preguntas personalizada proporciona la capacidad de responder a preguntas basadas en un pasaje de texto sin tener que crear proyectos, mantener pares de preguntas y respuestas, o incurrir en costos de infraestructura infrautilizada. Esta funcionalidad se proporciona como una API y se puede usar para satisfacer las necesidades de preguntas y respuestas sin tener que obtener información sobre la respuesta a preguntas personalizada.

Dada una consulta de usuario y un bloque de texto o fragmento, la API devolverá una respuesta y una respuesta precisa (si está disponible).

Ejemplo de uso de API

Imagine que tiene uno o varios bloques de texto de los que le gustaría obtener las respuestas a una pregunta determinada. Normalmente, habría tenido que crear tantos orígenes como número de bloques de texto. Sin embargo, ahora con la API precompilada puede consultar los bloques de texto sin tener que definir orígenes de contenido en un proyecto.

A continuación se indican otros escenarios en los que se puede usar esta API:

  • Está desarrollando una aplicación de lector de libros electrónicos para usuarios finales que les permite resaltar texto, escribir una pregunta y encontrar respuestas en un pasaje de texto resaltado.
  • Una extensión del navegador permite a los usuarios hacer una pregunta sobre el contenido que se muestra actualmente en la página del navegador.
  • Un bot de mantenimiento recibe las consultas de los usuarios y proporciona respuestas basadas en el contenido médico que el bot identifica como más pertinente para la consulta del usuario.

A continuación se muestra un ejemplo de una solicitud:

Solicitud de ejemplo

POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/language/:query-text

Consulta de ejemplo sobre un único bloque de texto

Cuerpo de la solicitud

{
  "parameters": {
    "Endpoint": "{Endpoint}",
    "Ocp-Apim-Subscription-Key": "{API key}",
    "Content-Type": "application/json",
    "api-version": "2021-10-01",
    "stringIndexType": "TextElements_v8",
    "textQueryOptions": {
      "question": "how long it takes to charge surface?",
      "records": [
        {
          "id": "1",
          "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
        },
        {
          "id": "2",
          "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface."
        }
      ],
      "language": "en"
    }
  }
}

Respuesta de muestra

En el cuerpo de la solicitud anterior, se consulta sobre un único bloque de texto. A continuación se muestra una respuesta de ejemplo recibida para la consulta anterior.

{
"responses": {
    "200": {
      "headers": {},
      "body": {
        "answers": [
          {
            "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
            "confidenceScore": 0.93,
            "id": "1",
            "answerSpan": {
              "text": "two to four hours",
              "confidenceScore": 0,
              "offset": 28,
              "length": 45
            },
            "offset": 0,
            "length": 224
          },
          {
            "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
            "confidenceScore": 0.92,
            "id": "1",
            "answerSpan": {
              "text": "two to four hours",
              "confidenceScore": 0,
              "offset": 8,
              "length": 25
            },
            "offset": 20,
            "length": 224
          },
          {
            "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
            "confidenceScore": 0.05,
            "id": "1",
            "answerSpan": null,
            "offset": 110,
            "length": 244
          }
        ]
      }
    }
  }

Vemos que se reciben varias respuestas como parte de la respuesta global de la API. Cada respuesta tiene una puntuación de confianza específica que ayuda a comprender su relevancia general. El intervalo de respuestas representa si también se detectó una posible respuesta corta. Los usuarios pueden usar esta puntuación de confianza para determinar qué respuestas proporcionar en respuesta a la consulta.

Límites de la API precompilada

Límites de llamadas API

Si necesita usar documentos con un tamaño superior al límite permitido, puede dividir el texto en fragmentos más pequeños antes de enviarlos a la API. En este contexto, un documento es una cadena única definida de caracteres de texto.

Estos números representan los límites de cada llamada API individual:

  • Número de documentos: 5.
  • Tamaño máximo de un solo documento: 5120 caracteres.
  • Máximo de tres respuestas por documento.

Códigos de idioma admitidos

La API precompilada admite los siguientes códigos de idioma. Estos códigos de idioma se ajustan al estándar de códigos ISO 639-1.

Código de lenguaje Idioma
af Afrikáans
am Amárico
ar Árabe
as Asamés
az Azerbaiyano
ba Bashkir
be Bielorruso
bg Búlgaro
bn Bengalí
ca Catalán, valenciano
ckb Kurdo central
cs Checo
cy Galés
da Danés
de Alemán
el Griego (moderno) (1453–)
en Inglés
eo Esperanto
es Español, castellano
et Estonio
eu Vasco
fa Persa
fi Finés
fr Francés
ga Irlandés
gl Gallego
gu Gujarati
he Hebreo
hi Hindi
h Croata
hu Húngaro
hy Armenio
id Indonesio
is Islandés
it Italiano
ja Japonés
ka Georgiano
kk Kazajo
km Camboyano
kn Canarés
ko Coreano
ky Kirghiz, Kyrgyz
la Latín
lo Lao
lt Lituano
lv Letón
mk Macedonio
ml Malayalam
mn Mongol
mr Maratí
ms Malayo
mt Maltés
my Birmano
ne Nepalí
nl Neerlandés, flamenco
nn Noruego nynorsk
No Noruego
o Odia
pa Punyabí, panjabi
pl Polaco
ps Pastún
pt Portugués
ro Rumano
ru Ruso
sa Sánscrito
sd Sindhi
si Cingalés
sk Eslovaco
sl Esloveno
sq Albanés
sr Serbio
sv Sueco
sw Swahili
ta Tamil
te Telugu
tg Tayiko
th Tailandés
tl Tagalo
tr Turco
tt Tatar
ug Uighur, Uyghur
uk Ucraniano
ur Urdu
uz Uzbeko
vi Vietnamita
yi Yidis
zh Chino

Referencia de la API precompilada

Visite la documentación completa de ejemplos de la API precompilada para conocer los parámetros de entrada y salida necesarios para llamar a la API.