Question Answering - Get Answers From Text

Odwołanie

Usługa:: Cognitive Services - Language

Wersja interfejsu API:: 2023-04-01

Odpowiada na określone pytanie przy użyciu podanego tekstu w treści.

POST {Endpoint}/language/:query-text?api-version=2023-04-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API klienta.

Treść żądania

Nazwa	Wymagane	Typ	Opis
question	True	string	Pytanie użytkownika dotyczące wykonywania zapytań względem podanych rekordów tekstowych.
records	True	TextDocument[]	Rekordy tekstowe do wyszukania danego pytania.
language		string	Język rekordów tekstowych. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.
stringIndexType		StringIndexType	Określa metodę używaną do interpretowania przesunięć ciągów. Wartość domyślna to Text Elements (Graphemes) zgodnie z unicode v8.0.0. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnswersFromTextResult	Pomyślna odpowiedź na uzyskanie odpowiedzi z tekstu wejściowego.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

AADToken

Są to przepływy OAuth2 usługi Azure Active Directory . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.

Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.

Uwagi

Ta definicja zabezpieczeń wymaga użycia nagłówka x-ms-client-id w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.

Element Authorization URL jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory. * Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST. * Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.

Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługuje kont osobistych.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Klucz subskrypcji zasobu usługi językowej.

Typ: apiKey
W: header

Przykłady

Successful query

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
    }
  ]
}

Definicje

Nazwa	Opis
AnswersFromTextOptions	Parametry zapytania i rekordu tekstowego do udzielenia odpowiedzi.
AnswersFromTextResult	Reprezentuje wyniki odpowiedzi.
AnswerSpan	Odpowiedź obejmuje obiekt pytań i odpowiedzi.
Error	Obiekt error.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Określa metodę używaną do interpretowania przesunięć ciągów. Wartość domyślna to Text Elements (Graphemes) zgodnie z unicode v8.0.0. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.
TextAnswer	Reprezentuje wynik odpowiedzi.
TextDocument	Reprezentuje wejściowy rekord tekstowy do odpytowania.

AnswersFromTextOptions

Parametry zapytania i rekordu tekstowego do udzielenia odpowiedzi.

Nazwa	Typ	Domyślna wartość	Opis
language	string		Język rekordów tekstowych. Jest to reprezentacja języka BCP-47. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.
question	string		Pytanie użytkownika dotyczące wykonywania zapytań względem podanych rekordów tekstowych.
records	TextDocument[]		Rekordy tekstowe do wyszukania danego pytania.
stringIndexType	StringIndexType	TextElements_v8	Określa metodę używaną do interpretowania przesunięć ciągów. Wartość domyślna to Text Elements (Graphemes) zgodnie z unicode v8.0.0. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Reprezentuje wyniki odpowiedzi.

Nazwa	Typ	Opis
answers	TextAnswer[]	Reprezentuje wyniki odpowiedzi.

AnswerSpan

Odpowiedź obejmuje obiekt pytań i odpowiedzi.

Nazwa	Typ	Opis
confidenceScore	number	Przewidywany wynik zakresu odpowiedzi, zakresy wartości z zakresu od 0 do 1.
length	integer	Długość zakresu odpowiedzi.
offset	integer	Przesunięcie zakresu odpowiedzi od początku odpowiedzi.
text	string	Przewidywany tekst zakresu odpowiedzi.

Error

Obiekt error.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt error.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Błąd docelowy.

StringIndexType

Określa metodę używaną do interpretowania przesunięć ciągów. Wartość domyślna to Text Elements (Graphemes) zgodnie z unicode v8.0.0. Aby uzyskać dodatkowe informacje, zobacz https://aka.ms/text-analytics-offsets.

Nazwa	Typ	Opis
TextElements_v8	string	Zwrócone wartości przesunięcia i długości będą odpowiadać elementom TextElements (klastrom Graphemes i Grapheme) potwierdzającym standard Unicode 8.0.0. Użyj tej opcji, jeśli aplikacja jest napisana w programie .Net Framework lub .Net Core i będziesz używać funkcji StringInfo.
UnicodeCodePoint	string	Zwrócone wartości przesunięcia i długości będą odpowiadać punktom kodu Unicode. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład w języku Python.
Utf16CodeUnit	string	Zwrócone wartości przesunięcia i długości będą odpowiadać jednostkom kodu UTF-16. Użyj tej opcji, jeśli aplikacja jest napisana w języku obsługującym kod Unicode, na przykład JavaScript.

TextAnswer

Reprezentuje wynik odpowiedzi.

Nazwa	Typ	Opis
answer	string	Odpowiedź.
answerSpan	AnswerSpan	Odpowiedź obejmuje obiekt w odniesieniu do pytania użytkownika.
confidenceScore	number	odpowiadanie na współczynnik ufności, zakresy wartości z zakresu od 0 do 1.
id	string	identyfikator rekordu.
length	integer	Długość zdania.
offset	integer	Przesunięcie zdania od początku dokumentu.

TextDocument

Reprezentuje wejściowy rekord tekstowy do odpytowania.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator rekordu tekstowego.
text	string	Zawartość tekstowa rekordu.

Udostępnij za pośrednictwem

Question Answering - Get Answers From Text

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

AADToken

Uwagi

Zakresy

Ocp-Apim-Subscription-Key

Przykłady

Successful query

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Dodatkowe zasoby