Question Answering - Get Answers From Text

Ссылка

Служба:: Cognitive Services - Language

Версия API:: 2023-04-01

Отвечает на указанный вопрос, используя предоставленный текст в тексте.

POST {Endpoint}/language/:query-text?api-version=2023-04-01

Параметры URI

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

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

Имя	Обязательно	Тип	Описание
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	Ответ об ошибке.

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

AADToken

Это потоки OAuth2 Azure Active Directory . При связывании с управлением доступом на основе ролей Azure его можно использовать для управления доступом к Azure Maps REST API. Элементы управления доступом на основе ролей Azure используются для назначения доступа к одной или нескольким учетным записям Azure Maps ресурсов или вложенным ресурсам. Любому пользователю, группе или субъекту-службе можно предоставить доступ через встроенную роль или пользовательскую роль, состоящую из одного или нескольких разрешений на Azure Maps REST API.

Для реализации сценариев рекомендуется ознакомиться с основными понятиями проверки подлинности. Таким образом, это определение безопасности предоставляет решение для моделирования приложений с помощью объектов, способных управлять доступом к определенным API и областям.

Примечания

Это определение безопасности требует использования заголовкаx-ms-client-id, чтобы указать, к какому Azure Maps ресурсу приложение запрашивает доступ. Его можно получить из API управления Картами.

Объект Authorization URL предназначен для экземпляра общедоступного облака Azure. Национальные облака имеют уникальные URL-адреса авторизации и конфигурации Azure Active Directory. * Управление доступом на основе ролей Azure настраивается из плоскости управления Azure с помощью портал Azure, PowerShell, CLI, пакетов SDK для Azure или REST API. * Использование веб-пакета SDK для Azure Maps позволяет настраивать приложение на основе конфигурации для нескольких вариантов использования.

В настоящее время Azure Active Directory версии 1.0 или 2.0 поддерживает рабочие, учебные заведения и гостей, но не поддерживает личные учетные записи.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Ключ подписки для ресурса языковой службы.

Тип: apiKey
В: header

Примеры

Successful query

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

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

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

Код состояния:: 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	Объект answer span объекта 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

Параметры вопросов и текстовых записей, на которые нужно ответить.

Имя	Тип	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

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

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

AnswerSpan

Объект answer span объекта QnA.

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

Error

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

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

ErrorCode

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

Имя	Тип	Описание
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

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

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

InnerErrorCode

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

Имя	Тип	Описание
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

Объект , содержащий более конкретные сведения об ошибке. В соответствии с рекомендациями по 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	string	Возвращаемые значения смещения и длины будут соответствовать textElements (кластеры Graphemes и Grapheme), подтверждающие стандарт Юникода 8.0.0. Используйте этот параметр, если приложение написано на платформе .NET Framework или .Net Core и вы будете использовать StringInfo.
UnicodeCodePoint	string	Возвращаемые значения смещения и длины будут соответствовать кодовой точке Юникода. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Python.
Utf16CodeUnit	string	Возвращаемые значения смещения и длины будут соответствовать единицам кода UTF-16. Используйте этот параметр, если приложение написано на языке, поддерживающем Юникод, например Java, JavaScript.

TextAnswer

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

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

TextDocument

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

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

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

Question Answering - Get Answers From Text

Параметры URI

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

Ответы

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

AADToken

Примечания

Области

Ocp-Apim-Subscription-Key

Примеры

Successful query

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

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

Определения

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

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