Question Answering - Get Answers From Text

Service:: Azure AI Services

API-versie:: 2023-04-01

Beantwoordt de opgegeven vraag met behulp van de verstrekte tekst in de hoofdtekst.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string (uri)	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Vereist	Type	Description
question	True	string	Gebruikersvraag om een query uit te voeren op de opgegeven tekstrecords.
records	True	TextDocument[]	Tekstrecords die moeten worden doorzocht op een bepaalde vraag.
language		string	Taal van de tekstrecords. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels; "es" voor Spaans enz. Als deze optie niet is ingesteld, gebruikt u 'en' voor engels als standaardinstelling.
stringIndexType		StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Standaard ingesteld op tekstelementen (Graphemes) volgens Unicode v8.0.0. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

Antwoorden

Name	Type	Description
200 OK	AnswersFromTextResult	De aanvraag is voltooid.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

AnswersFromTextResult

De aanvraag is voltooid.

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

Successful query

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
AnswersFromTextOptions	De vraag en tekst nemen parameters op om te beantwoorden.
AnswersFromTextResult	Vertegenwoordigt de antwoordresultaten.
AnswerSpan	Antwoordbereikobject van QnA.
Error	Het foutantwoordobject wordt geretourneerd wanneer de service enkele fouten tegenkomt tijdens het verwerken van de aanvraag.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Standaard ingesteld op tekstelementen (Graphemes) volgens Unicode v8.0.0. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.
TextAnswer	Vertegenwoordigt antwoordresultaat.
TextDocument	Vertegenwoordig de invoertekstrecord die moet worden opgevraagd.

AnswersFromTextOptions

Object

De vraag en tekst nemen parameters op om te beantwoorden.

Name	Type	Default value	Description
language	string		Taal van de tekstrecords. Dit is BCP-47-weergave van een taal. Gebruik bijvoorbeeld 'en' voor Engels; "es" voor Spaans enz. Als deze optie niet is ingesteld, gebruikt u 'en' voor engels als standaardinstelling.
question	string		Gebruikersvraag om een query uit te voeren op de opgegeven tekstrecords.
records	TextDocument[]		Tekstrecords die moeten worden doorzocht op een bepaalde vraag.
stringIndexType	StringIndexType	TextElements_v8	Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Standaard ingesteld op tekstelementen (Graphemes) volgens Unicode v8.0.0. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

AnswersFromTextResult

Object

Vertegenwoordigt de antwoordresultaten.

Name	Type	Description
answers	TextAnswer[]	Vertegenwoordigt de antwoordresultaten.

AnswerSpan

Object

Antwoordbereikobject van QnA.

Name	Type	Description
confidenceScore	number (double) minimum: 0 maximum: 1	Voorspelde score van antwoordspanne, waarde varieert van 0 tot 1.
length	integer (int32)	De lengte van het antwoordbereik.
offset	integer (int32)	De verschuiving van het antwoordbereik vanaf het begin van het antwoord.
text	string	Voorspelde tekst van antwoordbereik.

Error

Object

Het foutantwoordobject wordt geretourneerd wanneer de service enkele fouten tegenkomt tijdens het verwerken van de aanvraag.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Opsomming

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidArgument	Ongeldig argumentfout
Unauthorized	Fout bij onbevoegde toegang
Forbidden	Fout bij verboden toegang
NotFound	Fout niet gevonden
ProjectNotFound	De fout Project is niet gevonden
OperationNotFound	Fout bij bewerking niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchIndexNotFound	Fout bij azure Cognitive Search-index is niet gevonden
TooManyRequests	Fout bij te veel aanvragen
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexlimiet bereikt fout
InternalServerError	Interne serverfout
ServiceUnavailable	Fout over niet-beschikbaar service
Timeout	Time-outfout
QuotaExceeded	Fout over overschreden quotum
Conflict	Conflict fout
Warning	Waarschuwingsfout

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Opsomming

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidParameterValue	Fout met ongeldige parameterwaarde
KnowledgeBaseNotFound	Fout in Knowledge Base is niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
ExtractionFailure	Fout bij extractiefout
InvalidRequestBodyFormat	Fout bij ongeldige indeling van aanvraagtekst
EmptyRequest	Fout bij lege aanvraag
MissingInputDocuments	Fout bij ontbrekende invoerdocumenten
InvalidDocument	Ongeldige documentfout
ModelVersionIncorrect	Fout bij onjuiste modelversie
InvalidDocumentBatch	Ongeldige documentbatchfout
UnsupportedLanguageCode	Fout met niet-ondersteunde taalcode
InvalidCountryHint	Fout met ongeldige landhint

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

StringIndexType

Opsomming

Hiermee geeft u de methode op die wordt gebruikt om tekenreeksverschuivingen te interpreteren. Standaard ingesteld op tekstelementen (Graphemes) volgens Unicode v8.0.0. Zie https://aka.ms/text-analytics-offsetsvoor meer informatie.

Waarde	Description
TextElements_v8	Geretourneerde offset- en lengtewaarden komen overeen met TextElements-clusters (Graphemes- en Grapheme-clusters) die worden bevestigd aan de Unicode 8.0.0-standaard. Gebruik deze optie als uw toepassing is geschreven in .Net Framework of .Net Core en u stringInfo gaat gebruiken.
UnicodeCodePoint	Geretourneerde offset- en lengtewaarden komen overeen met Unicode-codepunten. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld Python.
Utf16CodeUnit	Geretourneerde offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Unicode ondersteunt, bijvoorbeeld JavaScript.

TextAnswer

Object

Vertegenwoordigt antwoordresultaat.

Name	Type	Description
answer	string	Antwoorden.
answerSpan	AnswerSpan	Answer span object met betrekking tot de vraag van de gebruiker.
confidenceScore	number (double) minimum: 0 maximum: 1	Antwoordbetrouwbaarheidsscore, waarde varieert van 0 tot 1.
id	string	record-ID.
length	integer (int32)	De lengte van de zin.
offset	integer (int32)	De zin wordt verschoven van het begin van het document.

TextDocument

Object

Vertegenwoordig de invoertekstrecord die moet worden opgevraagd.

Name	Type	Description
id	string	Unieke id voor de tekstrecord.
text	string	De tekstinhoud van de record.