Knowledgebase - Update

Referensi

Service:: Cognitive Services - QnA Maker

API Version:: 4.0

Operasi asinkron untuk memodifikasi pangkalan pengetahuan.

PATCH {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}

Parameter URI

Name	In	Required	Type	Description
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://< qnamaker-resource-name> .api.cognitiveservices.azure.com).
kbId	path	True	string	Id pangkalan pengetahuan.

Header Permintaan

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

Isi Permintaan

Name	Type	Description
add	Add	Instans CreateKbInputDTO untuk operasi penambahan
defaultAnswerUsedForExtraction	string	String teks yang akan digunakan sebagai jawaban dalam Q-A apa pun yang tidak memiliki jawaban yang diekstrak dari dokumen tetapi memiliki hierarki. Diperlukan saat bidang EnableHierarchicalExtraction diatur ke True.
delete	Delete	Instans DeleteKbContentsDTO untuk operasi penghapusan
enableHierarchicalExtraction	boolean	Aktifkan ekstraksi hierarki Q-A dari file dan url. Nilai yang ditetapkan selama pembuatan KB akan digunakan jika bidang ini tidak ada.
update	Update	Instans UpdateKbContentsDTO untuk Operasi Pembaruan

Respons

Name	Type	Description
202 Accepted	Operation	Detail operasi asinkron. Headers Location: string
Other Status Codes	ErrorResponse	Respons kesalahan.

Name

Type

Description

202 Accepted

Operation

Detail operasi asinkron.

Headers

Location: string

Other Status Codes

ErrorResponse

Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Contoh

Successful query

Sample Request

HTTP

PATCH {Endpoint}/qnamaker/v4.0/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"
}

Definisi

Add	Instans CreateKbInputDTO untuk operasi penambahan
Context	Konteks QnA
Delete	Instans DeleteKbContentsDTO untuk operasi penghapusan
Error	Objek kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Salah satu set kode kesalahan yang ditentukan server.
ErrorResponse	Respons kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
FileDTO	DTO untuk menyimpan detail file yang diunggah.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Metadata	Daftar metadata yang terkait dengan jawaban yang akan diperbarui
MetadataDTO	Nama - pasangan nilai metadata.
Operation	Rekam untuk melacak operasi jangka panjang.
OperationStateType	Status operasi.
PromptDTO	Minta jawaban.
Qna	QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO
QnADTO	Objek Q-A.
Questions	Daftar pertanyaan yang terkait dengan jawabannya.
Update	Instans UpdateKbContentsDTO untuk Operasi Pembaruan
UpdateKbOperationDTO	Berisi daftar QnA yang akan diperbarui
UpdateQnaDTO	Skema Isi PATCH untuk Daftar Qna Pembaruan

Add

Instans CreateKbInputDTO untuk operasi penambahan

Name	Type	Description
files	FileDTO[]	Daftar file yang akan ditambahkan ke pangkalan pengetahuan.
qnaList	QnADTO[]	Daftar QNA yang akan ditambahkan ke indeks. Id dihasilkan oleh layanan dan harus dihilangkan.
urls	string[]	Daftar URL yang akan ditambahkan ke pangkalan pengetahuan.

Context

Konteks QnA

Name	Type	Description
isContextOnly	boolean	Untuk menandai apakah perintah hanya relevan dengan pertanyaan sebelumnya atau tidak. true - Jangan sertakan QnA ini sebagai hasil pencarian untuk kueri tanpa konteks false - mengabaikan konteks dan menyertakan QnA ini dalam hasil pencarian
prompts	PromptDTO[]	Daftar perintah yang terkait dengan jawabannya.

Delete

Instans DeleteKbContentsDTO untuk operasi penghapusan

Name	Type	Description
ids	integer[]	Daftar Id Qna yang akan dihapus
sources	string[]	Daftar sumber yang akan dihapus dari pangkalan pengetahuan.

Error

