Question Answering - Get Answers From Text

Referens

Tjänst:: Azure AI Services

API-version:: 2021-10-01

Besvarar den angivna frågan med hjälp av den angivna texten i brödtexten.

POST {Endpoint}/language/:query-text?api-version=2021-10-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

Name	Obligatorisk	Typ	Description
question	True	string	Användarfråga för att fråga mot de angivna textposterna.
records	True	TextDocument[]	Textposter som ska sökas efter en viss fråga.
language		string	Språk för textposterna. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om du inte anger använder du "en" för engelska som standard.
stringIndexType		StringIndexType	Anger den metod som används för att tolka strängförskjutningar. Standardvärdet är Textelement (Graphemes) enligt Unicode v8.0.0. Mer information finns i https://aka.ms/text-analytics-offsets.

Svar

Name	Typ	Description
200 OK	AnswersFromTextResult	Ett lyckat svar för att få svar från indatatext.
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

HTTP

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

Exempelsvar

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

Definitioner

Name	Description
AnswersFromTextOptions	Fråge- och textpostparametrarna som ska besvaras.
AnswersFromTextResult	Representerar svarsresultatet.
AnswerSpan	Svarsintervallobjekt för QnA.
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Anger den metod som används för att tolka strängförskjutningar. Standardvärdet är Textelement (Graphemes) enligt Unicode v8.0.0. Mer information finns i https://aka.ms/text-analytics-offsets.
TextAnswer	Representerar svarsresultat.
TextDocument	Representera indatatextpost som ska frågas.

AnswersFromTextOptions

Objekt

Fråge- och textpostparametrarna som ska besvaras.

Name	Typ	Standardvärde	Description
language	string		Språk för textposterna. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om du inte anger använder du "en" för engelska som standard.
question	string		Användarfråga för att fråga mot de angivna textposterna.
records	TextDocument[]		Textposter som ska sökas efter en viss fråga.
stringIndexType	StringIndexType	TextElements_v8	Anger den metod som används för att tolka strängförskjutningar. Standardvärdet är Textelement (Graphemes) enligt Unicode v8.0.0. Mer information finns i https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Objekt

Representerar svarsresultatet.

Name	Typ	Description
answers	TextAnswer[]	Representerar svarsresultatet.

AnswerSpan

Objekt

Svarsintervallobjekt för QnA.

Name	Typ	Description
confidenceScore	number (double) minimum: 0 maximum: 1	Förutsagd poäng för svarsintervall, värdet varierar från 0 till 1.
length	integer (int32)	Svarsintervallets längd.
offset	integer (int32)	Svarsintervallet förskjuts från början av svaret.
text	string	Förutsagd text för svarsintervall.

Error

Objekt

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

StringIndexType

Uppräkning

Anger den metod som används för att tolka strängförskjutningar. Standardvärdet är Textelement (Graphemes) enligt Unicode v8.0.0. Mer information finns i https://aka.ms/text-analytics-offsets.

Värde	Description
TextElements_v8	Returnerade förskjutnings- och längdvärden motsvarar TextElements (Graphemes- och Grapheme-kluster) som bekräftar unicode 8.0.0-standarden. Använd det här alternativet om ditt program är skrivet i .Net Framework eller .Net Core och du kommer att använda StringInfo.
UnicodeCodePoint	Returnerade förskjutnings- och längdvärden motsvarar Unicode-kodpunkter. Använd det här alternativet om programmet är skrivet på ett språk som stöder Unicode, till exempel Python.
Utf16CodeUnit	Returnerade förskjutnings- och längdvärden motsvarar UTF-16-kodenheter. Använd det här alternativet om ditt program är skrivet på ett språk som stöder Unicode, till exempel Java, JavaScript.

TextAnswer

Objekt

Representerar svarsresultat.

Name	Typ	Description
answer	string	Svar.
answerSpan	AnswerSpan	Svarsintervallobjekt med avseende på användarens fråga.
confidenceScore	number (double) minimum: 0 maximum: 1	svarssäkerhetspoäng, värdet varierar från 0 till 1.
id	string	post-ID.
length	integer (int32)	Längden på meningen.
offset	integer (int32)	Meningsförskjutningen från början av dokumentet.

TextDocument

Objekt

Representera indatatextpost som ska frågas.

Name	Typ	Description
id	string	Unik identifierare för textposten.
text	string	Textinnehåll i posten.

Dela via

Question Answering - Get Answers From Text

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Successful query

Exempelbegäran

Exempelsvar

Definitioner

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Ytterligare resurser