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 パラメーター

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

応答

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

セキュリティ

AADToken

これらは Azure Active Directory OAuth2 フローです。 Azure ロールベースのアクセス制御と組み合わせて使用すると、Azure Maps REST API へのアクセスを制御できます。 Azure ロールベースのアクセス制御は、1 つ以上のAzure Mapsリソースアカウントまたはサブリソースへのアクセスを指定するために使用されます。 REST API をAzure Mapsするための 1 つ以上のアクセス許可で構成される組み込みロールまたはカスタムロールを使用して、ユーザー、グループ、またはサービスプリンシパルにアクセス権を付与できます。

シナリオを実装するには、認証の概念を表示することをお勧めします。要約すると、このセキュリティ定義は、特定の API とスコープに対するアクセス制御が可能なオブジェクトを使用してアプリケーションをモデル化するためのソリューションを提供します。

メモ

このセキュリティ定義では、ヘッダーを使用して、x-ms-client-idアプリケーションがアクセスを要求しているリソースAzure Maps示す必要があります。これは、 Maps 管理 API から取得できます。

は Authorization URL 、Azure パブリッククラウドインスタンスに固有です。ソブリンクラウドには、一意の承認 URL と Azure Active Directory 構成があります。 * Azure ロールベースのアクセス制御は、Azure portal、PowerShell、CLI、Azure SDK、または REST API を介して Azure 管理プレーンから構成されます。 * Azure Maps Web SDK を使用すると、複数のユースケースに対してアプリケーションを構成ベースで設定できます。

現在、Azure Active Directory v1.0 または v2.0 では、職場、学校、ゲストはサポートされていますが、個人用アカウントはサポートされていません。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
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"
    }
  ]
}

定義

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

Error

error オブジェクト。

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

ErrorCode

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

名前	型	説明
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

エラー応答。

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

InnerErrorCode

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

名前	型	説明
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。

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

QnaAssets

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

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

QnaDialog

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

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

QnaPrompt

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

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

QnaRecord

QnA レコード。

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

RetrieveQnaRecord

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

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

SuggestedQuestion

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

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

SuggestedQuestionsCluster

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

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

次の方法で共有