Question Answering - Get Answers From Text

Referentie

Service:: Cognitive Services - Language

API-versie:: 2023-04-01

Beantwoordt de opgegeven vraag met behulp van de opgegeven 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	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Client-API-versie.

Aanvraagbody

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

Antwoorden

Name	Type	Description
200 OK	AnswersFromTextResult	Een geslaagd antwoord om antwoorden te krijgen op basis van invoertekst.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

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

Bereiken

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

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

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

Definities

Name	Description
AnswersFromTextOptions	De vraag- en tekstrecordparameters die moeten worden beantwoord.
AnswersFromTextResult	Vertegenwoordigt de antwoordresultaten.
AnswerSpan	Answer Span-object van QnA.
Error	Het foutobject.
ErrorCode	Door mensen leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Door mensen leesbare foutcode.
InnerErrorModel	Een object met specifiekere 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 die wordt gebruikt voor het interpreteren van tekenreeks offsets. De standaardinstelling is Tekstelementen (Graphemes) volgens Unicode v8.0.0. Zie voor meer informatie https://aka.ms/text-analytics-offsets.
TextAnswer	Vertegenwoordigt antwoordresultaat.
TextDocument	Vertegenwoordigt de invoertekstrecord die moet worden opgevraagd.

AnswersFromTextOptions

De vraag- en tekstrecordparameters die moeten worden beantwoord.

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

AnswersFromTextResult

Vertegenwoordigt de antwoordresultaten.

Name	Type	Description
answers	TextAnswer[]	Vertegenwoordigt de antwoordresultaten.

AnswerSpan

Answer Span-object van QnA.

Name	Type	Description
confidenceScore	number	Voorspelde score van antwoordbereik, waarde varieert van 0 tot 1.
length	integer	De lengte van het antwoordbereik.
offset	integer	De verschuiving van de antwoordbereik vanaf het begin van het antwoord.
text	string	Voorspelde tekst van antwoordbereik.

Error

Het foutobject.

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

ErrorCode

Door mensen leesbare foutcode.

Name	Type	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

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Door mensen leesbare foutcode.

Name	Type	Description
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

Een object met specifiekere 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 specifiekere informatie dan het huidige object over de fout.
message	string	Foutbericht.
target	string	Foutdoel.

StringIndexType

Hiermee geeft u de methode die wordt gebruikt voor het interpreteren van tekenreeks offsets. De standaardinstelling is Tekstelementen (Graphemes) volgens Unicode v8.0.0. Zie voor meer informatie https://aka.ms/text-analytics-offsets.

Name	Type	Description
TextElements_v8	string	De geretourneerde offset- en lengtewaarden komen overeen met TextElements (Graphemes en Grapheme-clusters) die de Unicode 8.0.0-standaard bevestigen. Gebruik deze optie als uw toepassing is geschreven in .Net Framework of .Net Core en u StringInfo gebruikt.
UnicodeCodePoint	string	Geretourneerde offset- en lengtewaarden komen overeen met Unicode-codepunten. Gebruik deze optie als uw toepassing is geschreven in een taal die Ondersteuning biedt voor Unicode, bijvoorbeeld Python.
Utf16CodeUnit	string	Geretourneerde offset- en lengtewaarden komen overeen met UTF-16-code-eenheden. Gebruik deze optie als uw toepassing is geschreven in een taal die Ondersteuning biedt voor Unicode, bijvoorbeeld Java of JavaScript.

TextAnswer

Vertegenwoordigt antwoordresultaat.

Name	Type	Description
answer	string	Antwoord.
answerSpan	AnswerSpan	Answer span object met betrekking tot de vraag van de gebruiker.
confidenceScore	number	betrouwbaarheidsscore beantwoorden, waarde varieert van 0 tot 1.
id	string	record-id.
length	integer	De lengte van de zin.
offset	integer	De zinsverschil vanaf het begin van het document.

TextDocument

Vertegenwoordigt de invoertekstrecord die moet worden opgevraagd.

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

Delen via

Question Answering - Get Answers From Text

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

AADToken

Notities

Bereiken

Ocp-Apim-Subscription-Key

Voorbeelden

Successful query

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Aanvullende resources