預建 API

自訂問題解答預建 API 能讓您根據一段文字回答問題，卻不必建立專案、維護問題和答案配對，或負擔使用量過低的基礎結構成本。 這項功能是以 API 的形式提供，可用於解決問答需求，卻不必了解自訂問題解答的詳細資料。

提供使用者查詢和文字區塊/文字段落，此 API 即會傳回答案和精確的答案 (如有)。

API 使用範例

假設您有一或多個文字區塊，而您想要從中獲得指定問題的答案。 通常必須建立和文字區塊數目一樣多的來源。 但是，現在使用預建 API 就可以查詢文字區塊，不必在專案中定義內容來源。

其他可以使用此 API 的案例如下：

• 您正在開發適合終端使用者的電子書讀取器應用程式，使其可以醒目提示文字、輸入問題，並在醒目提示的文字段落中尋找答案。
• 瀏覽器延伸模組可讓使用者針對瀏覽器頁面目前顯示的內容提出問題。
• Health Bot 接受使用者查詢，然後根據 Bot 找到的與使用者查詢最相關的醫療內容提供解答。

以下是範例要求的例子：

範例要求

POST https://{Unique-to-your-endpoint}.api.cognitive.microsoft.com/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 個字元。
• 每份文件最多三個回應。

支援的語言代碼

預先建置的 API 支援下列語言代碼。 這些語言代碼遵循 ISO 639-1 代碼標準。

預先建置 API 參考

請參閱完整的預建 API 範例文件，了解呼叫 API 所需之輸入和輸出參數。