Question Answering - Get Answers From Text

Referenz

Dienst:: Cognitive Services - Language

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	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Client-API-Version.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	AnswersFromTextResult	Eine erfolgreiche Antwort, um Antworten aus Eingabetext zu erhalten.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

AADToken

Dies sind die Azure Active Directory OAuth2 Flows. Wenn sie mit der rollenbasierten Zugriffssteuerung in Azure gekoppelt ist, kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder jedem Dienstprinzipal kann Zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.

Zum Implementieren von Szenarien empfiehlt es sich, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die auf bestimmte APIs und Bereiche zugreifen können.

Hinweise

Diese Sicherheitsdefinition erfordert die Verwendung des x-ms-client-id Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.

Der Authorization URL ist spezifisch für die öffentliche Azure-Cloud-instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen. * Die rollenbasierte Zugriffssteuerung in Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert. * Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.

Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Work, School und Guests, aber keine persönlichen Konten.

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

Bereiche

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

Ocp-Apim-Subscription-Key

Ein Abonnementschlüssel für eine Sprachdienstressource.

Typ: apiKey
In: header

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.",
      "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
    }
  ]
}

Definitionen

Name	Beschreibung
AnswersFromTextOptions	Die zu beantwortenden Frage- und Textdatensatzparameter.
AnswersFromTextResult	Stellt die Antwortergebnisse dar.
AnswerSpan	Antwortspanneobjekt von QnA.
Error	Das Fehlerobjekt.
ErrorCode	Für Menschen lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Für Menschen 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 Zeichenfolgenoffsets verwendet wird. Standardmäßig wird Textelemente (Graphemes) gemäß Unicode v8.0.0 festgelegt. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.
TextAnswer	Stellt das Antwortergebnis dar.
TextDocument	Stellt den abzufragten Eingabetextdatensatz dar.

AnswersFromTextOptions

Die zu beantwortenden Frage- und Textdatensatzparameter.

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

AnswersFromTextResult

Stellt die Antwortergebnisse dar.

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

AnswerSpan

Antwortspanneobjekt von QnA.

Name	Typ	Beschreibung
confidenceScore	number	Vorhergesagte Bewertung der Antwortspanne, Der Wert liegt zwischen 0 und 1.
length	integer	Die Länge der Antwortspanne.
offset	integer	Der Offset der Antwortspanne vom Anfang der Antwort.
text	string	Vorhergesagter Text der Antwortspanne.

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer der vom Server definierten 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 für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
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

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
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

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	Einer der vom Server definierten 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

Gibt die Methode an, die zum Interpretieren von Zeichenfolgenoffsets verwendet wird. Standardmäßig wird Textelemente (Graphemes) gemäß Unicode v8.0.0 festgelegt. Weitere Informationen finden Sie unter https://aka.ms/text-analytics-offsets.

Name	Typ	Beschreibung
TextElements_v8	string	Die zurückgegebenen Offset- und Längenwerte entsprechen TextElements (Grapheme- und Graphemcluster), die den 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	string	Zurückgegebene Offset- und Längenwerte entsprechen Unicode-Codepunkten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben ist, die Unicode unterstützt, z. B. Python.
Utf16CodeUnit	string	Zurückgegebene Offset- und Längenwerte entsprechen UTF-16-Codeeinheiten. Verwenden Sie diese Option, wenn Ihre Anwendung in einer Sprache geschrieben ist, die Unicode unterstützt, z. B. Java, JavaScript.

TextAnswer

Stellt das Antwortergebnis dar.

Name	Typ	Beschreibung
answer	string	Antwort:
answerSpan	AnswerSpan	Antwort span-Objekt in Bezug auf die Frage des Benutzers.
confidenceScore	number	Antwort Konfidenzbewertung, Der Wert liegt zwischen 0 und 1.
id	string	Datensatz-ID.
length	integer	Die Länge des Satzes.
offset	integer	Der Satzoffset vom Anfang des Dokuments.

TextDocument

Stellt den abzufragten Eingabetextdatensatz dar.

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

AADToken

Hinweise

Bereiche

Ocp-Apim-Subscription-Key

Beispiele

Successful query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Zusätzliche Ressourcen