Question Answering - Get Answers From Text

Reference

Service:: Cognitive Services - Language

API Version:: 2023-04-01

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

POST {Endpoint}/language/:query-text?api-version=2023-04-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.

Text požadavku

Name	Vyžadováno	Typ	Description
question	True	string	Otázka 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 pro angličtinu použijte "en"; "es" pro španělštinu atd. Pokud není nastaveno, jako výchozí použijte "en" pro angličtinu.
stringIndexType		StringIndexType	Určuje metodu použitou k interpretaci posunů řetězců. Výchozí hodnota je Text Elements (Graphemes) 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í

AADToken

Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.

Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.

Poznámky

Tato definice zabezpečení vyžaduje použití hlavičky x-ms-client-id k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.

Je Authorization URL specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory. * Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API. * Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.

Azure Active Directory verze 1.0 nebo 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Klíč předplatného pro prostředek služby jazyka.

Type: apiKey
In: header

Příklady

Successful query

Sample Request

HTTP

POST {Endpoint}/language/:query-text?api-version=2023-04-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
    }
  ]
}

Definice

Name	Description
AnswersFromTextOptions	Parametry dotazu a textového záznamu, na které chcete odpovědět.
AnswersFromTextResult	Představuje výsledky odpovědi.
AnswerSpan	Answer span object of QnA.
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – 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ů. Výchozí hodnota je Text Elements (Graphemes) 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ý má být dotazován.

AnswersFromTextOptions

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

Name	Typ	Výchozí hodnota	Description
language	string		Jazyk textových záznamů. Toto je reprezentace jazyka BCP-47. Například pro angličtinu použijte "en"; "es" pro španělštinu atd. Pokud není nastaveno, jako výchozí použijte "en" pro angličtinu.
question	string		Otázka 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ů. Výchozí hodnota je Text Elements (Graphemes) podle Unicode v8.0.0. Další informace najdete v tématu https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Představuje výsledky odpovědi.

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

AnswerSpan

Answer span object of QnA.

Name	Typ	Description
confidenceScore	number	Predikované skóre rozsahu odpovědí, rozsahy hodnot od 0 do 1.
length	integer	Délka rozsahu odpovědí.
offset	integer	Rozsah odpovědi se posune od začátku odpovědi.
text	string	Predikovaný text rozsahu odpovědí

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definovaných chybových kódů.
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 o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

Name	Typ	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode