Question Answering - Get Answers From Text

Referensi

Service:: Cognitive Services

API Version:: 2021-10-01

Menjawab pertanyaan yang ditentukan menggunakan teks yang disediakan dalam isi.

POST {Endpoint}/language/:query-text?api-version=2021-10-01

Parameter URI

Name	In	Required	Type	Description
Endpoint	path	True	string	Titik akhir Cognitive Services yang didukung (misalnya, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versi API klien.

Header Permintaan

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

Isi Permintaan

Name	Required	Type	Description
question	True	string	Pertanyaan pengguna untuk mengkueri rekaman teks yang diberikan.
records	True	TextDocument[]	Rekaman teks yang akan dicari untuk pertanyaan yang diberikan.
language		string	Bahasa rekaman teks. Ini adalah representasi BCP-47 dari sebuah bahasa. Misalnya, gunakan "en" untuk bahasa Inggris; "es" untuk bahasa Spanyol dll. Jika tidak diatur, gunakan "en" untuk bahasa Inggris sebagai default.
stringIndexType		StringIndexType	Menentukan metode yang digunakan untuk menginterpretasikan offset string. Default ke Elemen Teks (Graphemes) menurut Unicode v8.0.0. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets.

Respons

Name	Type	Description
200 OK	AnswersFromTextResult	Respons yang berhasil untuk mendapatkan jawaban dari teks input.
Other Status Codes	ErrorResponse	Respons kesalahan.

Keamanan

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Contoh

Successful query

Sample Request

HTTP

POST {Endpoint}/language/:query-text?api-version=2021-10-01


{
  "question": "how long it takes to charge surface?",
  "records": [
    {
      "id": "1",
      "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
    },
    {
      "id": "2",
      "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface."
    }
  ],
  "language": "en"
}

Sample Response

Status code:: 200

{
  "answers": [
    {
      "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "confidenceScore": 0.93,
      "id": "1",
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0,
        "offset": 28,
        "length": 45
      },
      "offset": 0,
      "length": 224
    },
    {
      "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "confidenceScore": 0.92,
      "id": "1",
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0,
        "offset": 8,
        "length": 25
      },
      "offset": 20,
      "length": 224
    },
    {
      "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "confidenceScore": 0.05,
      "id": "1",
      "answerSpan": null,
      "offset": 110,
      "length": 244
    }
  ]
}

Definisi

AnswersFromTextOptions	Parameter rekaman pertanyaan dan teks untuk dijawab.
AnswersFromTextResult	Mewakili hasil jawaban.
AnswerSpan	Objek rentang jawaban QnA.
Error	Objek kesalahan.
ErrorCode	Kode kesalahan yang dapat dibaca manusia.
ErrorResponse	Respons kesalahan.
InnerErrorCode	Kode kesalahan yang dapat dibaca manusia.
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.
StringIndexType	Menentukan metode yang digunakan untuk menginterpretasikan offset string. Default ke Elemen Teks (Graphemes) menurut Unicode v8.0.0. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets.
TextAnswer	Mewakili hasil jawaban.
TextDocument	Mewakili rekaman teks input yang akan dikueri.

AnswersFromTextOptions

Parameter rekaman pertanyaan dan teks untuk dijawab.

Name	Type	Default Value	Description
language	string		Bahasa rekaman teks. Ini adalah representasi BCP-47 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 rekaman teks yang diberikan.
records	TextDocument[]		Rekaman teks yang akan dicari untuk pertanyaan yang diberikan.
stringIndexType	StringIndexType	TextElements_v8	Menentukan metode yang digunakan untuk menginterpretasikan offset string. Default ke Elemen Teks (Graphemes) menurut Unicode v8.0.0. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Mewakili hasil jawaban.

Name	Type	Description
answers	TextAnswer[]	Mewakili hasil jawaban.

AnswerSpan

Objek rentang jawaban QnA.

Name	Type	Description
confidenceScore	number	Prediksi skor rentang jawaban, nilai berkisar antara 0 hingga 1.
length	integer	Panjang rentang jawaban.
offset	integer	Rentang jawaban offset dari awal jawaban.
text	string	Teks rentang jawaban yang diprediksi.

Error

Objek kesalahan.

Name	Type	Description
code	ErrorCode	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.

ErrorCode

Kode kesalahan yang dapat dibaca manusia.

Name	Type	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Respons kesalahan.

Name	Type	Description
error	Error	Objek kesalahan.

InnerErrorCode

Kode kesalahan yang dapat dibaca manusia.

Name	Type	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

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	InnerErrorCode	Salah satu set kode kesalahan yang ditentukan server.
details	object	Detail kesalahan.
innererror	InnerErrorModel	Objek yang berisi informasi yang lebih spesifik daripada objek saat ini tentang kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

StringIndexType

Menentukan metode yang digunakan untuk menginterpretasikan offset string. Default ke Elemen Teks (Graphemes) menurut Unicode v8.0.0. Untuk informasi tambahan lihat https://aka.ms/text-analytics-offsets.

Name	Type	Description
TextElements_v8	string	Nilai offset dan panjang yang dikembalikan akan sesuai dengan TextElements (kluster Graphemes dan Grapheme) yang mengonfirmasi ke standar Unicode 8.0.0. Gunakan opsi ini jika aplikasi Anda ditulis dalam .Net Framework atau .Net Core dan Anda akan menggunakan StringInfo.
UnicodeCodePoint	string	Nilai offset dan panjang yang dikembalikan akan sesuai dengan titik kode Unicode. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Python.
Utf16CodeUnit	string	Nilai offset dan panjang yang dikembalikan akan sesuai dengan unit kode UTF-16. Gunakan opsi ini jika aplikasi Anda ditulis dalam bahasa yang mendukung Unicode, misalnya Java, JavaScript.

TextAnswer

Mewakili hasil jawaban.

Name	Type	Description
answer	string	Jawaban.
answerSpan	AnswerSpan	Jawab objek rentang sehubungan dengan pertanyaan pengguna.
confidenceScore	number	menjawab skor keyakinan, nilai berkisar dari 0 hingga 1.
id	string	ID rekaman.
length	integer	Panjang kalimat.
offset	integer	Offset kalimat dari awal dokumen.

TextDocument

Mewakili rekaman teks input yang akan dikueri.

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