Runtime - Generate Answer

Referensi

Service:: Cognitive Services - QnA Maker

API Version:: 4.0

Panggilan GenerateAnswer untuk menanyakan basis pengetahuan.

POST {RuntimeEndpoint}/qnamaker/knowledgebases/{kbId}/generateAnswer

Parameter URI

Name	In	Required	Type	Description
kbId	path	True	string	Id pangkalan pengetahuan.
RuntimeEndpoint	path	True	string	Titik akhir App Service QnA Maker (misalnya: https://{qnaservice-hostname}.azurewebsites.net).

Header Permintaan

Name	Required	Type	Description
Authorization	True	string

Isi Permintaan

Name	Type	Description
context	Context	Objek konteks dengan informasi QnA sebelumnya.
isTest	boolean	Kueri terhadap indeks pengujian.
qnaId	string	QnaId yang tepat untuk diambil dari pangkalan pengetahuan, bidang ini lebih diprioritaskan daripada pertanyaan.
question	string	Pertanyaan pengguna untuk mengkueri terhadap Pangkalan Pengetahuan.
rankerType	string	Bidang opsional. Atur ke 'QuestionOnly' untuk menggunakan Ranker pertanyaan saja.
scoreThreshold	number	Ambang untuk jawaban yang dikembalikan berdasarkan skor.
strictFilters	MetadataDTO[]	Temukan hanya jawaban yang berisi metadata ini.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Bidang opsional. Atur ke OR untuk menggunakan OR sebagai Operasi untuk Filter Ketat.
top	integer	Jumlah maksimum jawaban yang akan dikembalikan untuk pertanyaan tersebut.
userId	string	Pengidentifikasi unik untuk pengguna. Parameter opsional untuk telemetri. Untuk informasi selengkapnya, lihat Analitik dan Telemetri.

Respons

Name	Type	Description
200 OK	QnASearchResultList	Respons panggilan GenerateAnswer.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Authorization

Type: apiKey
In: header

Contoh

Successful query

Sample Request

HTTP

POST {RuntimeEndpoint}/qnamaker/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/generateAnswer


{
  "question": "qna maker and luis",
  "top": 6,
  "isTest": true,
  "scoreThreshold": 20,
  "strictFilters": [
    {
      "name": "category",
      "value": "api"
    }
  ],
  "userId": "sd53lsY="
}

Sample Response

Status code:: 200

{
  "answers": [
    {
      "score": 28.54820341616869,
      "id": 20,
      "answer": "There is no direct integration of LUIS with QnA Maker. But, in your bot code, you can use LUIS and QnA Maker together.",
      "source": "Custom Editorial",
      "questions": [
        "How can I integrate LUIS with QnA Maker?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ]
    }
  ]
}

Definisi

Context	Konteks QnA
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
QnASearchResult	Mewakili Hasil Pencarian.
QnASearchResultList	Mewakili Daftar Jawaban Atas Pertanyaan.
QueryDTO	Skema isi POST untuk mengkueri pangkalan pengetahuan.
StrictFiltersCompoundOperationType	Bidang opsional. Atur ke OR untuk menggunakan OR sebagai Operasi untuk Filter Ketat.

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.

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

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

QnASearchResult

Mewakili Hasil Pencarian.

Name	Type	Description
answer	string	Jawaban.
context	Context	Objek konteks QnA
id	integer	Id hasil QnA.
metadata	MetadataDTO[]	Daftar metadata.
questions	string[]	Daftar pertanyaan.
score	number	Skor hasil pencarian.
source	string	Sumber hasil QnA.

QnASearchResultList

Mewakili Daftar Jawaban Atas Pertanyaan.

Name	Type	Description
answers	QnASearchResult[]	Mewakili daftar Hasil Pencarian.

QueryDTO

Skema isi POST untuk mengkueri pangkalan pengetahuan.

Name	Type	Description
context	Context	Objek konteks dengan informasi QnA sebelumnya.
isTest	boolean	Kueri terhadap indeks pengujian.
qnaId	string	QnaId yang tepat untuk diambil dari pangkalan pengetahuan, bidang ini lebih diprioritaskan daripada pertanyaan.
question	string	Pertanyaan pengguna untuk mengkueri terhadap Pangkalan Pengetahuan.
rankerType	string	Bidang opsional. Atur ke 'QuestionOnly' untuk menggunakan Ranker pertanyaan saja.
scoreThreshold	number	Ambang untuk jawaban yang dikembalikan berdasarkan skor.
strictFilters	MetadataDTO[]	Temukan hanya jawaban yang berisi metadata ini.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Bidang opsional. Atur ke OR untuk menggunakan OR sebagai Operasi untuk Filter Ketat.
top	integer	Jumlah maksimum jawaban yang akan dikembalikan untuk pertanyaan tersebut.
userId	string	Pengidentifikasi unik untuk pengguna. Parameter opsional untuk telemetri. Untuk informasi selengkapnya, lihat Analitik dan Telemetri.

StrictFiltersCompoundOperationType

Bidang opsional. Atur ke OR untuk menggunakan OR sebagai Operasi untuk Filter Ketat.

Name	Type	Description
AND	string
OR	string