Knowledgebase - Generate Answer

サービス:

Azure AI Services

API バージョン:

v5.0-preview.2

GenerateAnswer 呼び出しによるナレッジ ベースのクエリ (QnA Maker マネージド)。

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/{kbId}/generateAnswer

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: https://< qnamaker-resource-name >.api.cognitiveservices.azure.com)。
kbId	path	True	string	ナレッジ ベース ID。

要求ヘッダー

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

要求本文

名前	型	説明
answerSpanRequest	AnswerSpanRequest	回答スパン予測機能を構成するには。
context	Context	以前の QnA の情報を持つコンテキスト オブジェクト。
includeUnstructuredSources	boolean	非構造化ソースに対するクエリを有効にする省略可能なフラグ。
isTest	boolean	テスト インデックスに対してクエリを実行します。
qnaId	string	ナレッジ ベースからフェッチする正確な qnaId。このフィールドは質問よりも優先されます。
question	string	ナレッジ ベースに対してクエリを実行するユーザーの質問。
rankerType	string	省略可能なフィールド。 質問のみを Ranker で使用する場合は、"QuestionOnly" に設定します。
scoreThreshold	number	回答の最小しきい値スコア。
strictFilters	MetadataDTO[]	指定されたメタデータの一覧に関連付けられている QnA を検索します。
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	省略可能なフィールド。 厳密なフィルターに OR 操作を使用する場合は、'OR' に設定します。
top	integer (int32)	質問に対して返される回答の最大数。
userId	string	ユーザーの一意識別子。

応答

名前	型	説明
200 OK	QnASearchResultList	GenerateAnswer 呼び出し応答。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

例

Successful query

要求のサンプル

HTTP

POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/generateAnswer


{
  "question": "How much time it takes to complete quickstart guide?",
  "top": 6,
  "isTest": true,
  "context": {
    "previousQnaId": 9,
    "previousUserQuery": "Where are QnA Maker quickstarts?"
  },
  "scoreThreshold": 20,
  "strictFilters": [
    {
      "name": "category",
      "value": "api"
    }
  ],
  "answerSpanRequest": {
    "enable": true,
    "scoreThreshold": 25,
    "topAnswersWithSpan": 1
  },
  "userId": "sd53lsY="
}

応答のサンプル

状態コード:

200

{
  "answers": [
    {
      "questions": [
        "Complete a quickstart"
      ],
      "answer": "We offer quickstarts in most popular programming languages, each designed to teach you basic design patterns, and have you running code in less than 10 minutes. See the following list for the quickstart for each feature.\n\n*   [Get started with the LUIS client library](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-sdk)\n\n*   [Get started with the LUIS portal](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/create-publish-knowledge-base)\n\n*   [Get started with the LUIS REST APis](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-rest-curl)",
      "score": 46.11,
      "id": 9,
      "source": "Editorial",
      "metadata": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      },
      "answerSpan": {
        "text": "less than 10 minutes",
        "score": 54.92,
        "startIndex": 139,
        "endIndex": 159
      }
    }
  ]
}

定義

名前	説明
AnswerSpan	ユーザーの質問に関する QnA の回答スパン オブジェクト。
AnswerSpanRequest	回答スパン予測機能を構成するには。
Context	更新する Qna に関連付けられているコンテキスト。
Error	エラー オブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	サーバー定義の一連のエラー コードの 1 つ。
ErrorResponse	エラー応答。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	名前 - メタデータの値ペア。
PromptDTO	回答を求めるメッセージを表示します。
Qna	QnADTO - QnaId または QnADTO のいずれかが PromptDTO オブジェクトに存在する必要があります
QnASearchResult	検索結果を表します。
QnASearchResultList	質問の回答の一覧を表します。
QueryDTO	ナレッジ ベースにクエリを実行する POST 本文スキーマ。
StrictFiltersCompoundOperationType	省略可能なフィールド。 厳密なフィルターに OR 操作を使用する場合は、'OR' に設定します。

AnswerSpan

Object

ユーザーの質問に関する QnA の回答スパン オブジェクト。

名前	型	説明
endIndex	integer (int32)	回答のスパンの終了インデックス。
score	number (double)	回答スパンの予測スコア。
startIndex	integer (int32)	回答のスパンのインデックスを開始します。
text	string	回答スパンの予測テキスト。

AnswerSpanRequest

Object

回答スパン予測機能を構成するには。

