Question Answering - Get Answers From Text

Referens

Tjänst:: Cognitive Services - Language

API-version:: 2023-04-01

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

POST {Endpoint}/language/:query-text?api-version=2023-04-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ä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. Detta ä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

AADToken

Det här är Azure Active Directory OAuth2-flöden . När den är kopplad till rollbaserad åtkomstkontroll i Azure kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps resurskonto eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter för att Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan ha åtkomstkontroll för specifika API:er och omfång.

Kommentarer

Den här säkerhetsdefinitionen x-ms-client-idkräver att huvudet används för att ange vilken Azure Maps resurs som programmet begär åtkomst till. Detta kan hämtas från MAPS-hanterings-API:et.

Authorization URL är specifikt för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Rollbaserad åtkomstkontroll i Azure konfigureras från Azure-hanteringsplanet via Azure Portal, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för arbete, skola och gäster, men har inte stöd för personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

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

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	Representerar den indatatextpost som ska efterfrågas.

AnswersFromTextOptions

Fråge- och textpostparametrarna som ska besvaras.

Name	Typ	Standardvärde	Description
language	string		Språk för textposterna. Detta ä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

Representerar svarsresultatet.

Name	Typ	Description
answers	TextAnswer[]	Representerar svarsresultatet.

AnswerSpan

Svarsintervallobjekt för QnA.

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

Error

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 läsbar återgivning av felet.
target	string	Målet för felet.

ErrorCode

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode