Knowledgebase - Update

リファレンス

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

ナレッジベースを変更する非同期操作。

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

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

要求本文

名前	型	説明
add	Add	追加操作用の CreateKbInputDTO のインスタンス
defaultAnswerUsedForExtraction	string	ドキュメントから抽出された回答がないが階層を持つ任意の Q-A の回答として使用されるテキスト文字列。 EnableHierarchicalExtraction フィールドが True に設定されている場合は必須です。
delete	Delete	Delete Operation の DeleteKbContentsDTO のインスタンス
enableHierarchicalExtraction	boolean	ファイルと URL からの Q-A の階層抽出を有効にします。 KB の作成時に設定された値は、このフィールドが存在しない場合に使用されます。
update	Update	Update Operation の UpdateKbContentsDTO のインスタンス

応答

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

名前

型

説明

202 Accepted

Operation

非同期操作の詳細。

Headers

Location: string

Other Status Codes

ErrorResponse

エラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

例

Successful query

Sample Request

HTTP

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


{
  "add": {
    "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": []
      }
    ],
    "urls": [
      "https://docs.microsoft.com/en-us/azure/cognitive-services/Emotion/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"
      }
    ]
  },
  "delete": {
    "ids": [
      13,
      35
    ]
  },
  "update": {
    "name": "QnA Maker FAQ Prompts Bot",
    "qnaList": [
      {
        "id": 2,
        "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": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "add": [],
          "delete": []
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Add Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I add prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Delete Prompts",
              "displayOrder": 0,
              "qna": {
                "id": 0,
                "answer": "Click here to know more https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/how-to/multiturn-conversation",
                "source": "Editorial",
                "questions": [
                  "How can I delete delete prompts?"
                ],
                "metadata": [],
                "context": {
                  "isContextOnly": false,
                  "prompts": []
                }
              },
              "qnaId": 0
            },
            {
              "displayText": "Update Knowledgebase",
              "displayOrder": 0,
              "qna": null,
              "qnaId": 3
            }
          ],
          "promptsToDelete": [
            3
          ]
        }
      },
      {
        "id": 3,
        "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",
        "source": "Custom Editorial",
        "questions": {
          "add": [],
          "delete": []
        },
        "metadata": {
          "delete": [
            {
              "name": "category",
              "value": "api"
            }
          ],
          "add": [
            {
              "name": "category",
              "value": "programmatic"
            }
          ]
        },
        "context": {
          "isContextOnly": false,
          "promptsToAdd": [
            {
              "displayText": "Regenerate Endpoint keys",
              "displayOrder": 1,
              "qna": null,
              "qnaId": 4
            }
          ],
          "promptsToDelete": [
            4
          ]
        }
      }
    ]
  }
}

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"
}

定義

名前	説明
Add	追加操作用の CreateKbInputDTO のインスタンス
Context	更新する Qna に関連付けられているコンテキスト。
Delete	Delete Operation の DeleteKbContentsDTO のインスタンス
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。
Metadata	更新する回答に関連付けられているメタデータの一覧
MetadataDTO	名前 - メタデータの値ペア。
Operation	実行時間の長い操作を追跡するレコード。
OperationStateType	操作の状態。
PromptDTO	回答を求めるメッセージを表示します。
Qna	QnADTO - QnaId または QnADTO のいずれかが PromptDTO オブジェクトに存在する必要がある
QnADTO	Q-A オブジェクト。
Questions	回答に関連付けられている質問の一覧。
Update	Update Operation の UpdateKbContentsDTO のインスタンス
UpdateKbOperationDTO	更新する QnA の一覧が含まれています
UpdateQnaDTO	Update Qna List の PATCH 本文スキーマ

Add

追加操作用の CreateKbInputDTO のインスタンス

名前	型	説明
files	FileDTO[]	ナレッジベースに追加するファイルの一覧。
qnaList	QnADTO[]	インデックスに追加する QNA の一覧。 ID はサービスによって生成され、省略する必要があります。
urls	string[]	ナレッジベースに追加する URL の一覧。

Context

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

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

Delete

Delete Operation の DeleteKbContentsDTO のインスタンス

名前	型	説明
ids	integer[]	削除する Qna ID の一覧
sources	string[]	ナレッジベースから削除するソースの一覧。

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	指定されたファイルが Unstructured かどうかを指定する省略可能なフラグ。

InnerErrorModel

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

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

Metadata

更新する回答に関連付けられているメタデータの一覧

名前	型	説明
add	MetadataDTO[]	追加する回答に関連付けられているメタデータの一覧
delete	MetadataDTO[]	削除する回答に関連付けられているメタデータの一覧

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

Questions

回答に関連付けられている質問の一覧。

名前	型	説明
add	string[]	追加する質問の一覧
delete	string[]	削除する質問の一覧。

Update

Update Operation の UpdateKbContentsDTO のインスタンス

名前	型	説明
defaultAnswer	string	KB で適切な一致が見つからない場合にユーザーに送信される既定の回答。
name	string	ナレッジベースのフレンドリ名。
qnaList	UpdateQnaDTO[]	ナレッジベースに追加する Q-A (UpdateQnaDTO) の一覧。
urls	string[]	更新する既存の URL の一覧。コンテンツが再び抽出され、インデックスが再作成されます。

UpdateKbOperationDTO

更新する QnA の一覧が含まれています

名前	型	説明
add	Add	追加操作用の CreateKbInputDTO のインスタンス
defaultAnswerUsedForExtraction	string	ドキュメントから抽出された回答がないが階層を持つ任意の Q-A の回答として使用されるテキスト文字列。 EnableHierarchicalExtraction フィールドが True に設定されている場合は必須です。
delete	Delete	Delete Operation の DeleteKbContentsDTO のインスタンス
enableHierarchicalExtraction	boolean	ファイルと URL からの Q-A の階層抽出を有効にします。 KB の作成時に設定された値は、このフィールドが存在しない場合に使用されます。
update	Update	Update Operation の UpdateKbContentsDTO のインスタンス

UpdateQnaDTO

Update Qna List の PATCH 本文スキーマ

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

Knowledgebase - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

例

Successful query

Sample Request

Sample Response

定義

Add

Context

Delete

Error

ErrorCodeType

ErrorResponse

FileDTO

InnerErrorModel

Metadata

MetadataDTO

Operation

OperationStateType

PromptDTO

Qna

QnADTO

Questions

Update

UpdateKbOperationDTO

UpdateQnaDTO

その他のリソース