Question Answering - Get Answers From Text

Ссылка

Служба:: Azure AI Services

Версия API:: 2021-10-01

Отвечает на указанный вопрос с помощью предоставленного текста в тексте.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
Endpoint	path	True	string	Поддерживаемая конечная точка Cognitive Services (например, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Версия КЛИЕНТСКОго API.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Ocp-Apim-Subscription-Key	True	string

Текст запроса

Имя	Обязательно	Тип	Описание
question	True	string	Запрос пользователя к заданным текстовым записям.
records	True	TextDocument[]	Текстовые записи для поиска заданного вопроса.
language		string	Язык текстовых записей. Это представление языка BCP-47. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.
stringIndexType		StringIndexType	Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.

Ответы

Имя	Тип	Описание
200 OK	AnswersFromTextResult	Успешный ответ для получения ответов из входного текста.
Other Status Codes	ErrorResponse	Ответ на ошибку.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Successful query

Образец запроса

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

Пример ответа

Код состояния:: 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
    }
  ]
}

Определения

Имя	Описание
AnswersFromTextOptions	Параметры записи вопросов и текста для ответа.
AnswersFromTextResult	Представляет результаты ответа.
AnswerSpan	Объект диапазона ответов QnA.
Error	Объект ошибки.
ErrorCode	Код ошибки, доступный для чтения человеком.
ErrorResponse	Ответ на ошибку.
InnerErrorCode	Код ошибки, доступный для чтения человеком.
InnerErrorModel	Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.
TextAnswer	Представляет результат ответа.
TextDocument	Представляет входную текстовую запись для запроса.

AnswersFromTextOptions

Object

Параметры записи вопросов и текста для ответа.

Имя	Тип	Default value	Описание
language	string		Язык текстовых записей. Это представление языка BCP-47. Например, используйте "en" для английского языка; "es" для испанского и т. д. Если не задано, используйте en для английского языка по умолчанию.
question	string		Запрос пользователя к заданным текстовым записям.
records	TextDocument[]		Текстовые записи для поиска заданного вопроса.
stringIndexType	StringIndexType	TextElements_v8	Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Object

Представляет результаты ответа.

Имя	Тип	Описание
answers	TextAnswer[]	Представляет результаты ответа.

AnswerSpan

Object

Объект диапазона ответов QnA.

Имя	Тип	Описание
confidenceScore	number (double) minimum: 0 maximum: 1	Прогнозируемая оценка диапазона ответов, диапазон значений составляет от 0 до 1.
length	integer (int32)	Длина диапазона ответа.
offset	integer (int32)	Смещение диапазона ответа от начала ответа.
text	string	Прогнозируемый текст диапазона ответов.

Error

Object

Объект ошибки.

Имя	Тип	Описание
code	ErrorCode	Один из определяемых сервером кодов ошибок.
details	Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

ErrorCode

Перечисление

Код ошибки, доступный для чтения человеком.

Значение	Описание
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Ответ на ошибку.

Имя	Тип	Описание
error	Error	Объект ошибки.

InnerErrorCode

Перечисление

Код ошибки, доступный для чтения человеком.

Значение	Описание
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Объект, содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по API Microsoft One — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Имя	Тип	Описание
code	InnerErrorCode	Один из определяемых сервером кодов ошибок.
details	object	Сведения об ошибке.
innererror	InnerErrorModel	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

StringIndexType

Перечисление

Задает метод, используемый для интерпретации смещения строк. По умолчанию текстовые элементы (Graphemes) соответствуют Юникоду версии 8.0.0. Дополнительные сведения см. в https://aka.ms/text-analytics-offsets.

Значение	Описание
TextElements_v8	Возвращаемые значения смещения и длины будут соответствовать TextElements (кластерам Graphemes и Grapheme), подтверждающим стандарту Юникод 8.0.0. Используйте этот параметр, если приложение написано в .Net Framework или .Net Core, и вы будете использовать StringInfo.
UnicodeCodePoint	Возвращаемые значения смещения и длины будут соответствовать точкам кода Юникода. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Python.
Utf16CodeUnit	Возвращаемые значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.

TextAnswer

Object

Представляет результат ответа.

Имя	Тип	Описание
answer	string	Ответ.
answerSpan	AnswerSpan	Объект диапазона ответов относительно вопроса пользователя.
confidenceScore	number (double) minimum: 0 maximum: 1	оценка достоверности ответов, значение диапазонов от 0 до 1.
id	string	идентификатор записи.
length	integer (int32)	Длина предложения.
offset	integer (int32)	Смещение предложения от начала документа.

TextDocument

Object

Представляет входную текстовую запись для запроса.

Имя	Тип	Описание
id	string	Уникальный идентификатор записи текста.
text	string	Текстовое содержимое записи.

Поделиться через

Question Answering - Get Answers From Text

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

Примеры

Successful query

Образец запроса

Пример ответа

Определения

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Дополнительные ресурсы