Prebuilt - Generate Answer

Referensi

Service:: Cognitive Services - QnA Maker

API Version:: v5.0-preview.2

Panggilan GenerateAnswer untuk mengkueri teks dalam dokumen.

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer

With optional parameters:

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer?stringIndexType={stringIndexType}

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).
stringIndexType	query		string	(Opsional) Menentukan metode yang digunakan untuk menginterpretasikan offset string. Default ke Elemen Teks (Graphemes) menurut Unicode v8.0.0.

Header Permintaan

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

Isi Permintaan

Name	Required	Type	Description
documents	True	TextInput[]	Dokumen yang akan dicari untuk pertanyaan yang diberikan.
question	True	string	Pertanyaan pengguna untuk mengkueri dokumen yang diberikan.
language		string	(Opsional) Bahasa dokumen. Ini adalah representasi ISO 639-1 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris; "es" untuk bahasa Spanyol dll. Jika tidak diatur, gunakan "en" untuk bahasa Inggris sebagai default.

Respons

Name	Type	Description
200 OK	GenerateAnswerBatchResultItem[]	Respons panggilan GenerateAnswer bawaan.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Contoh

Successful query

Sample Request

HTTP

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer


{
  "question": "qna maker and luis",
  "documents": [
    {
      "text": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming",
      "id": "1"
    },
    {
      "text": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming",
      "id": "2"
    }
  ],
  "language": "en"
}

Sample Response

Status code:: 200

{
  "answers": [
    {
      "answer": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming, it is a step up from integrated graphics as proven by comparing it to the UHD 620 GPU in the FHD model.",
      "answerSpan": {
        "endIndex": 82,
        "startIndex": 60,
        "text": "discrete graphics card",
        "score": 0
      },
      "answerEndIndex": 655,
      "answerStartIndex": 0,
      "id": 1,
      "score": 100
    }
  ]
}

Definisi

AnswerSpan	Objek rentang jawaban QnA sehubungan dengan pertanyaan pengguna.
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.
GenerateAnswerBatchResultItem	Mewakili Hasil Jawaban Bawaan.
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.
PrebuiltQuery	Skema isi POST untuk mengkueri dokumen melalui Jawaban Atas Pertanyaan Bawaan.
TextInput	Daftar dokumen yang akan dikueri.

AnswerSpan

Objek rentang jawaban QnA sehubungan dengan pertanyaan pengguna.

Name	Type	Description
endIndex	integer	Akhiri indeks rentang jawaban dalam jawaban.
score	number	Skor rentang jawaban yang diprediksi.
startIndex	integer	Mulai indeks rentang jawaban dalam jawaban.
text	string	Teks rentang jawaban yang diprediksi.

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.

GenerateAnswerBatchResultItem

Mewakili Hasil Jawaban Bawaan.

Name	Type	Description
answer	string	Jawaban.
answerEndIndex	integer	Akhiri indeks jawaban dalam teks dokumen.
answerSpan	AnswerSpan	Jawab objek rentang sehubungan dengan pertanyaan pengguna.
answerStartIndex	integer	Mulai indeks jawaban dalam teks dokumen.
id	string	Id Dokumen.
score	number	Skor hasil pencarian.

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.

PrebuiltQuery

Skema isi POST untuk mengkueri dokumen melalui Jawaban Atas Pertanyaan Bawaan.

Name	Type	Description
documents	TextInput[]	Dokumen yang akan dicari untuk pertanyaan yang diberikan.
language	string	(Opsional) Bahasa dokumen. Ini adalah representasi ISO 639-1 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris; "es" untuk bahasa Spanyol dll. Jika tidak diatur, gunakan "en" untuk bahasa Inggris sebagai default.
question	string	Pertanyaan pengguna untuk mengkueri dokumen yang diberikan.

TextInput

Daftar dokumen yang akan dikueri.

Name	Type	Description
id	string	Pengidentifikasi unik untuk dokumen.
text	string	Isi teks dokumen