Question Answering - Get Answers From Text

Referencia

Servicio:: Cognitive Services - Language

Versión de la API:: 2023-04-01

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

POST {Endpoint}/language/:query-text?api-version=2023-04-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 API del cliente.

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 en los que se va a buscar una pregunta determinada.
language		string	Idioma de los registros de texto. Se trata de una 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 más información, vea https://aka.ms/text-analytics-offsets.

Respuestas

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

Seguridad

AADToken

Estos son los flujos de OAuth2 de Azure Active Directory . Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Notas

Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps.

Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Azure Active Directory. * El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST. * El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.

Actualmente, Azure Active Directory v1.0 o v2.0 admite Cuentas profesionales, educativas e invitados, pero no admite cuentas personales.

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

Ámbitos

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

Ocp-Apim-Subscription-Key

Una clave de suscripción para un recurso de servicio de lenguaje.

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

POST {Endpoint}/language/:query-text?api-version=2023-04-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 registro de preguntas y 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.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
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 más información, vea 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

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

Nombre	Tipo	Valor predeterminado	Description
language	string		Idioma de los registros de texto. Se trata de una 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 en los que se va a buscar 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 más información, vea https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Representa los resultados de la respuesta.

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

AnswerSpan

Objeto de intervalo de respuestas de QnA.

Nombre	Tipo	Description
confidenceScore	number	Puntuación de predicción del intervalo de respuestas, intervalos de valor de 0 a 1.
length	integer	Longitud del intervalo de respuesta.
offset	integer	Desplazamiento del intervalo de respuesta desde el principio de la respuesta.
text	string	Texto previsto del intervalo de respuestas.

Error

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de los conjuntos de códigos de error definidos por el servidor.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Código de error legible.

Nombre	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de los conjuntos de códigos de error definidos por el servidor.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

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 más información, vea https://aka.ms/text-analytics-offsets.

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

TextAnswer

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	puntuación de confianza de respuesta, el valor oscila entre 0 y 1.
id	string	id. de registro.
length	integer	Longitud de la oración.
offset	integer	Desplazamiento de oraciones desde el principio del documento.

TextDocument

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

Cuerpo de la solicitud

Respuestas

Seguridad

AADToken

Notas

Ámbitos

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