Question Answering - Get Answers From Text

參考

服務:: Cognitive Services - Language

API 版本:: 2023-04-01

使用本文中提供的文字回答指定的問題。

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

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).
api-version	query	True	string	用戶端 API 版本。

要求本文

名稱	必要	類型	Description
question	True	string	要查詢指定文字記錄的用戶問題。
records	True	TextDocument[]	要搜尋指定問題的文字記錄。
language		string	文字記錄的語言。這是語言的 BCP-47 表示法。例如，使用「en」表示英文;西班牙文等的 “es”如果未設定，請針對英文使用「en」作為預設值。
stringIndexType		StringIndexType	指定用來解譯字串位移的方法。默認為 Text 元素， (Graphemes 根據 Unicode v8.0.0) 。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

回應

名稱	類型	Description
200 OK	AnswersFromTextResult	從輸入文字取得答案的成功回應。
Other Status Codes	ErrorResponse	錯誤回應。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。與 Azure 角色型存取控制配對時，可用來控制對 Azure 地圖服務 REST API 的存取。 Azure 角色型訪問控制可用來指定一或多個 Azure 地圖服務資源帳戶或子資源的存取權。任何使用者、群組或服務主體都可以透過內建角色或由一或多個許可權組成的自定義角色來授與存取權，以 Azure 地圖服務 REST API。

若要實作案例，建議您檢視驗證概念。總而言之，此安全性定義會透過能夠針對特定 API 和範圍進行訪問控制的物件，提供將應用程式模型化 () 的解決方案。

備註

此安全性定義需要使用x-ms-client-id 標頭來指出應用程式要求存取權 Azure 地圖服務資源。這可以從地圖管理 API 取得。

Authorization URL專屬於 Azure 公用雲端實例。主權雲端具有唯一的授權 URL 和 Azure Active Directory 設定。 * 透過 Azure 入口網站、PowerShell、CLI、Azure SDK 或 REST API，從 Azure 管理平面設定 Azure 角色型存取控制。 * Azure 地圖服務 Web SDK 的使用方式允許針對多個使用案例設定應用程式設定。

目前，Azure Active Directory v1.0 或 v2.0 支援公司、學校和來賓，但不支持個人帳戶。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
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
    }
  ]
}

定義

名稱	Description
AnswersFromTextOptions	要回答的問題和文字記錄參數。
AnswersFromTextResult	表示答案結果。
AnswerSpan	QnA 的回應範圍物件。
Error	錯誤物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含有關錯誤的更特定資訊。根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
StringIndexType	指定用來解譯字串位移的方法。默認為 Text 元素， (Graphemes 根據 Unicode v8.0.0) 。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。
TextAnswer	表示答案結果。
TextDocument	表示要查詢的輸入文字記錄。

AnswersFromTextOptions

要回答的問題和文字記錄參數。

名稱	類型	預設值	Description
language	string		文字記錄的語言。這是語言的 BCP-47 表示法。例如，使用「en」表示英文;西班牙文等的 “es”如果未設定，請針對英文使用「en」作為預設值。
question	string		要查詢指定文字記錄的用戶問題。
records	TextDocument[]		要搜尋指定問題的文字記錄。
stringIndexType	StringIndexType	TextElements_v8	指定用來解譯字串位移的方法。默認為 Text 元素， (Graphemes 根據 Unicode v8.0.0) 。如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

AnswersFromTextResult

表示答案結果。

名稱	類型	Description
answers	TextAnswer[]	表示答案結果。

AnswerSpan

QnA 的回應範圍物件。

名稱	類型	Description
confidenceScore	number	答案範圍的預測分數，值範圍從 0 到 1。
length	integer	答案範圍的長度。
offset	integer	答案範圍與答案開頭的位移。
text	string	答案範圍的預測文字。

Error

錯誤物件。

名稱	類型	Description
code	ErrorCode	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
target	string	錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

名稱	類型	Description
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

錯誤回應。

名稱	類型	Description
error	Error	錯誤物件。

InnerErrorCode