Question Answering Projects - Get Qnas

リファレンス

サービス:: Azure AI Services

API バージョン:: 2021-10-01

プロジェクトのすべての QnA を取得します。

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/qnas?api-version=2021-10-01

省略可能なパラメーターを含む:

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	使用するプロジェクトの名前。
api-version	query	True	string	クライアント API のバージョン。
maxpagesize	query		integer (int32)	1 つの応答に含めるリソースの最大数。
skip	query		integer (int32)	返される最初のリソースのコレクションへのオフセット。
source	query		string	QnA のソース。
top	query		integer (int32)	コレクションから返されるリソースの最大数。

要求ヘッダー

名前	必須	型	説明
Ocp-Apim-Subscription-Key	True	string

応答

名前	型	説明
200 OK	QnaAssets	プロジェクトのすべての QnA。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Successful query

要求のサンプル

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/qnas?api-version=2021-10-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"
    }
  ]
}

定義

名前	説明
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	Active Learning 機能によって提案される質問。
SuggestedQuestionsCluster	Active Learning で推奨される質問クラスターの詳細。

Error

Object

エラーオブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

ErrorCode

列挙

人間が判読できるエラーコード。

値	説明
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

エラー応答。

名前	型	説明
error	Error	エラーオブジェクト。

InnerErrorCode

列挙

人間が判読できるエラーコード。

値	説明
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

名前	型	説明
code	InnerErrorCode	サーバー定義の一連のエラーコードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

QnaAssets

Object

プロジェクトのすべての QnA 資産。

名前	型	説明
nextLink	string
value	RetrieveQnaRecord[]	QnA レコードのリスト。

QnaDialog

Object

QnA レコードに関連付けられているダイアログ。

名前	型	説明
isContextOnly	boolean	プロンプトが前の質問にのみ関連するかどうかをマークする。 true の場合は、コンテキストのないクエリの回答としてこの QnA を含めないでください。それ以外の場合、コンテキストは無視され、この QnA が回答に含まれます。
prompts	QnaPrompt[]	回答に関連付けられているプロンプトの一覧。

QnaPrompt

Object

回答を求めるメッセージを表示します。

名前	型	説明
displayOrder	integer (int32)	プロンプトのインデックス。プロンプトの順序付けに使用されます。
displayText	string maxLength: 200	フォローアップの質問プロンプトを表すテキストが表示されます。
qna	QnaRecord	QnA レコード。 QnAId または QnA レコードがプロンプトに存在する必要があります。
qnaId	integer (int32)	プロンプトに対応する QnA の ID。

QnaRecord

Object

QnA レコード。

名前	型	説明
activeLearningSuggestions	SuggestedQuestionsCluster[]	QnA に関するアクティブラーニングの提案の一覧。
answer	string minLength: 1 maxLength: 25000	回答テキスト。
dialog	QnaDialog	QnA のコンテキスト。
id	integer (int32)	QnA の一意の ID。
metadata	object	回答に関連付けられたメタデータ。質問の回答を分類またはフィルター処理するのに役立ちます。
questions	string[]	回答に関連付けられている質問の一覧。
source	string maxLength: 300	QnA のインデックスが作成されたソース (例: https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)。

RetrieveQnaRecord

Object

最後に更新された日時の QnA レコード。

名前	型	説明
activeLearningSuggestions	SuggestedQuestionsCluster[]	QnA に関するアクティブラーニングの提案の一覧。
answer	string minLength: 1 maxLength: 25000	回答テキスト。
dialog	QnaDialog	QnA のコンテキスト。
id	integer (int32)	QnA の一意の ID。
lastUpdatedDateTime	string (date-time)	QnA が最後に更新された日時。
metadata	object	回答に関連付けられたメタデータ。質問の回答を分類またはフィルター処理するのに役立ちます。
questions	string[]	回答に関連付けられている質問の一覧。
source	string maxLength: 300	QnA のインデックスが作成されたソース (例: https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs)。

SuggestedQuestion

Object

Active Learning 機能によって提案される質問。

名前	型	説明
autoSuggestedCount	integer (int32)	Active Learning アルゴリズムによって質問が自動的に提案された回数。
question	string	Active Learning 機能によって提案される質問。
userSuggestedCount	integer (int32)	ユーザーが質問を明示的に提案した回数。

SuggestedQuestionsCluster

Object

Active Learning で推奨される質問クラスターの詳細。

名前	型	説明
clusterHead	string	Active Learning クラスタリングアルゴリズムによって提案された質問クラスターの先頭として選択された質問。
suggestedQuestions	SuggestedQuestion[]	QnA に関して提案されたすべての質問の一覧。

次の方法で共有

Question Answering Projects - Get Qnas

URI パラメーター

要求ヘッダー

応答

セキュリティ

Ocp-Apim-Subscription-Key

例

Successful query

要求のサンプル

応答のサンプル

定義

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

QnaAssets

QnaDialog

QnaPrompt

QnaRecord

RetrieveQnaRecord

SuggestedQuestion

SuggestedQuestionsCluster

その他のリソース