Question Answering - Get Answers From Text

Referenz

Dienst:: Azure AI Services

API-Version:: 2023-04-01

Beantwortet die angegebene Frage mithilfe des bereitgestellten Texts im Textkörper.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string (uri)	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
question	True	string	Benutzerfrage, um die angegebenen Textdatensätze abzufragen.
records	True	TextDocument[]	Texteinträge, die nach einer bestimmten Frage durchsucht werden sollen.
language		string	Sprache der Texteinträge. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, verwenden Sie "en" für Englisch als Standard.
stringIndexType		StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Standardeinstellung für Textelemente (Graphemes) gemäß Unicode v8.0.0. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

Antworten

Name	Typ	Beschreibung
200 OK	AnswersFromTextResult	Die Anforderung ist erfolgreich.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Name

Typ

Beschreibung

200 OK

AnswersFromTextResult

Die Anforderung ist erfolgreich.

Other Status Codes

ErrorResponse

Unerwartete Fehlerantwort.

Header

x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

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

Beispiele

Successful query

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:: 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.",
      "answerSpan": {
        "confidenceScore": 0,
        "length": 45,
        "offset": 28,
        "text": "two to four hours"
      },
      "confidenceScore": 0.93,
      "id": "1",
      "length": 224,
      "offset": 0
    },
    {
      "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.",
      "answerSpan": {
        "confidenceScore": 0,
        "length": 25,
        "offset": 8,
        "text": "two to four hours"
      },
      "confidenceScore": 0.92,
      "id": "1",
      "length": 224,
      "offset": 20
    },
    {
      "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.",
      "answerSpan": null,
      "confidenceScore": 0.05,
      "id": "1",
      "length": 244,
      "offset": 110
    }
  ]
}

Definitionen

Name	Beschreibung
AnswersFromTextOptions	Die zu beantwortenden Frage- und Textdatensatzparameter.
AnswersFromTextResult	Stellt die Antwortergebnisse dar.
AnswerSpan	Antwort span-Objekt von QnA.
Error	Das zurückgegebene Fehlerantwortobjekt, wenn beim Verarbeiten der Anforderung fehler auftreten.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Standardeinstellung für Textelemente (Graphemes) gemäß Unicode v8.0.0. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
TextAnswer	Stellt das Antwortergebnis dar.
TextDocument	Stellt den Eingabetextdatensatz dar, der abgefragt werden soll.

AnswersFromTextOptions

Objekt

Die zu beantwortenden Frage- und Textdatensatzparameter.

Name	Typ	Standardwert	Beschreibung
language	string		Sprache der Texteinträge. Dies ist die BCP-47-Darstellung einer Sprache. Verwenden Sie z. B. "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, verwenden Sie "en" für Englisch als Standard.
question	string		Benutzerfrage, um die angegebenen Textdatensätze abzufragen.
records	TextDocument[]		Texteinträge, die nach einer bestimmten Frage durchsucht werden sollen.
stringIndexType	StringIndexType	TextElements_v8	Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Standardeinstellung für Textelemente (Graphemes) gemäß Unicode v8.0.0. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Objekt

Stellt die Antwortergebnisse dar.

Name	Typ	Beschreibung
answers	TextAnswer[]	Stellt die Antwortergebnisse dar.

AnswerSpan

Objekt

Antwort span-Objekt von QnA.

Name	Typ	Beschreibung
confidenceScore	number (double) minimum: 0 maximum: 1	Die geschätzte Bewertung der Antwortspanne liegt zwischen 0 und 1.
length	integer (int32)	Die Länge der Antwortspanne.
offset	integer (int32)	Die Antwortspanne erstreckt sich vom Anfang der Antwort.
text	string	Vorhergesagter Antworttext.

Error

Objekt

Das zurückgegebene Fehlerantwortobjekt, wenn beim Verarbeiten der Anforderung fehler auftreten.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search Index limit reached error
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
Conflict	Konfliktfehler
Forbidden	Fehler beim unzulässigen Zugriff
InternalServerError	Interner Serverfehler
InvalidArgument	Ungültiger Argumentfehler
InvalidRequest	Ungültiger Anforderungsfehler
NotFound	Fehler nicht gefunden
OperationNotFound	Fehler beim Vorgang nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
QuotaExceeded	Fehler "Kontingent überschritten"
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
TooManyRequests	Fehler bei zu vielen Anforderungen
Unauthorized	Fehler beim nicht autorisierten Zugriff
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
EmptyRequest	Fehler "Leere Anforderung"
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidCountryHint	Ungültiger Fehler im Landhinweis
InvalidDocument	Ungültiger Dokumentfehler
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
InvalidRequest	Ungültiger Anforderungsfehler
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
ModelVersionIncorrect	Fehler bei der Modellversion
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

StringIndexType

Enumeration

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenversatzen verwendet wird. Standardeinstellung für Textelemente (Graphemes) gemäß Unicode v8.0.0. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

Wert	Beschreibung
TextElements_v8	Zurückgegebene Offset- und Längenwerte entsprechen textElements (Graphemes und Grapheme-Clustern), die dem Unicode 8.0.0-Standard bestätigen. Verwenden Sie diese Option, wenn Ihre Anwendung in .Net Framework oder .Net Core geschrieben ist und Sie StringInfo verwenden.
UnicodeCodePoint	Zurückgegebene Offset- und Längenwerte entsprechen Unicode-Codepunkten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben wird, die Unicode unterstützt, z. B. Python.
Utf16CodeUnit	Zurückgegebene Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben wird, die Unicode unterstützt, z. B. JavaScript.

TextAnswer

Objekt

Stellt das Antwortergebnis dar.

Name	Typ	Beschreibung
answer	string	Antwort.
answerSpan	AnswerSpan	Antwort-Span-Objekt in Bezug auf die Frage des Benutzers.
confidenceScore	number (double) minimum: 0 maximum: 1	Antwort-Konfidenzbewertung, Der Wert reicht von 0 bis 1.
id	string	Datensatz-ID.
length	integer (int32)	Die Länge des Satzes.
offset	integer (int32)	Der Satzabstand vom Anfang des Dokuments.

TextDocument

Objekt

Stellt den Eingabetextdatensatz dar, der abgefragt werden soll.

Name	Typ	Beschreibung
id	string	Eindeutiger Bezeichner für den Textdatensatz.
text	string	Textinhalt des Datensatzes.

Freigeben über

Question Answering - Get Answers From Text

URI-Parameter

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiche

Beispiele

Successful query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument