Prebuilt - Generate Answer

Usługa:

Azure AI Services

Wersja interfejsu API:

v5.0-preview.2

GenerateAnswer wywołanie zapytania o tekst w dokumentach.

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer

Z parametrami opcjonalnymi:

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer?stringIndexType={stringIndexType}

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
stringIndexType	query		string	(Opcjonalnie) Określa metodę używaną do interpretowania przesunięć ciągów. Wartość domyślna to Text Elements (Graphemes) zgodnie z Unicode w wersji 8.0.0.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Nazwa	Wymagane	Typ	Opis
documents	True	TextInput[]	Dokumenty, które mają być wyszukiwane w danym pytaniu.
question	True	string	Pytanie użytkownika dotyczące wykonywania zapytań dotyczących podanych dokumentów.
language		string minLength: 2 maxLength: 100	(Opcjonalnie) Język dokumentów. Jest to reprezentacja języka ISO 639-1. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GenerateAnswerBatchResultItem[]	Wstępnie utworzona odpowiedź wywołania GenerateAnswer.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Typ: apiKey
W: header

Przykłady

Successful query

Przykładowe żądanie

HTTP

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer


{
  "question": "qna maker and luis",
  "documents": [
    {
      "text": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming",
      "id": "1"
    },
    {
      "text": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming",
      "id": "2"
    }
  ],
  "language": "en"
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "answers": [
    {
      "answer": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming, it is a step up from integrated graphics as proven by comparing it to the UHD 620 GPU in the FHD model.",
      "answerSpan": {
        "endIndex": 82,
        "startIndex": 60,
        "text": "discrete graphics card",
        "score": 0
      },
      "answerEndIndex": 655,
      "answerStartIndex": 0,
      "id": 1,
      "score": 100
    }
  ]
}

Definicje

Nazwa	Opis
AnswerSpan	Odpowiedź obejmuje obiekt pytań i odpowiedzi w odniesieniu do pytania użytkownika.
Error	Obiekt błędu. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
ErrorResponse	Odpowiedź na błąd. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GenerateAnswerBatchResultItem	Reprezentuje wstępnie utworzony wynik odpowiedzi.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PrebuiltQuery	Schemat treści POST do wykonywania zapytań dotyczących dokumentów za pomocą wstępnie utworzonej odpowiedzi na pytania.
TextInput	Lista dokumentów do odpytowania.

AnswerSpan

Objekt

Odpowiedź obejmuje obiekt pytań i odpowiedzi w odniesieniu do pytania użytkownika.

Nazwa	Typ	Opis
endIndex	integer (int32)	Końcowy indeks zakresu odpowiedzi w odpowiedzi.
score	number (double)	Przewidywana ocena zakresu odpowiedzi.
startIndex	integer (int32)	Rozpocznij indeks zakresu odpowiedzi w odpowiedzi.
text	string	Przewidywany tekst zakresu odpowiedzi.

Error

Objekt

Obiekt błędu. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	ErrorCodeType	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innerError	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCodeType

Wyliczanie

Jeden z zdefiniowanych przez serwer zestaw kodów błędów.

Wartość	Opis
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objekt

Odpowiedź na błąd. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
error	Error	Obiekt błędu.

GenerateAnswerBatchResultItem

Objekt

Reprezentuje wstępnie utworzony wynik odpowiedzi.

Nazwa	Typ	Opis
answer	string	Odpowiedź.
answerEndIndex	integer (int32)	Koniec indeksu odpowiedzi w tekście dokumentu.
answerSpan	AnswerSpan	Odpowiedź obejmuje obiekt w odniesieniu do pytania użytkownika.
answerStartIndex	integer (int32)	Rozpocznij indeks odpowiedzi w tekście dokumentu.
id	string	Identyfikator dokumentu.
score	number	Wynik wyszukiwania.

InnerErrorModel

Objekt

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi dotyczącymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	string	Bardziej szczegółowy kod błędu niż został dostarczony przez błąd zawierający.
innerError	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.

PrebuiltQuery

Objekt

Schemat treści POST do wykonywania zapytań dotyczących dokumentów za pomocą wstępnie utworzonej odpowiedzi na pytania.

Nazwa	Typ	Opis
documents	TextInput[]	Dokumenty, które mają być wyszukiwane w danym pytaniu.
language	string minLength: 2 maxLength: 100	(Opcjonalnie) Język dokumentów. Jest to reprezentacja języka ISO 639-1. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, użyj ciągu "en" dla języka angielskiego jako domyślnego.
question	string	Pytanie użytkownika dotyczące wykonywania zapytań dotyczących podanych dokumentów.

TextInput

Objekt

Lista dokumentów do odpytowania.

Nazwa	Typ	Opis
id	string	Unikatowy identyfikator dokumentu.
text	string	Zawartość tekstowa dokumentu