Runtime - Generate Answer

Referenz

Dienst:: Azure AI Services

API-Version:: 4.0

GenerateAnswer-Befehl zum Abfragen der Wissensdatenbank.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
kbId	path	True	string	Knowledgebase-ID.
RuntimeEndpoint	path	True	string	QnA Maker App Service-Endpunkt (z. B. https://{qnaservice-hostname}.azurewebsites.net).

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string

Anforderungstext

Name	Typ	Beschreibung
context	Context	Context-Objekt mit vorherigen QnA-Informationen.
isTest	boolean	Abfrage für den Testindex.
qnaId	string	Genaue qnaId, die aus der Wissensdatenbank abgerufen werden soll, hat dieses Feld Vorrang vor der Frage.
question	string	Benutzerfrage, um die Wissensbasis abzufragen.
rankerType	string	Optionales Feld. Legen Sie "QuestionOnly" für die Verwendung einer Frage nur "Ranker" fest.
scoreThreshold	number	Schwellenwert für Antworten, die basierend auf der Bewertung zurückgegeben werden.
strictFilters	MetadataDTO[]	Hier finden Sie nur Antworten, die diese Metadaten enthalten.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Optionales Feld. Für die Verwendung von OR als Operation für strict-Filter festgelegt.
top	integer (int32)	Maximale Anzahl von Antworten, die für die Frage zurückgegeben werden sollen.
userId	string	Eindeutiger Bezeichner für den Benutzer. Optionaler Parameter für Telemetrie. Weitere Informationen finden Sie unter Analytics and Telemetry.

Antworten

Name	Typ	Beschreibung
200 OK	QnASearchResultList	GenerateAnswer-Anrufantwort.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Authorization

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
Context	Kontext eines QnA
Error	Das Fehlerobjekt. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Eine serverdefinierte Gruppe von Fehlercodes.
ErrorResponse	Fehlerantwort. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
MetadataDTO	Name - Wertpaar von Metadaten.
PromptDTO	Zur Eingabe einer Antwort auffordern.
Qna	QnADTO – Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein
QnASearchResult	Stellt das Suchergebnis dar.
QnASearchResultList	Stellt die Liste der Frageantworten dar.
QueryDTO	POST body schema to query the knowledgebase.
StrictFiltersCompoundOperationType	Optionales Feld. Für die Verwendung von OR als Operation für strict-Filter festgelegt.

Context

Objekt

Kontext eines QnA

Name	Typ	Beschreibung
isContextOnly	boolean	Um zu markieren, ob eine Eingabeaufforderung nur mit einer vorherigen Frage relevant ist oder nicht. true - Schließen Sie diese QnA nicht als Suchergebnis für Abfragen ohne Kontext falsch ein - ignoriert den Kontext und schließt diese QnA in das Suchergebnis ein.
prompts	PromptDTO[]	Liste der Eingabeaufforderungen, die der Antwort zugeordnet sind.

Error

Objekt

Das Fehlerobjekt. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	ErrorCodeType	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innerError	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCodeType

Enumeration

Eine serverdefinierte Gruppe von Fehlercodes.

Wert	Beschreibung
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objekt

Fehlerantwort. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde.
innerError	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.

MetadataDTO

Objekt

Name - Wertpaar von Metadaten.

Name	Typ	Beschreibung
name	string minLength: 1 maxLength: 100	Metadatenname.
value	string minLength: 1 maxLength: 500	Metadatenwert.

PromptDTO

Objekt

Zur Eingabe einer Antwort auffordern.

Name	Typ	Beschreibung
displayOrder	integer (int32)	Index der Eingabeaufforderung – wird in der Reihenfolge der Eingabeaufforderungen verwendet
displayText	string maxLength: 200	Text, der angezeigt wird, um eine Nachverfolgungsfrageaufforderung darzustellen
qna	Qna	QnADTO – Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein
qnaId	integer (int32)	Qna id corresponding to the prompt - if QnaId is present, QnADTO object is ignored.

Qna

Objekt

QnADTO – Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein

Name	Typ	Beschreibung
answer	string minLength: 1 maxLength: 25000	Antworttext
context	Context	Kontext eines QnA
id	integer (int32)	Eindeutige ID für Q-A.
metadata	MetadataDTO[]	Liste der Metadaten, die der Antwort zugeordnet sind.
questions	string[]	Liste der Fragen, die der Antwort zugeordnet sind.
source	string maxLength: 300	Quelle, aus der Q-A indiziert wurde. Zb. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs

QnASearchResult

Objekt

Stellt das Suchergebnis dar.

Name	Typ	Beschreibung
answer	string	Antwort.
context	Context	Context-Objekt der QnA
id	integer (int32)	ID des QnA-Ergebnisses.
metadata	MetadataDTO[]	Liste der Metadaten.
questions	string[]	Liste der Fragen.
score	number	Suchergebnisbewertung.
source	string	Quelle des QnA-Ergebnisses.

QnASearchResultList

Objekt

Stellt die Liste der Frageantworten dar.

Name	Typ	Beschreibung
answers	QnASearchResult[]	Stellt die Suchergebnisliste dar.

QueryDTO

Objekt

POST body schema to query the knowledgebase.

Name	Typ	Beschreibung
context	Context	Context-Objekt mit vorherigen QnA-Informationen.
isTest	boolean	Abfrage für den Testindex.
qnaId	string	Genaue qnaId, die aus der Wissensdatenbank abgerufen werden soll, hat dieses Feld Vorrang vor der Frage.
question	string	Benutzerfrage, um die Wissensbasis abzufragen.
rankerType	string	Optionales Feld. Legen Sie "QuestionOnly" für die Verwendung einer Frage nur "Ranker" fest.
scoreThreshold	number	Schwellenwert für Antworten, die basierend auf der Bewertung zurückgegeben werden.
strictFilters	MetadataDTO[]	Hier finden Sie nur Antworten, die diese Metadaten enthalten.
strictFiltersCompoundOperationType	StrictFiltersCompoundOperationType	Optionales Feld. Für die Verwendung von OR als Operation für strict-Filter festgelegt.
top	integer (int32)	Maximale Anzahl von Antworten, die für die Frage zurückgegeben werden sollen.
userId	string	Eindeutiger Bezeichner für den Benutzer. Optionaler Parameter für Telemetrie. Weitere Informationen finden Sie unter Analytics and Telemetry.

StrictFiltersCompoundOperationType

Enumeration

Optionales Feld. Für die Verwendung von OR als Operation für strict-Filter festgelegt.

Wert	Beschreibung
AND
OR

Freigeben über

Runtime - Generate Answer

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Authorization

Beispiele

Successful query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

Context

Error

ErrorCodeType

ErrorResponse

InnerErrorModel

MetadataDTO

PromptDTO

Qna

QnASearchResult

QnASearchResultList

QueryDTO

StrictFiltersCompoundOperationType

Zusätzliche Ressourcen