Question Answering - Get Answers From Text

Reference

Služba:: Azure AI Services

Verze rozhraní API:: 2021-10-01

Odpoví na zadanou otázku pomocí zadaného textu v textu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Verze rozhraní API klienta.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Text požadavku

Name	Vyžadováno	Typ	Description
question	True	string	Dotaz uživatele, který se má dotazovat na dané textové záznamy.
records	True	TextDocument[]	Textové záznamy, které se mají vyhledat pro danou otázku.
language		string	Jazyk textových záznamů Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu; "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
stringIndexType		StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Ve výchozím nastavení se nastaví textové prvky (grafy) podle unicode v8.0.0. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

Odpovědi

Name	Typ	Description
200 OK	AnswersFromTextResult	Úspěšná odpověď pro získání odpovědí ze vstupního textu
Other Status Codes	ErrorResponse	Chybová odpověď.

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

Příklady

Successful query

Ukázkový požadavek

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"
}

Ukázková odpověď

Stavový kód:: 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
    }
  ]
}

Definice

Name	Description
AnswersFromTextOptions	Parametry dotazu a textového záznamu, na které chcete odpovědět.
AnswersFromTextResult	Představuje výsledky odpovědí.
AnswerSpan	Odpověď span objektu QnA.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Ve výchozím nastavení se nastaví textové prvky (grafy) podle unicode v8.0.0. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.
TextAnswer	Představuje výsledek odpovědi.
TextDocument	Představuje vstupní textový záznam, který se má dotazovat.

AnswersFromTextOptions

Objekt

Parametry dotazu a textového záznamu, na které chcete odpovědět.

Name	Typ	Default value	Description
language	string		Jazyk textových záznamů Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu; "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
question	string		Dotaz uživatele, který se má dotazovat na dané textové záznamy.
records	TextDocument[]		Textové záznamy, které se mají vyhledat pro danou otázku.
stringIndexType	StringIndexType	TextElements_v8	Určuje metodu použitou k interpretaci posunů řetězců. Ve výchozím nastavení se nastaví textové prvky (grafy) podle unicode v8.0.0. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Objekt

Představuje výsledky odpovědí.

Name	Typ	Description
answers	TextAnswer[]	Představuje výsledky odpovědí.

AnswerSpan

Objekt

Odpověď span objektu QnA.

Name	Typ	Description
confidenceScore	number (double) minimum: 0 maximum: 1	Předpokládané skóre rozsahu odpovědí, rozsah hodnot od 0 do 1
length	integer (int32)	Délka rozsahu odpovědí.
offset	integer (int32)	Odpověď se posune od začátku odpovědi.
text	string	Predikovaný text rozsahu odpovědí

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Zpráva o chybě.
target	string	Cíl chyby

StringIndexType

Výčet

Určuje metodu použitou k interpretaci posunů řetězců. Ve výchozím nastavení se nastaví textové prvky (grafy) podle unicode v8.0.0. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

Hodnota	Description
TextElements_v8	Vrácené hodnoty posunu a délky budou odpovídat hodnotám TextElements (Grafemes a Grafeme) potvrzujícím standardu Unicode 8.0.0. Tuto možnost použijte, pokud je vaše aplikace napsaná v rozhraní .Net Framework nebo .Net Core a budete používat StringInfo.
UnicodeCodePoint	Vrácené hodnoty posunu a délky budou odpovídat bodům kódu Unicode. Tuto možnost použijte, pokud je vaše aplikace napsaná v jazyce, který podporuje Unicode, například Python.
Utf16CodeUnit	Vrácené hodnoty posunu a délky budou odpovídat jednotkám kódu UTF-16. Tuto možnost použijte, pokud je vaše aplikace napsaná v jazyce, který podporuje Unicode, například JavaScript.

TextAnswer

Objekt

Představuje výsledek odpovědi.

Name	Typ	Description
answer	string	Odpověď.
answerSpan	AnswerSpan	Odpovězte na objekt rozsahu s ohledem na otázku uživatele.
confidenceScore	number (double) minimum: 0 maximum: 1	odpověď skóre spolehlivosti, rozsahy hodnot od 0 do 1.
id	string	ID záznamu.
length	integer (int32)	Délka věty.
offset	integer (int32)	Odsazení věty od začátku dokumentu

TextDocument

Objekt

Představuje vstupní textový záznam, který se má dotazovat.

Name	Typ	Description
id	string	Jedinečný identifikátor textového záznamu
text	string	Textový obsah záznamu

Sdílet prostřednictvím

Question Answering - Get Answers From Text

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

Příklady

Successful query

Ukázkový požadavek

Ukázková odpověď

Definice

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Další materiály