Knowledgebase - Generate Answer

Odwołanie

Usługa:: Azure AI Services

Wersja interfejsu API:: v5.0-preview.2

GenerateAnswer call to query knowledgebase (QnA Maker Managed).

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

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).
kbId	path	True	string	Identyfikator bazy wiedzy.

Nagłówek żądania

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

Treść żądania

Nazwa	Typ	Opis
answerSpanRequest	AnswerSpanRequest	Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.
context	Context	Obiekt kontekstu z informacjami poprzedniej usługi QnA.
includeUnstructuredSources	boolean	Opcjonalna flaga włączania kwerendy nad źródłami bez struktury.
isTest	boolean	Wykonywanie zapytań względem indeksu testowego.
qnaId	string	Dokładna wartość qnaId do pobrania z bazy wiedzy, to pole ma priorytet nad pytaniem.
question	string	Pytanie użytkownika dotyczące wykonywania zapytań względem bazy wiedzy.
rankerType	string	Pole opcjonalne. Ustaw wartość "QuestionOnly" dla używania tylko funkcji Ranker.
scoreThreshold	number	Minimalny wynik progu dla odpowiedzi.
strictFilters	MetadataDTO[]	Znajdź pytania i pytania, które są skojarzone z daną listą metadanych.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Pole opcjonalne. Ustaw wartość "OR" dla używania operacji OR dla rygorystycznych filtrów.
top	integer (int32)	Maksymalna liczba odpowiedzi, które mają zostać zwrócone dla pytania.
userId	string	Unikatowy identyfikator użytkownika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	QnASearchResultList	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/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/generateAnswer


{
  "question": "How much time it takes to complete quickstart guide?",
  "top": 6,
  "isTest": true,
  "context": {
    "previousQnaId": 9,
    "previousUserQuery": "Where are QnA Maker quickstarts?"
  },
  "scoreThreshold": 20,
  "strictFilters": [
    {
      "name": "category",
      "value": "api"
    }
  ],
  "answerSpanRequest": {
    "enable": true,
    "scoreThreshold": 25,
    "topAnswersWithSpan": 1
  },
  "userId": "sd53lsY="
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "answers": [
    {
      "questions": [
        "Complete a quickstart"
      ],
      "answer": "We offer quickstarts in most popular programming languages, each designed to teach you basic design patterns, and have you running code in less than 10 minutes. See the following list for the quickstart for each feature.\n\n*   [Get started with the LUIS client library](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-sdk)\n\n*   [Get started with the LUIS portal](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/create-publish-knowledge-base)\n\n*   [Get started with the LUIS REST APis](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/quickstarts/quickstart-rest-curl)",
      "score": 46.11,
      "id": 9,
      "source": "Editorial",
      "metadata": [],
      "context": {
        "isContextOnly": false,
        "prompts": []
      },
      "answerSpan": {
        "text": "less than 10 minutes",
        "score": 54.92,
        "startIndex": 139,
        "endIndex": 159
      }
    }
  ]
}

Definicje

Nazwa	Opis
AnswerSpan	Odpowiedź obejmuje obiekt pytań i odpowiedzi w odniesieniu do pytania użytkownika.
AnswerSpanRequest	Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.
Context	Kontekst skojarzony z funkcją Qna do zaktualizowania.
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.
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.
MetadataDTO	Name — para wartości metadanych.
PromptDTO	Monituj o odpowiedź.
Qna	QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO
QnASearchResult	Reprezentuje wynik wyszukiwania.
QnASearchResultList	Reprezentuje listę odpowiedzi na pytania.
QueryDTO	Schemat treści POST do wykonywania zapytań względem bazy wiedzy.
StrictFiltersCompoundOperationType	Pole opcjonalne. Ustaw wartość "OR" dla używania operacji OR dla rygorystycznych filtrów.

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.

AnswerSpanRequest

Objekt

Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.

Nazwa	Typ	Opis
enable	boolean	Włącz lub wyłącz przewidywanie zakresu odpowiedzi.
scoreThreshold	number (double)	Minimalny wynik progu wymagany do uwzględnienia zakresu odpowiedzi.
topAnswersWithSpan	integer (int32) minimum: 1 maximum: 10	Liczba najważniejszych odpowiedzi, które należy wziąć pod uwagę w przypadku przewidywania zakresu.

Context

Objekt

Kontekst skojarzony z funkcją Qna do zaktualizowania.

