Question Answering Projects - Get Qnas

參考

服務:: Cognitive Services - Language

API 版本:: 2023-04-01

取得專案的所有 QnA。

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-01

含選擇性參數:

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/qnas?api-version=2023-04-01&source={source}&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI 參數

名稱	位於	必要	類型	Description
Endpoint	path	True	string	支援的認知服務端點 (例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string	要使用的項目名稱。
api-version	query	True	string	用戶端 API 版本。
maxpagesize	query		integer int32	要包含在單一回應中的資源數目上限。
skip	query		integer int32	要傳回之第一個資源的集合中的位移。
source	query		string	QnA 的來源。
top	query		integer int32	要從集合傳回的資源數目上限。

回應

名稱	類型	Description
200 OK	QnaAssets	專案的所有 QnA。
Other Status Codes	ErrorResponse	錯誤回應。

安全性

AADToken

這些是 Azure Active Directory OAuth2 流程。與 Azure 角色型存取控制配對時，可用來控制對 REST API 的存取 Azure 地圖服務。 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

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/qnas?api-version=2023-04-01

範例回覆

狀態碼:: 200

{
  "value": [
    {
      "id": 1,
      "answer": "ans1",
      "source": "source1",
      "questions": [
        "question 1.1",
        "question 1.2"
      ],
      "metadata": {
        "k1": "v1",
        "k2": "v2"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 11,
            "displayText": "prompt 1.1"
          },
          {
            "displayOrder": 2,
            "qnaId": 21,
            "displayText": "prompt 1.2"
          }
        ]
      },
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    },
    {
      "id": 2,
      "answer": "ans2",
      "source": "source2",
      "questions": [
        "question 2.1",
        "question 2.2"
      ],
      "lastUpdatedDateTime": "2021-05-01T17:21:14Z"
    }
  ]
}

定義

名稱	Description
Error	error 物件。
ErrorCode	人類可讀取的錯誤碼。
ErrorResponse	錯誤回應。
InnerErrorCode	人類可讀取的錯誤碼。
InnerErrorModel	物件，包含錯誤的詳細資訊。根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
QnaAssets	專案的所有 QnA 資產。
QnaDialog	與 QnA 記錄相關聯的對話方塊。
QnaPrompt	提示輸入答案。
QnaRecord	QnA 記錄。
RetrieveQnaRecord	具有上次更新日期時間的 QnA 記錄。
SuggestedQuestion	主動式學習功能所建議的問題。
SuggestedQuestionsCluster	主動式學習建議的問題叢集詳細數據。

Error

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	error 物件。

InnerErrorCode

人類可讀取的錯誤碼。

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

物件，包含錯誤的詳細資訊。根據 Microsoft One API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱	類型	Description
code	InnerErrorCode	其中一組伺服器定義的錯誤碼。
details	object	錯誤詳細數據。
innererror	InnerErrorModel	物件，包含比目前對象有關錯誤更具體的資訊。
message	string	錯誤訊息。
target	string	錯誤目標。

QnaAssets

專案的所有 QnA 資產。

名稱	類型	Description
nextLink	string
value	RetrieveQnaRecord[]	QnA 記錄的清單。

QnaDialog

與 QnA 記錄相關聯的對話方塊。

名稱	類型	Description
isContextOnly	boolean	若要標示提示是否只與先前的問題相關。如果為 true，請勿將此 QnA 作為沒有內容之查詢的答案;否則，會忽略內容，並在答案中包含此 QnA。
prompts	QnaPrompt[]	與答案相關聯的提示清單。

QnaPrompt

提示輸入答案。

名稱	類型	Description
displayOrder	integer	提示的索引。它用於排序提示。
displayText	string	顯示代表後續問題提示的文字。
qna	QnaRecord	QnA 記錄。 QnAId 或 QnA 記錄必須出現在提示中。
qnaId	integer	對應至提示的 QnA 識別碼。

QnaRecord

QnA 記錄。

名稱	類型	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	QnA 的作用中學習建議清單。
answer	string	回應文字。
dialog	QnaDialog	QnA 的內容。
id	integer	QnA 的唯一標識碼。
metadata	object	與答案相關聯的元數據，有助於分類或篩選問題解答。
questions	string[]	與答案相關聯的問題清單。
source	string	QnA 編製索引的來源，例如 https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs 。

RetrieveQnaRecord

具有上次更新日期時間的 QnA 記錄。

名稱	類型	Description
activeLearningSuggestions	SuggestedQuestionsCluster[]	QnA 的作用中學習建議清單。
answer	string	回應文字。
dialog	QnaDialog	QnA 的內容。
id	integer	QnA 的唯一標識碼。
lastUpdatedDateTime	string	上次更新 QnA 的日期時間。
metadata	object	與答案相關聯的元數據，有助於分類或篩選問題解答。
questions	string[]	與答案相關聯的問題清單。
source	string	QnA 編製索引的來源，例如 https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs 。

SuggestedQuestion

主動式學習功能所建議的問題。

名稱	類型	Description
autoSuggestedCount	integer	主動式學習演算法自動建議問題的次數。
question	string	主動式學習功能所建議的問題。
userSuggestedCount	integer	用戶明確建議問題的次數。

SuggestedQuestionsCluster

主動式學習建議的問題叢集詳細數據。

名稱	類型	Description
clusterHead	string	主動式學習叢集演算法選擇為建議問題叢集前端的問題。
suggestedQuestions	SuggestedQuestion[]	QnA 的所有建議問題清單。

共用方式為