Knowledgebase - Create

リファレンス

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

新しいナレッジベースを作成する非同期操作。

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

URI パラメーター

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

要求ヘッダー

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

要求本文

名前	必須	型	説明
name	True	string	ナレッジベースのフレンドリ名。
defaultAnswer		string	KB で適切な一致が見つからない場合にユーザーに送信される既定の回答。
defaultAnswerUsedForExtraction		string	ドキュメントから抽出された回答がないが階層を持つ Q-A で回答として使用されるテキスト文字列。 EnableHierarchicalExtraction フィールドが True に設定されている場合は必須です。
enableHierarchicalExtraction		boolean	ファイルと URL からの Q-A の階層抽出を有効にします。このフィールドが存在しない場合に False と見なされる値。
enableMultipleLanguages		boolean	同じリソースに対して異なる言語で KB を作成できるようにするには、true に設定します。
files		FileDTO[]	Q-A を抽出するファイルの一覧。
language		string	ナレッジベースの言語。サポートされている言語の一覧については、こちらを参照してください。
qnaList		QnADTO[]	ナレッジベースに追加する Q-A (QnADTO) の一覧。 Q-A ID はサービスによって割り当てられ、省略する必要があります。
urls		string[]	Q-A の抽出に使用する URL の一覧。

応答

名前	型	説明
202 Accepted	Operation	非同期操作の詳細。
Other Status Codes	ErrorResponse	エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

例

Successful query

Sample Request

HTTP

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


{
  "name": "QnA Maker FAQ",
  "qnaList": [
    {
      "id": 0,
      "answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
      "source": "Custom Editorial",
      "questions": [
        "How can I change the default message from QnA Maker?"
      ],
      "metadata": []
    },
    {
      "id": 0,
      "answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
      "source": "Custom Editorial",
      "questions": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "displayText": "Update KB",
            "qna": {
              "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
              "questions": [
                "How do I programmatically update my KB?"
              ],
              "metadata": [
                {
                  "name": "category",
                  "value": "api"
                }
              ],
              "context": {
                "isContextOnly": false,
                "prompts": [
                  {
                    "displayOrder": 1,
                    "displayText": "Refresh Endpoint Keys",
                    "qna": {
                      "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
                      "questions": [
                        "How do I programmatically refresh endpoint keys?"
                      ]
                    }
                  }
                ]
              }
            }
          }
        ]
      }
    }
  ],
  "urls": [
    "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
    "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
  ],
  "files": [
    {
      "fileName": "SurfaceManual.pdf",
      "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  ]
}

Sample Response

Status code:: 202

{
  "operationState": "NotStarted",
  "createdTimestamp": "2018-03-19T07:38:46Z",
  "lastActionTimestamp": "2018-03-19T07:39:29Z",
  "userId": "86bb8390-56c0-42c2-9f81-3de161981191",
  "operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}

定義

名前	説明
Context	更新する Qna に関連付けられているコンテキスト。
CreateKbDTO	CreateKb 操作の事後本文スキーマ。
Error	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。
FileDTO	アップロードされたファイルの詳細を保持する DTO。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
MetadataDTO	名前 - メタデータの値ペア。
Operation	実行時間の長い操作を追跡するレコード。
OperationStateType	操作の状態。
PromptDTO	回答を求めます。
Qna	QnADTO - QnaId または QnADTO のいずれかが PromptDTO オブジェクトに存在する必要があります
QnADTO	Q-A オブジェクト。

Context

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

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

CreateKbDTO

CreateKb 操作の事後本文スキーマ。

名前	型	説明
defaultAnswer	string	KB で適切な一致が見つからない場合にユーザーに送信される既定の回答。
defaultAnswerUsedForExtraction	string	ドキュメントから抽出された回答がないが階層を持つ Q-A で回答として使用されるテキスト文字列。 EnableHierarchicalExtraction フィールドが True に設定されている場合は必須です。
enableHierarchicalExtraction	boolean	ファイルと URL からの Q-A の階層抽出を有効にします。このフィールドが存在しない場合に False と見なされる値。
enableMultipleLanguages	boolean	同じリソースに対して異なる言語で KB を作成できるようにするには、true に設定します。
files	FileDTO[]	Q-A を抽出するファイルの一覧。
language	string	ナレッジベースの言語。サポートされている言語の一覧については、こちらを参照してください。
name	string	ナレッジベースのフレンドリ名。
qnaList	QnADTO[]	ナレッジベースに追加する Q-A (QnADTO) の一覧。 Q-A ID はサービスによって割り当てられ、省略する必要があります。
urls	string[]	Q-A の抽出に使用する URL の一覧。

Error

error オブジェクト。 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	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。

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

FileDTO

アップロードされたファイルの詳細を保持する DTO。

名前	型	説明
fileName	string	ファイル名。サポートされているファイルの種類は、".tsv"、".pdf"、".txt"、".docx"、".xlsx" です。
fileUri	string	ファイルのパブリック URI。
isUnstructured	boolean	指定されたファイルが非構造化であるかどうかを指定する省略可能なフラグ。

InnerErrorModel

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

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

MetadataDTO

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

名前	型	説明
name	string	メタデータの名前。
value	string	メタデータの値。

Operation

実行時間の長い操作を追跡するレコード。

名前	型	説明
createdTimestamp	string	操作が作成されたときのタイムスタンプ。
errorResponse	ErrorResponse	エラーが発生した場合のエラーの詳細。
lastActionTimestamp	string	現在の状態が入力されたときのタイムスタンプ。
operationId	string	操作 ID です。
operationState	OperationStateType	操作の状態。
resourceLocation	string	完了したリソースのターゲットリソースの場所に対する相対 URI。
userId	string	ユーザー ID

OperationStateType

操作の状態。

名前	型	説明
Failed	string
NotStarted	string
Running	string
Succeeded	string

PromptDTO

回答を求めます。

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

Qna

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

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

QnADTO

Q-A オブジェクト。

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