预生成 API

使用自定义问题解答预生成 API，可以基于一段文本回答问题，而无需创建项目、维护问答对，也不必因为基础设施未充分利用而浪费成本。 此功能作为 API 提供，可用于满足问题和解答需求，无需了解有关自定义问题解答的详细信息。

如果给定了用户查询和文本块/段落，则 API 会返回一个答案，在有精确答案的情况下会返回精确答案。

示例 API 使用

假设你有一个或多个你要从中获取给定问题的答案的文本块。 一般说来，必须创建与文本块数目同样多的源。 但使用预生成 API，你现在可以查询文本块而无需在项目中定义内容源。

可以使用此 API 的其他场景包括：

• 你在为最终用户开发电子书阅读器应用，该应用可以突出显示文本、输入问题，以及在突出显示的一段文本中查找答案。
• 使用浏览器扩展后，用户可以根据浏览器页面当前显示的内容提出问题。
• 医疗机器人从用户那里获取查询，然后根据其确定的与用户查询最相关的医疗内容来提供答案。

下面是示例请求的示例：

示例请求

POST https://{Unique-to-your-endpoint}.api.cognitive.azure.cn/language/:query-text

基于单个文本块的示例查询

请求正文

{
  "parameters": {
    "Endpoint": "{Endpoint}",
    "Ocp-Apim-Subscription-Key": "{API key}",
    "Content-Type": "application/json",
    "api-version": "2021-10-01",
    "stringIndexType": "TextElements_v8",
    "textQueryOptions": {
      "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"
    }
  }
}

示例响应

在上述请求正文中，我们基于单个文本块进行查询。 收到的针对上述查询的示例响应如下所示：

{
"responses": {
    "200": {
      "headers": {},
      "body": {
        "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
          }
        ]
      }
    }
  }

我们发现，在 API 响应中会收到多个答案。 每个答案都有特定的置信度评分，有助于了解答案的总体相关性。 答案范围表示是否也检测到了可能的简短答案。 用户可以利用这一置信度分数来确定要提供哪个答案来响应查询。

预生成 API 限制

API 调用限制

如果需要使用的文档的大小超出允许的限制，可将文本拆分成较小的文本块，然后再将其发送到 API。 在这种情况下，文档是由文本字符组成的已定义的单个字符串。

这些数字表示每个单独的 API 调用的限制：

• 文档数：5。
• 单个文档的最大大小：5,120 个字符。
• 每个文档最多 3 个响应。

支持的语言代码

预生成的 API 支持以下语言代码。 这些语言代码符合 ISO 639-1 代码标准。

预生成 API 参考

请访问完整的预生成 API 示例文档，了解调用 API 所需的输入和输出参数。