Knowledgebase - Generate Answer

リファレンス

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.1

GenerateAnswer 呼び出しでナレッジベースを照会する (QnA Maker Managed)。

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

URI パラメーター

Name	In	Required	Type	Description
Endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (例: qnamaker-resource-name<>.api.cognitiveservices.azure.com https://)。
kbId	path	True	string	ナレッジベース ID。

要求ヘッダー

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string

要求本文

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

応答

Name	Type	Description
200 OK	QnASearchResultList	GenerateAnswer 呼び出し応答。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

例

Successful query

Sample Request

HTTP

POST {Endpoint}/qnamaker/v5.0-preview.1/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="
}

Sample Response

Status code:: 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

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

Name	Type	Description
endIndex	integer	回答スパンの終了インデックス。
score	number	回答スパンの予測スコア。
startIndex	integer	回答のスパンのインデックスを開始します。
text	string	回答スパンの予測テキスト。

AnswerSpanRequest

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

Name	Type	Description
enable	boolean	応答スパン予測を有効または無効にします。
scoreThreshold	number	回答範囲を含めるために必要な最小しきい値スコア。
topAnswersWithSpan	integer	スパン予測で考慮される上位の回答の数。

Context

QnA のコンテキスト

Name	Type	Description
isContextOnly	boolean	プロンプトが前の質問にのみ関連するかどうかをマークする。 true - コンテキスト false のないクエリの検索結果としてこの QnA を含めないでください- コンテキストを無視し、この QnA を検索結果に含めます
prompts	PromptDTO[]	回答に関連付けられているプロンプトの一覧。

Error

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

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

ErrorCodeType

サーバー定義のエラーコードのセットの 1 つ。

Name	Type	Description
BadArgument	string
EndpointKeysError	string
ExtractionFailure	string
Forbidden	string
KbNotFound	string
NotFound	string
OperationNotFound	string
QnaRuntimeError	string
QuotaExceeded	string
SKULimitExceeded	string
ServiceError	string
Unauthorized	string
Unspecified	string
ValidationFailure	string

ErrorResponse

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

Name	Type	Description
error	Error	エラーオブジェクト。

InnerErrorModel

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

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

MetadataDTO

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

Name	Type	Description
name	string	メタデータの名前。
value	string	メタデータの値。

PromptDTO

回答を求めます。

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

Qna

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

QnASearchResult

検索結果を表します。

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

QnASearchResultList

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

Name	Type	Description
answers	QnASearchResult[]	検索結果の一覧を表します。

QueryDTO

POST 本文スキーマを使用してナレッジベースを照会します。

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

StrictFiltersCompoundOperationType

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

Name	Type	Description
AND	string
OR	string