Knowledgebase - Generate Answer

Referens

Tjänst:: Azure AI Services

API-version:: v5.0-preview.2

GenerateAnswer-anrop för att fråga knowledgebase (QnA Maker Managed).

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Kunskapsbas-ID.

Begärandehuvud

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

Begärandetext

Name	Typ	Description
answerSpanRequest	AnswerSpanRequest	Så här konfigurerar du funktionen för förutsägelse av svarsintervall.
context	Context	Kontextobjekt med tidigare QnA-information.
includeUnstructuredSources	boolean	Valfri flagga för att aktivera fråga över ostrukturerade källor.
isTest	boolean	Fråga mot testindexet.
qnaId	string	Exakt qnaId som ska hämtas från kunskapsbasen prioriteras det här fältet framför frågan.
question	string	Användarfråga för att köra frågor mot kunskapsbasen.
rankerType	string	Valfritt fält. Ställ in på "QuestionOnly" för att endast använda en fråga Ranker.
scoreThreshold	number	Minsta tröskelvärdespoäng för svar.
strictFilters	MetadataDTO[]	Hitta QnA:er som är associerade med den angivna listan med metadata.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Valfritt fält. Ange till OR för användning av OR-åtgärden för strikta filter.
top	integer (int32)	Maximalt antal svar som ska returneras för frågan.
userId	string	Unik identifierare för användaren.

Svar

Name	Typ	Description
200 OK	QnASearchResultList	GenerateAnswer-samtalssvar.
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
AnswerSpan	Svarsintervallobjekt för QnA med avseende på användarens fråga.
AnswerSpanRequest	Så här konfigurerar du funktionen för förutsägelse av svarsintervall.
Context	Kontext som är associerad med Qna som ska uppdateras.
Error	Felobjektet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	En av en serverdefinierad uppsättning felkoder.
ErrorResponse	Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
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.
MetadataDTO	Namn – värdepar med metadata.
PromptDTO	Fråga efter ett svar.
Qna	QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
QnASearchResult	Representerar sökresultat.
QnASearchResultList	Representerar en lista över frågesvar.
QueryDTO	POST-brödtextschema för att fråga kunskapsbasen.
StrictFiltersCompoundOperationType	Valfritt fält. Ange till OR för användning av OR-åtgärden för strikta filter.

AnswerSpan

Objekt

Svarsintervallobjekt för QnA med avseende på användarens fråga.

Name	Typ	Description
endIndex	integer (int32)	Slutindex för svarsintervall i svar.
score	number (double)	Förutsagd poäng för svarsintervall.
startIndex	integer (int32)	Starta indexet för svarsintervallet som svar.
text	string	Förutsagd text för svarsintervall.

AnswerSpanRequest

Objekt

Så här konfigurerar du funktionen för förutsägelse av svarsintervall.

Name	Typ	Description
enable	boolean	Aktivera eller inaktivera förutsägelse av svarsintervall.
scoreThreshold	number (double)	Lägsta tröskelvärdespoäng som krävs för att inkludera ett svarsintervall.
topAnswersWithSpan	integer (int32) minimum: 1 maximum: 10	Antal viktigaste svar som ska övervägas för span förutsägelse.

Context

Objekt

Kontext som är associerad med Qna som ska uppdateras.

Name	Typ	Description
isContextOnly	boolean	Att markera om en fråga endast är relevant med en tidigare fråga eller inte. true – Inkludera inte denna QnA som sökresultat för frågor utan kontexten false – ignorerar kontexten och inkluderar denna QnA i sökresultatet
promptsToAdd	PromptDTO[]	Lista över uppmaningar som ska läggas till i qna.
promptsToDelete	integer[] (int32)	Lista över frågor som är associerade med qna som ska tas bort

Error

Objekt

Felobjektet. 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	ErrorCodeType	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.

ErrorCodeType

Uppräkning

En av en serverdefinierad uppsättning felkoder.

Värde	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objekt

Felsvar. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
error	Error	Felobjektet.

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	string	En mer specifik felkod än vad som angavs av det innehållande felet.
innerError	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.

MetadataDTO

Objekt

Namn – värdepar med metadata.

Name	Typ	Description
name	string minLength: 1 maxLength: 100	Metadatanamn.
value	string minLength: 1 maxLength: 500	Metadatavärde.

PromptDTO

Objekt

Fråga efter ett svar.

Name	Typ	Description
displayOrder	integer (int32)	Index för prompten – används i ordning på prompterna
displayText	string maxLength: 200	Text som visas för att representera en fråga om uppföljning
qna	Qna	QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt
qnaId	integer (int32)	Qna-ID som motsvarar prompten – om QnaId finns ignoreras QnADTO-objektet.

Qna

Objekt

QnADTO – Antingen QnaId eller QnADTO måste finnas i ett PromptDTO-objekt

Name	Typ	Description
answer	string minLength: 1 maxLength: 25000	Svarstext
context	Context	Kontext för en QnA
id	integer (int32)	Unikt ID för Q-A.
lastUpdatedTimestamp	string maxLength: 300	Tidsstämpel när QnA senast uppdaterades.
metadata	MetadataDTO[]	Lista över metadata som är associerade med svaret.
questions	string[]	Lista över frågor som är associerade med svaret.
source	string maxLength: 300	Källa som Q-A indexerades från. T.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnASearchResult

Objekt

Representerar sökresultat.

Name	Typ	Description
answer	string	Svar.
answerSpan	AnswerSpan	Svarsintervallobjekt för QnA med avseende på användarens fråga.
context	Context	Kontextobjekt för QnA
id	integer (int32)	ID för QnA-resultatet.
metadata	MetadataDTO[]	Lista över metadata.
questions	string[]	Lista över frågor.
score	number	Sökresultatpoäng.
source	string	Källa för QnA-resultat.

QnASearchResultList

Objekt

Representerar en lista över frågesvar.

Name	Typ	Description
answers	QnASearchResult[]	Representerar sökresultatlistan.

QueryDTO

Objekt

POST-brödtextschema för att fråga kunskapsbasen.

Name	Typ	Description
answerSpanRequest	AnswerSpanRequest	Så här konfigurerar du funktionen för förutsägelse av svarsintervall.
context	Context	Kontextobjekt med tidigare QnA-information.
includeUnstructuredSources	boolean	Valfri flagga för att aktivera fråga över ostrukturerade källor.
isTest	boolean	Fråga mot testindexet.
qnaId	string	Exakt qnaId som ska hämtas från kunskapsbasen prioriteras det här fältet framför frågan.
question	string	Användarfråga för att köra frågor mot kunskapsbasen.
rankerType	string	Valfritt fält. Ställ in på "QuestionOnly" för att endast använda en fråga Ranker.
scoreThreshold	number	Minsta tröskelvärdespoäng för svar.
strictFilters	MetadataDTO[]	Hitta QnA:er som är associerade med den angivna listan med metadata.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Valfritt fält. Ange till OR för användning av OR-åtgärden för strikta filter.
top	integer (int32)	Maximalt antal svar som ska returneras för frågan.
userId	string	Unik identifierare för användaren.

StrictFiltersCompoundOperationType

Uppräkning

Valfritt fält. Ange till OR för användning av OR-åtgärden för strikta filter.

Värde	Description
AND
OR

Dela via

Knowledgebase - Generate Answer

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Successful query

Exempelbegäran

Exempelsvar

Definitioner

AnswerSpan

AnswerSpanRequest

Context

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnASearchResult

QnASearchResultList

QueryDTO

StrictFiltersCompoundOperationType

Ytterligare resurser