Runtime - Generate Answer

Service:

Azure AI Services

API-versie:

4.0

GenerateAnswer-aanroep om een query uit te voeren op de knowledgebase.

POST {RuntimeEndpoint}/qnamaker/knowledgebases/{kbId}/generateAnswer

URI-parameters

Name	In	Vereist	Type	Description
kbId	path	True	string	Knowledgebase-id.
RuntimeEndpoint	path	True	string	QnA Maker App Service-eindpunt (bijvoorbeeld: https://{qnaservice-hostname}.azurewebsites.net).

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string

Aanvraagbody

Name	Type	Description
context	Context	Contextobject met de informatie van eerdere QnA.
isTest	boolean	Voer een query uit op de testindex.
qnaId	string	Exact qnaId dat moet worden opgehaald uit de knowledgebase. Dit veld heeft prioriteit boven vraag.
question	string	Gebruikersvraag om een query uit te voeren op basis van de Knowledge Base.
rankerType	string	Optioneel veld. Ingesteld op 'QuestionOnly' voor het gebruik van een vraag alleen Ranker.
scoreThreshold	number	Drempelwaarde voor antwoorden die zijn geretourneerd op basis van score.
strictFilters	MetadataDTO[]	Zoek alleen antwoorden die deze metagegevens bevatten.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Optioneel veld. Ingesteld op OF voor het gebruik van OR als bewerking voor strikte filters.
top	integer (int32)	Het maximum aantal antwoorden dat moet worden geretourneerd voor de vraag.
userId	string	Unieke id voor de gebruiker. Optionele parameter voor telemetrie. Raadpleeg Analytics en Telemetryvoor meer informatie.

Antwoorden

Name	Type	Description
200 OK	QnASearchResultList	Antwoord genererenAnswer-aanroep.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Authorization

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

POST {RuntimeEndpoint}/qnamaker/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff/generateAnswer


{
  "question": "qna maker and luis",
  "top": 6,
  "isTest": true,
  "scoreThreshold": 20,
  "strictFilters": [
    {
      "name": "category",
      "value": "api"
    }
  ],
  "userId": "sd53lsY="
}

Voorbeeldrespons

Statuscode:

200

{
  "answers": [
    {
      "score": 28.54820341616869,
      "id": 20,
      "answer": "There is no direct integration of LUIS with QnA Maker. But, in your bot code, you can use LUIS and QnA Maker together.",
      "source": "Custom Editorial",
      "questions": [
        "How can I integrate LUIS with QnA Maker?"
      ],
      "metadata": [
        {
          "name": "category",
          "value": "api"
        }
      ]
    }
  ]
}

Definities

Name	Description
Context	Context van een QnA
Error	Het foutobject. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Een van een door de server gedefinieerde set foutcodes.
ErrorResponse	Foutreactie. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Naam: waardepaar met metagegevens.
PromptDTO	Vraag om een antwoord.
Qna	QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
QnASearchResult	Vertegenwoordigt het zoekresultaat.
QnASearchResultList	Vertegenwoordigt lijst met vraagantwoorden.
QueryDTO	POST-hoofdtekstschema om een query uit te voeren op de knowledgebase.
StrictFiltersCompoundOperationType	Optioneel veld. Ingesteld op OF voor het gebruik van OR als bewerking voor strikte filters.

Context

Object

Context van een QnA

Name	Type	Description
isContextOnly	boolean	Als u wilt markeren of een prompt alleen relevant is voor een vorige vraag of niet. true - Neem deze QnA niet op als zoekresultaat voor query's zonder context false - negeert context en bevat deze QnA in het zoekresultaat
prompts	PromptDTO[]	Lijst met prompts die aan het antwoord zijn gekoppeld.

Error

Object

Het foutobject. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	ErrorCodeType	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innerError	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCodeType

Inventarisatie

Een van een door de server gedefinieerde set foutcodes.

Waarde	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

Foutreactie. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
innerError	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.

MetadataDTO

Object

Naam: waardepaar met metagegevens.

Name	Type	Description
name	string minLength: 1 maxLength: 100	Naam van metagegevens.
value	string minLength: 1 maxLength: 500	Metagegevenswaarde.

PromptDTO

Object

Vraag om een antwoord.

Name	Type	Description
displayOrder	integer (int32)	Index van de prompt - gebruikt in volgorde van de prompts
displayText	string maxLength: 200	Tekst die wordt weergegeven om een vervolgvraagprompt weer te geven
qna	Qna	QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object
qnaId	integer (int32)	Qna-id die overeenkomt met de prompt: als QnaId aanwezig is, wordt het QnADTO-object genegeerd.

Qna

Object

QnADTO - QnaId of QnADTO moet aanwezig zijn in een PromptDTO-object

Name	Type	Description
answer	string minLength: 1 maxLength: 25000	Antwoordtekst
context	Context	Context van een QnA
id	integer (int32)	Unieke id voor de Q-A.
metadata	MetadataDTO[]	Lijst met metagegevens die aan het antwoord zijn gekoppeld.
questions	string[]	Lijst met vragen die aan het antwoord zijn gekoppeld.
source	string maxLength: 300	Bron waaruit Q-A is geïndexeerd. bijvoorbeeld https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnASearchResult

Object

Vertegenwoordigt het zoekresultaat.

Name	Type	Description
answer	string	Antwoord.
context	Context	Contextobject van de QnA
id	integer (int32)	Id van het QnA-resultaat.
metadata	MetadataDTO[]	Lijst met metagegevens.
questions	string[]	Lijst met vragen.
score	number	Score voor zoekresultaten.
source	string	Bron van QnA-resultaat.

QnASearchResultList

Object

Vertegenwoordigt lijst met vraagantwoorden.

Name	Type	Description
answers	QnASearchResult[]	Vertegenwoordigt de lijst met zoekresultaten.

QueryDTO

Object

POST-hoofdtekstschema om een query uit te voeren op de knowledgebase.

Name	Type	Description
context	Context	Contextobject met de informatie van eerdere QnA.
isTest	boolean	Voer een query uit op de testindex.
qnaId	string	Exact qnaId dat moet worden opgehaald uit de knowledgebase. Dit veld heeft prioriteit boven vraag.
question	string	Gebruikersvraag om een query uit te voeren op basis van de Knowledge Base.
rankerType	string	Optioneel veld. Ingesteld op 'QuestionOnly' voor het gebruik van een vraag alleen Ranker.
scoreThreshold	number	Drempelwaarde voor antwoorden die zijn geretourneerd op basis van score.
strictFilters	MetadataDTO[]	Zoek alleen antwoorden die deze metagegevens bevatten.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Optioneel veld. Ingesteld op OF voor het gebruik van OR als bewerking voor strikte filters.
top	integer (int32)	Het maximum aantal antwoorden dat moet worden geretourneerd voor de vraag.
userId	string	Unieke id voor de gebruiker. Optionele parameter voor telemetrie. Raadpleeg Analytics en Telemetryvoor meer informatie.

StrictFiltersCompoundOperationType

Inventarisatie

Optioneel veld. Ingesteld op OF voor het gebruik van OR als bewerking voor strikte filters.

Waarde	Description
AND
OR