Question Answering - Get Answers From Text

Referencia

Servicio:: Azure AI Services

Versión de la API:: 2021-10-01

Responde a la pregunta especificada mediante el texto proporcionado en el cuerpo.

POST {Endpoint}/language/:query-text?api-version=2021-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versión de la API de cliente.

Encabezado de la solicitud

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

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
question	True	string	Pregunta del usuario para consultar los registros de texto especificados.
records	True	TextDocument[]	Registros de texto que se van a buscar en una pregunta determinada.
language		string	Idioma de los registros de texto. Esta es la representación BCP-47 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.
stringIndexType		StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es Text Elements (Graphemes) según Unicode v8.0.0. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.

Respuestas

Nombre	Tipo	Description
200 OK	AnswersFromTextResult	Respuesta correcta para obtener respuestas del texto de entrada.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:query-text?api-version=2021-10-01


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

status code:: 200

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

Definiciones

Nombre	Description
AnswersFromTextOptions	Parámetros de pregunta y registro de texto que se van a responder.
AnswersFromTextResult	Representa los resultados de la respuesta.
AnswerSpan	Objeto de intervalo de respuestas de QnA.
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
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.
StringIndexType	Especifica el método utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es Text Elements (Graphemes) según Unicode v8.0.0. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.
TextAnswer	Representa el resultado de la respuesta.
TextDocument	Representa el registro de texto de entrada que se va a consultar.

AnswersFromTextOptions

Object

Parámetros de pregunta y registro de texto que se van a responder.

Nombre	Tipo	Valor predeterminado	Description
language	string		Idioma de los registros de texto. Esta es la representación BCP-47 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.
question	string		Pregunta del usuario para consultar los registros de texto especificados.
records	TextDocument[]		Registros de texto que se van a buscar en una pregunta determinada.
stringIndexType	StringIndexType	TextElements_v8	Especifica el método utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es Text Elements (Graphemes) según Unicode v8.0.0. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Object

Representa los resultados de la respuesta.

Nombre	Tipo	Description
answers	TextAnswer[]	Representa los resultados de la respuesta.

AnswerSpan

Object

Objeto de intervalo de respuestas de QnA.

Nombre	Tipo	Description
confidenceScore	number (double) minimum: 0 maximum: 1	Puntuación de predicción del intervalo de respuestas, intervalos de valor comprendidos entre 0 y 1.
length	integer (int32)	Longitud del intervalo de respuesta.
offset	integer (int32)	Desplazamiento del intervalo de respuesta desde el inicio de la respuesta.
text	string	Texto previsto del intervalo de respuestas.

Error

Object

Objeto de error.

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
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

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.

StringIndexType

Enumeración

Especifica el método utilizado para interpretar los desplazamientos de cadena. El valor predeterminado es Text Elements (Graphemes) según Unicode v8.0.0. Para obtener más información, consulte https://aka.ms/text-analytics-offsets.

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.

TextAnswer

Object

Representa el resultado de la respuesta.

Nombre	Tipo	Description
answer	string	Respuesta.
answerSpan	AnswerSpan	Responder al objeto span con respecto a la pregunta del usuario.
confidenceScore	number (double) minimum: 0 maximum: 1	puntuación de confianza de respuesta, el valor oscila entre 0 y 1.
id	string	id. de registro.
length	integer (int32)	Longitud de la oración.
offset	integer (int32)	Desplazamiento de oraciones desde el principio del documento.

TextDocument

Object

Representa el registro de texto de entrada que se va a consultar.

Nombre	Tipo	Description
id	string	Identificador único del registro de texto.
text	string	Contenido del texto del registro.

Compartir a través de

Question Answering - Get Answers From Text

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Recursos adicionales