名前	型	説明
enable	boolean	回答スパン予測を有効または無効にします。
scoreThreshold	number (double)	回答スパンを含めるために必要な最小しきい値スコア。
topAnswersWithSpan	integer (int32) minimum: 1 maximum: 10	スパン予測で考慮される上位の回答の数。

Context

Object

更新する Qna に関連付けられているコンテキスト。

名前	型	説明
isContextOnly	boolean	プロンプトが前の質問にのみ関連するかどうかをマークする。 true - コンテキストが false のクエリの検索結果としてこの QnA を含めないでください- コンテキストを無視し、この QnA を検索結果に含めます
promptsToAdd	PromptDTO[]	qna に追加するプロンプトの一覧。
promptsToDelete	integer[] (int32)	削除する qna に関連付けられているプロンプトの一覧

Error

Object

エラー オブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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

ErrorCodeType

列挙

サーバー定義の一連のエラー コードの 1 つ。

値	説明
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

エラー応答。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

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

InnerErrorModel

Object

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

名前	型	説明
code	string	含まれているエラーによって提供されたよりも具体的なエラー コード。
innerError	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。

MetadataDTO

Object

名前 - メタデータの値ペア。

名前	型	説明
name	string minLength: 1 maxLength: 100	メタデータ名。
value	string minLength: 1 maxLength: 500	メタデータ値。

PromptDTO

Object

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

名前	型	説明
displayOrder	integer (int32)	プロンプトのインデックス - プロンプトの順序付けで使用されます
displayText	string maxLength: 200	フォローアップの質問プロンプトを表すために表示されるテキスト
qna	Qna	QnADTO - QnaId または QnADTO のいずれかが PromptDTO オブジェクトに存在する必要があります
qnaId	integer (int32)	プロンプトに対応する Qna ID - QnaId が存在する場合、QnADTO オブジェクトは無視されます。

Qna

Object

QnADTO - QnaId または QnADTO のいずれかが PromptDTO オブジェクトに存在する必要があります

名前	型	説明
answer	string minLength: 1 maxLength: 25000	回答テキスト
context	Context	QnA のコンテキスト
id	integer (int32)	Q-A の一意の ID。
lastUpdatedTimestamp	string maxLength: 300	QnA が最後に更新されたときのタイムスタンプ。
metadata	MetadataDTO[]	回答に関連付けられているメタデータの一覧。
questions	string[]	回答に関連付けられている質問の一覧。
source	string maxLength: 300	Q-A のインデックスが作成されたソース。例えば。https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnASearchResult

Object

検索結果を表します。

名前	型	説明
answer	string	答える。
answerSpan	AnswerSpan	ユーザーの質問に関する QnA の回答スパン オブジェクト。
context	Context	QnA のコンテキスト オブジェクト
id	integer (int32)	QnA 結果の ID。
metadata	MetadataDTO[]	メタデータの一覧。
questions	string[]	質問の一覧。
score	number	検索結果スコア。
source	string	QnA 結果のソース。

QnASearchResultList

Object

質問の回答の一覧を表します。

名前	型	説明
answers	QnASearchResult[]	検索結果リストを表します。

QueryDTO

Object

ナレッジ ベースにクエリを実行する POST 本文スキーマ。

名前	型	説明
answerSpanRequest	AnswerSpanRequest	回答スパン予測機能を構成するには。
context	Context	以前の QnA の情報を持つコンテキスト オブジェクト。
includeUnstructuredSources	boolean	非構造化ソースに対するクエリを有効にする省略可能なフラグ。
isTest	boolean	テスト インデックスに対してクエリを実行します。
qnaId	string	ナレッジ ベースからフェッチする正確な qnaId。このフィールドは質問よりも優先されます。
question	string	ナレッジ ベースに対してクエリを実行するユーザーの質問。
rankerType	string	省略可能なフィールド。 質問のみを Ranker で使用する場合は、"QuestionOnly" に設定します。
scoreThreshold	number	回答の最小しきい値スコア。
strictFilters	MetadataDTO[]	指定されたメタデータの一覧に関連付けられている QnA を検索します。
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	省略可能なフィールド。 厳密なフィルターに OR 操作を使用する場合は、'OR' に設定します。
top	integer (int32)	質問に対して返される回答の最大数。
userId	string	ユーザーの一意識別子。

StrictFiltersCompoundOperationType

列挙

省略可能なフィールド。 厳密なフィルターに OR 操作を使用する場合は、'OR' に設定します。

値	説明
AND
OR