Delen via


Question Answering - Get Answers From Text

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

POST {Endpoint}/language/:query-text?api-version=2021-10-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.

Aanvraagkoptekst

Name Vereist Type Description
Ocp-Apim-Subscription-Key True

string

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 gezocht naar 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

Een geslaagd antwoord om antwoorden te krijgen op basis van invoertekst.

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

POST {Endpoint}/language/:query-text?api-version=2021-10-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

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

Antwoordbereikobject van QnA.

Error

Het foutobject.

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

De vraag- en tekstrecordparameters die moeten worden beantwoord.

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 gezocht naar 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

Vertegenwoordigt de antwoordresultaten.

Name Type Description
answers

TextAnswer[]

Vertegenwoordigt de antwoordresultaten.

AnswerSpan

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

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

Leesbare foutcode.

Waarde Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Foutreactie.

Name Type Description
error

Error

Het foutobject.

InnerErrorCode

Leesbare foutcode.

Waarde Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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.

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

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

Vertegenwoordigt antwoordresultaat.

Name Type Description
answer

string

Antwoord.

answerSpan

AnswerSpan

Antwoordbereikobject met betrekking tot de vraag van de gebruiker.

confidenceScore

number (double)

minimum: 0
maximum: 1

betrouwbaarheidsscore beantwoorden, 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

Vertegenwoordig de invoertekstrecord die moet worden opgevraagd.

Name Type Description
id

string

Unieke id voor de tekstrecord.

text

string

De tekstinhoud van de record.