你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	支持的认知服务终结点 (例如 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	指定用于解释字符串偏移量的方法。根据 Unicode v8.0.0，默认为 Text Elements (Graphemes) 。有关其他信息，请参见 https://aka.ms/text-analytics-offsets。

响应

名称	类型	说明
200 OK	AnswersFromTextResult	从输入文本获取答案的成功响应。
Other Status Codes	ErrorResponse	错误响应。

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。与 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 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 可以针对多个用例基于配置设置应用程序。

目前，Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾，但不支持个人帐户。

类型: oauth2
流向: 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	QnA 的答案 span 对象。
Error	错误对象。
ErrorCode	人类可读的错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人类可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
StringIndexType	指定用于解释字符串偏移量的方法。根据 Unicode v8.0.0，默认为 Text Elements (Graphemes) 。有关其他信息，请参见 https://aka.ms/text-analytics-offsets。
TextAnswer	表示答案结果。
TextDocument	表示要查询的输入文本记录。

AnswersFromTextOptions

要回答的问题和文本记录参数。

名称	类型	默认值	说明
language	string		文本记录的语言。这是语言的 BCP-47 表示形式。例如，对英语使用“en”;西班牙语等的“es”。如果未设置，则默认使用英语的“en”。
question	string		针对给定文本记录进行查询的用户问题。
records	TextDocument[]		要搜索给定问题的文本记录。
stringIndexType	StringIndexType	TextElements_v8	指定用于解释字符串偏移量的方法。根据 Unicode v8.0.0，默认为 Text Elements (Graphemes) 。有关其他信息，请参见 https://aka.ms/text-analytics-offsets。

AnswersFromTextResult

表示答案结果。

名称	类型	说明
answers	TextAnswer[]	表示答案结果。

AnswerSpan

QnA 的答案 span 对象。

名称	类型	说明
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