Knowledgebase - Download

Referensi

Service:: Cognitive Services - QnA Maker

API Version:: 4.0

Unduh basis pengetahuan.

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

With optional parameters:

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

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).
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 TJ 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

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

Respons

Name	Type	Description
200 OK	QnADocumentsDTO	Koleksi semua Q-A di pangkalan pengetahuan.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Contoh

Successful query

Sample Request

HTTP

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

Sample Response

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

Context	Konteks QnA
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 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.
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.
MetadataDTO	Nama - pasangan nilai metadata.
PromptDTO	Minta jawaban.
Qna	QnADTO - Baik QnaId atau QnADTO perlu ada dalam objek PromptDTO
QnADocumentsDTO	Daftar QnADTO
QnADTO	Objek Q-A.

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.

EnvironmentType

Menentukan apakah lingkungan adalah Uji atau Prod.

Name	Type	Description
Prod	string
Test	string

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.

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.

MetadataDTO

Nama - pasangan nilai metadata.

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

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

QnADocumentsDTO

Daftar QnADTO

Name	Type	Description
qnaDocuments	QnADTO[]	Daftar jawaban.

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