Nazwa	Typ	Opis
isContextOnly	boolean	Aby zaznaczyć, czy monit jest odpowiedni tylko z poprzednim pytaniem, czy nie. true — nie dołączaj tej usługi pytań i odpowiedzi jako wyników wyszukiwania dla zapytań bez wartości false kontekstu — ignoruje kontekst i uwzględnia tę funkcję pytań i odpowiedzi w wynikach wyszukiwania
promptsToAdd	PromptDTO[]	Lista monitów do dodania do qna.
promptsToDelete	integer[] (int32)	Lista monitów skojarzonych z funkcją qna do usunięcia

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.

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.

MetadataDTO

Objekt

Name — para wartości metadanych.

Nazwa	Typ	Opis
name	string minLength: 1 maxLength: 100	Nazwa metadanych.
value	string minLength: 1 maxLength: 500	Wartość metadanych.

PromptDTO

Objekt

Monituj o odpowiedź.

Nazwa	Typ	Opis
displayOrder	integer (int32)	Indeks monitu — używany w kolejności monitów
displayText	string maxLength: 200	Tekst wyświetlany w celu reprezentowania monitu o pytanie
qna	Qna	QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO
qnaId	integer (int32)	Identyfikator Qna odpowiadający monitowi — jeśli jest obecny identyfikator QnaId, obiekt QnADTO jest ignorowany.

Qna

Objekt

QnADTO — wartość QnaId lub QnADTO musi być obecna w obiekcie PromptDTO

Nazwa	Typ	Opis
answer	string minLength: 1 maxLength: 25000	Tekst odpowiedzi
context	Context	Kontekst pytań i pytań
id	integer (int32)	Unikatowy identyfikator Q-A.
lastUpdatedTimestamp	string maxLength: 300	Sygnatura czasowa ostatniej aktualizacji usługi QnA.
metadata	MetadataDTO[]	Lista metadanych skojarzonych z odpowiedzią.
questions	string[]	Lista pytań skojarzonych z odpowiedzią.
source	string maxLength: 300	Źródło, z którego indeksowano Q-A. Np. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnASearchResult

Objekt

Reprezentuje wynik wyszukiwania.

Nazwa	Typ	Opis
answer	string	Odpowiedź.
answerSpan	AnswerSpan	Odpowiedź obejmuje obiekt pytań i odpowiedzi w odniesieniu do pytania użytkownika.
context	Context	Obiekt kontekstu pytań i pytań
id	integer (int32)	Identyfikator wyniku pytań i pytań.
metadata	MetadataDTO[]	Lista metadanych.
questions	string[]	Lista pytań.
score	number	Wynik wyszukiwania.
source	string	Źródło wyniku pytań i pytań.

QnASearchResultList

Objekt

Reprezentuje listę odpowiedzi na pytania.

Nazwa	Typ	Opis
answers	QnASearchResult[]	Reprezentuje listę wyników wyszukiwania.

QueryDTO

Objekt

Schemat treści POST do wykonywania zapytań względem bazy wiedzy.

Nazwa	Typ	Opis
answerSpanRequest	AnswerSpanRequest	Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.
context	Context	Obiekt kontekstu z informacjami poprzedniej usługi QnA.
includeUnstructuredSources	boolean	Opcjonalna flaga włączania kwerendy nad źródłami bez struktury.
isTest	boolean	Wykonywanie zapytań względem indeksu testowego.
qnaId	string	Dokładna wartość qnaId do pobrania z bazy wiedzy, to pole ma priorytet nad pytaniem.
question	string	Pytanie użytkownika dotyczące wykonywania zapytań względem bazy wiedzy.
rankerType	string	Pole opcjonalne. Ustaw wartość "QuestionOnly" dla używania tylko funkcji Ranker.
scoreThreshold	number	Minimalny wynik progu dla odpowiedzi.
strictFilters	MetadataDTO[]	Znajdź pytania i pytania, które są skojarzone z daną listą metadanych.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Pole opcjonalne. Ustaw wartość "OR" dla używania operacji OR dla rygorystycznych filtrów.
top	integer (int32)	Maksymalna liczba odpowiedzi, które mają zostać zwrócone dla pytania.
userId	string	Unikatowy identyfikator użytkownika.

StrictFiltersCompoundOperationType

Wyliczanie

Pole opcjonalne. Ustaw wartość "OR" dla używania operacji OR dla rygorystycznych filtrów.

Wartość	Opis
AND
OR

Udostępnij za pośrednictwem

Knowledgebase - Generate Answer

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

Ocp-Apim-Subscription-Key

Przykłady

Successful query

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AnswerSpan

AnswerSpanRequest

Context

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnASearchResult

QnASearchResultList

QueryDTO

StrictFiltersCompoundOperationType

Dodatkowe zasoby