Objek kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	ErrorCodeType	Salah satu set kode kesalahan yang ditentukan server.
details	Error[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
innerError	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Representasi kesalahan yang dapat dibaca manusia.
target	string	Target kesalahan.

ErrorCodeType

Salah satu set kode kesalahan yang ditentukan server.

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

Respons kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
error	Error	Objek kesalahan.

FileDTO

DTO untuk menyimpan detail file yang diunggah.

Name	Type	Description
fileName	string	Nama file. Jenis file yang didukung adalah ".tsv", ".pdf", ".txt", ".docx", ".xlsx".
fileUri	string	URI publik file.

InnerErrorModel

Objek yang berisi informasi yang lebih spesifik tentang kesalahan tersebut. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Kode kesalahan yang lebih spesifik daripada yang disediakan oleh kesalahan yang berisi.
innerError	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.

Metadata

Daftar metadata yang terkait dengan jawaban yang akan diperbarui

Name	Type	Description
add	MetadataDTO[]	Daftar metadata yang terkait dengan jawaban yang akan ditambahkan
delete	MetadataDTO[]	Daftar Metadata yang terkait dengan jawaban yang akan dihapus

MetadataDTO

Nama - pasangan nilai metadata.

Name	Type	Description
name	string	Nama metadata.
value	string	Nilai metadata.

Operation

Rekam untuk melacak operasi jangka panjang.

Name	Type	Description
createdTimestamp	string	Tanda waktu saat operasi dibuat.
errorResponse	ErrorResponse	Detail kesalahan jika terjadi kegagalan.
lastActionTimestamp	string	Tanda waktu ketika status saat ini dimasukkan.
operationId	string	Id Operasi.
operationState	OperationStateType	Status operasi.
resourceLocation	string	URI relatif terhadap lokasi sumber daya target untuk sumber daya yang telah selesai.
userId	string	Id Pengguna

OperationStateType

Status operasi.

Name	Type	Description
Failed	string
NotStarted	string
Running	string
Succeeded	string

PromptDTO

Minta jawaban.

Name	Type	Description
displayOrder	integer	Indeks perintah - digunakan dalam urutan perintah
displayText	string	Teks ditampilkan untuk mewakili petunjuk pertanyaan tindak lanjut
qna	Qna	QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO
qnaId	integer	Id Qna yang sesuai dengan perintah - jika QnaId ada, objek QnADTO diabaikan.

Qna

QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO

QnADTO

Objek Q-A.

Name	Type	Description
answer	string	Teks jawaban
context	Context	Konteks QnA
id	integer	Id unik untuk Q-A.
metadata	MetadataDTO[]	Daftar metadata yang terkait dengan jawabannya.
questions	string[]	Daftar pertanyaan yang terkait dengan jawabannya.
source	string	Sumber tempat Q-A diindeks. Misalnya. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Questions

Daftar pertanyaan yang terkait dengan jawabannya.

Name	Type	Description
add	string[]	Daftar pertanyaan yang akan ditambahkan
delete	string[]	Daftar pertanyaan yang akan dihapus.

Update

Instans UpdateKbContentsDTO untuk Operasi Pembaruan

Name	Type	Description
name	string	Nama yang ramah untuk pangkalan pengetahuan.
qnaList	UpdateQnaDTO[]	Daftar Q-A (UpdateQnaDTO) yang akan ditambahkan ke pangkalan pengetahuan.
urls	string[]	Daftar URL yang ada yang akan disegarkan. Konten akan diekstrak lagi dan diindeks ulang.

UpdateKbOperationDTO

Berisi daftar QnA yang akan diperbarui

Name	Type	Description
add	Add	Instans CreateKbInputDTO untuk operasi penambahan
defaultAnswerUsedForExtraction	string	String teks yang akan digunakan sebagai jawaban dalam Q-A apa pun yang tidak memiliki jawaban yang diekstrak dari dokumen tetapi memiliki hierarki. Diperlukan saat bidang EnableHierarchicalExtraction diatur ke True.
delete	Delete	Instans DeleteKbContentsDTO untuk operasi penghapusan
enableHierarchicalExtraction	boolean	Aktifkan ekstraksi hierarki Q-A dari file dan url. Nilai yang ditetapkan selama pembuatan KB akan digunakan jika bidang ini tidak ada.
update	Update	Instans UpdateKbContentsDTO untuk Operasi Pembaruan

UpdateQnaDTO

Skema Isi PATCH untuk Daftar Qna Pembaruan

Name	Type	Description
answer	string	Teks jawaban
context	Context	Konteks yang terkait dengan Qna yang akan diperbarui.
id	integer	Id unik untuk Q-A
metadata	Metadata	Daftar metadata yang terkait dengan jawaban yang akan diperbarui
questions	Questions	Daftar pertanyaan yang terkait dengan jawabannya.
source	string	Sumber tempat Q-A diindeks. Misalnya. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs