Knowledgebase - Download

Referensi

Layanan:: Azure AI Services

Versi API:: 4.0

Unduh basis pengetahuan.

GET {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}/{environment}/qna

Dengan parameter opsional:

GET {Endpoint}/qnamaker/v4.0/knowledgebases/{kbId}/{environment}/qna?source={source}&changedSince={changedSince}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://< qnamaker-resource-name> .api.cognitiveservices.azure.com).
environment	path	True	EnvironmentType	Menentukan apakah lingkungan adalah Uji atau Prod.
kbId	path	True	string	Id pangkalan pengetahuan.
changedSince	query		string	properti changedSince digunakan untuk mengembalikan semua QnA yang dibuat atau diperbarui setelah durasi waktu tertentu. Pengguna dapat memfilter QnA menurut detik (s), menit (m), jam (h) dan hari (d). Pengguna dapat menggunakan nilai integral apa pun bersama dengan akhiran untuk waktu. Misalnya, nilai 5m mengembalikan semua pasangan QnA yang diperbarui atau dibuat dalam 5 menit terakhir.
source	query		string	Filter properti sumber yang akan diterapkan. Nilai sampel: Editorial, smartLight%20FAQ.tsv .

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
Ocp-Apim-Subscription-Key	True	string

Respons

Nama	Jenis	Deskripsi
200 OK	QnADocumentsDTO	Koleksi semua Q-A di pangkalan pengetahuan.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Jenis: apiKey
Dalam: header

Contoh

Successful query

Permintaan sampel

HTTP

GET {Endpoint}/qnamaker/v4.0/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/Test/qna

Respon sampel

Kode status:: 200

{
  "qnaDocuments": [
    {
      "id": 1,
      "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": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      }
    },
    {
      "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": [
        "How do I programmatically create a KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 3,
            "displayText": "Update KB"
          }
        ]
      }
    },
    {
      "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": "Editorial",
      "questions": [
        "How do I programmatically update my KB?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ],
      "context": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 4,
            "displayText": "Refresh Endpoint Keys"
          }
        ]
      }
    },
    {
      "id": 4,
      "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",
      "source": "Editorial",
      "questions": [
        "How do I programmatically refresh endpoint keys?"
      ],
      "metadata": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      }
    }
  ]
}

Definisi

Nama	Deskripsi
Context	Konteks yang terkait dengan Qna yang akan diperbarui.
EnvironmentType	Menentukan apakah lingkungan adalah Uji atau Prod.
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 sekumpulan 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.
InnerErrorModel	Objek yang berisi informasi yang lebih spesifik tentang kesalahan. Sesuai panduan Microsoft One API - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Nama - pasangan nilai metadata.
PromptDTO	Mintalah jawaban.
Qna	QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO
QnADocumentsDTO	Daftar QnADTO
QnADTO	Objek Q-A.

Context

Objek

Konteks yang terkait dengan Qna yang akan diperbarui.

Nama	Jenis	Deskripsi
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
promptsToAdd	PromptDTO[]	Daftar perintah yang akan ditambahkan ke qna.
promptsToDelete	integer[] (int32)	Daftar perintah yang terkait dengan qna yang akan dihapus

EnvironmentType

Enumeration

Menentukan apakah lingkungan adalah Uji atau Prod.

Nilai	Deskripsi
Prod
Test

Error

Objek

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

Nama	Jenis	Deskripsi
code	ErrorCodeType	Salah satu sekumpulan 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

Enumeration

Salah satu sekumpulan kode kesalahan yang ditentukan server.

Nilai	Deskripsi
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objek

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

Nama	Jenis	Deskripsi
error	Error	Objek kesalahan.

InnerErrorModel

Objek

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

Nama	Jenis	Deskripsi
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.

MetadataDTO

Objek

Nama - pasangan nilai metadata.

Nama	Jenis	Deskripsi
name	string minLength: 1 maxLength: 100	Nama metadata.
value	string minLength: 1 maxLength: 500	Nilai metadata.

PromptDTO

Objek

Mintalah jawaban.

Nama	Jenis	Deskripsi
displayOrder	integer (int32)	Indeks perintah - digunakan dalam urutan perintah
displayText	string maxLength: 200	Teks ditampilkan untuk mewakili perintah pertanyaan tindak lanjut
qna	Qna	QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO
qnaId	integer (int32)	Id Qna yang sesuai dengan perintah - jika QnaId ada, objek QnADTO diabaikan.

Qna

Objek

QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO

Nama	Jenis	Deskripsi
answer	string minLength: 1 maxLength: 25000	Teks jawaban
context	Context	Konteks QnA
id	integer (int32)	Id unik untuk Q-A.
metadata	MetadataDTO[]	Daftar metadata yang terkait dengan jawabannya.
questions	string[]	Daftar pertanyaan yang terkait dengan jawabannya.
source	string maxLength: 300	Sumber tempat Q-A diindeks. misalnya. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnADocumentsDTO

Objek

Daftar QnADTO

Nama	Jenis	Deskripsi
qnaDocuments	QnADTO[]	Daftar jawaban.

QnADTO

Objek

Objek Q-A.

Nama	Jenis	Deskripsi
answer	string minLength: 1 maxLength: 25000	Teks jawaban
context	Context	Konteks QnA
id	integer (int32)	Id unik untuk Q-A.
metadata	MetadataDTO[]	Daftar metadata yang terkait dengan jawabannya.
questions	string[]	Daftar pertanyaan yang terkait dengan jawabannya.
source	string maxLength: 300	Sumber tempat Q-A diindeks. misalnya. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

Bagikan melalui

Knowledgebase - Download

Parameter URI

Header Permintaan

Respons

Keamanan

Ocp-Apim-Subscription-Key

Contoh

Successful query

Permintaan sampel

Respon sampel

Definisi

Context

EnvironmentType

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnADocumentsDTO

QnADTO