Question Answering - Get Answers

Referenz

Dienst:: Azure AI Services

API-Version:: 2021-10-01

Beantwortet die angegebene Frage mithilfe Ihrer Wissensbasis.

POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2021-10-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string	Unterstützter Cognitive Services-Endpunkt (z. B. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Client-API-Version.
deploymentName	query	True	string	Der Name der spezifischen Bereitstellung des zu verwendenden Projekts.
projectName	query	True	string	Der Name des zu verwendenden Projekts.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Ocp-Apim-Subscription-Key	True	string

Anforderungstext

Name	Typ	Beschreibung
answerSpanRequest	ShortAnswerOptions	So konfigurieren Sie die Funktion "Antwortspanne-Vorhersage".
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1	Der Mindestschwellenwert für Antworten liegt zwischen 0 und 1.
context	KnowledgeBaseAnswerContext	Context-Objekt mit vorherigen QnA-Informationen.
filters	QueryFilters	Filtern Sie QnAs basierend auf bestimmten Metadatenlisten und Wissensbasisquellen.
includeUnstructuredSources	boolean	(Optional) Kennzeichnen, um Abfrage über unstrukturierte Quellen zu aktivieren.
qnaId	integer (int32)	Genaue QnA-ID, die aus der Wissensbasis abgerufen werden soll, hat dieses Feld Vorrang vor Der Frage.
question	string	Benutzerfrage, um die Wissensbasis abzufragen.
rankerType	RankerKind	Typ des zu verwendenden Rangierers.
top	integer (int32)	Maximale Anzahl von Antworten, die für die Frage zurückgegeben werden sollen.
userId	string	Eindeutiger Bezeichner für den Benutzer.

Antworten

Name	Typ	Beschreibung
200 OK	AnswersResult	Eine erfolgreiche Antwort, um Antworten von der Wissensbasis zu erhalten.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

HTTP

POST {Endpoint}/language/:query-knowledgebases?projectName=proj1&deploymentName=production&api-version=2021-10-01


{
  "question": "how long it takes to charge surface?",
  "top": 3,
  "userId": "sd53lsY=",
  "confidenceScoreThreshold": 0.2,
  "context": {
    "previousQnaId": 9,
    "previousUserQuery": "Where are QnA Maker quickstarts?"
  },
  "rankerType": "Default",
  "filters": {
    "metadataFilter": {
      "metadata": [
        {
          "key": "category",
          "value": "api"
        },
        {
          "key": "editorial",
          "value": "chitchat"
        }
      ],
      "logicalOperation": "AND"
    },
    "sourceFilter": [
      "filename1.pdf",
      "https://www.wikipedia.org/microsoft"
    ],
    "logicalOperation": "AND"
  },
  "answerSpanRequest": {
    "enable": true,
    "confidenceScoreThreshold": 0.2,
    "topAnswersWithSpan": 1
  },
  "includeUnstructuredSources": true
}

Beispiel für eine Antwort

Statuscode:: 200

{
  "answers": [
    {
      "questions": [
        "Power and charging"
      ],
      "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.",
      "confidenceScore": 0.65,
      "id": 20,
      "source": "surface-pro-4-user-guide-EN.pdf",
      "metadata": {
        "category": "api",
        "editorial": "chitchat"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 23,
            "displayText": "prompt1"
          },
          {
            "displayOrder": 2,
            "qnaId": 36,
            "displayText": "prompt2"
          }
        ]
      },
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0.3,
        "offset": 33,
        "length": 50
      }
    },
    {
      "questions": [
        "Charge your Surface Pro 4"
      ],
      "answer": "**Charge your Surface Pro 4**\n\n1.  Connect the two parts of the power cord.\n\n2.  Connect the power cord securely to the charging port.\n\n3.  Plug the power supply into an electrical outlet.",
      "confidenceScore": 0.32,
      "id": 13,
      "source": "surface-pro-4-user-guide-EN.pdf"
    }
  ]
}

Definitionen

Name	Beschreibung
AnswersOptions	Parameter zum Abfragen einer Wissensbasis.
AnswerSpan	Antwort span-Objekt von QnA.
AnswersResult	Stellt die Liste der Frageantworten dar.
enable	Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
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.
KnowledgeBaseAnswer	Stellt die Wissensbasisantwort dar.
KnowledgeBaseAnswerContext	Context-Objekt mit vorherigen QnA-Informationen.
KnowledgeBaseAnswerDialog	Dialogfeld, das mit "Antwort" verknüpft ist.
KnowledgeBaseAnswerPrompt	Zur Eingabe einer Antwort auffordern.
LogicalOperationKind	Legen Sie für die Verwendung entsprechender logischer Vorgänge auf "OR" oder "AND" fest.
MetadataFilter	Suchen Sie QnAs, die der angegebenen Liste von Metadaten zugeordnet sind.
MetadataRecord	Objekt, das das Schlüsselwertpaar für die einzelnen Metadaten bereitstellt.
QueryFilters	filtert über die Wissensbasis.
RankerKind	Typ des zu verwendenden Rangierers.
ShortAnswerOptions	So konfigurieren Sie die Funktion "Antwortspanne-Vorhersage".

AnswersOptions

Objekt

Parameter zum Abfragen einer Wissensbasis.

Name	Typ	Beschreibung
answerSpanRequest	ShortAnswerOptions	So konfigurieren Sie die Funktion "Antwortspanne-Vorhersage".
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1	Der Mindestschwellenwert für Antworten liegt zwischen 0 und 1.
context	KnowledgeBaseAnswerContext	Context-Objekt mit vorherigen QnA-Informationen.
filters	QueryFilters	Filtern Sie QnAs basierend auf bestimmten Metadatenlisten und Wissensbasisquellen.
includeUnstructuredSources	boolean	(Optional) Kennzeichnen, um Abfrage über unstrukturierte Quellen zu aktivieren.
qnaId	integer (int32)	Genaue QnA-ID, die aus der Wissensbasis abgerufen werden soll, hat dieses Feld Vorrang vor Der Frage.
question	string	Benutzerfrage, um die Wissensbasis abzufragen.
rankerType	RankerKind	Typ des zu verwendenden Rangierers.
top	integer (int32)	Maximale Anzahl von Antworten, die für die Frage zurückgegeben werden sollen.
userId	string	Eindeutiger Bezeichner für den Benutzer.

AnswerSpan

Objekt

Antwort span-Objekt von QnA.

Name	Typ	Beschreibung
confidenceScore	number (double) minimum: 0 maximum: 1	Die geschätzte Bewertung der Antwortspanne liegt zwischen 0 und 1.
length	integer (int32)	Die Länge der Antwortspanne.
offset	integer (int32)	Die Antwortspanne erstreckt sich vom Anfang der Antwort.
text	string	Vorhergesagter Antworttext.

AnswersResult

Objekt

Stellt die Liste der Frageantworten dar.

Name	Typ	Beschreibung
answers	KnowledgeBaseAnswer[]	Stellt antwortergebnisliste dar.

enable

Enumeration

Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.

Wert	Beschreibung
True

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	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.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

KnowledgeBaseAnswer

Objekt

Stellt die Wissensbasisantwort dar.

Name	Typ	Beschreibung
answer	string	Antworttext.
answerSpan	AnswerSpan	Antwort-Span-Objekt von QnA in Bezug auf die Frage des Benutzers.
confidenceScore	number (double) minimum: 0 maximum: 1	Antwort-Konfidenzbewertung, Der Wert reicht von 0 bis 1.
dialog	KnowledgeBaseAnswerDialog	Dialogfeld, das mit "Antwort" verknüpft ist.
id	integer (int32)	ID des QnA-Ergebnisses.
metadata	object	Metadaten, die der Antwort zugeordnet sind, nützlich zum Kategorisieren oder Filtern von Frageantworten.
questions	string[]	Liste der Fragen, die der Antwort zugeordnet sind.
source	string	Quelle des QnA-Ergebnisses.

KnowledgeBaseAnswerContext

Objekt

Context-Objekt mit vorherigen QnA-Informationen.

Name	Typ	Beschreibung
previousQnaId	integer (int32)	QnA-ID des vorherigen Runden-Antwortergebnisses.
previousUserQuery	string	Vorherige Benutzerabfrage.

KnowledgeBaseAnswerDialog

Objekt

Dialogfeld, das mit "Antwort" verknüpft ist.

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

KnowledgeBaseAnswerPrompt

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.
qnaId	integer (int32)	QnA-ID, die der Eingabeaufforderung entspricht.

LogicalOperationKind

Enumeration

Legen Sie für die Verwendung entsprechender logischer Vorgänge auf "OR" oder "AND" fest.

Wert	Beschreibung
AND
OR

MetadataFilter

Objekt

Suchen Sie QnAs, die der angegebenen Liste von Metadaten zugeordnet sind.

Name	Typ	Standardwert	Beschreibung
logicalOperation	LogicalOperationKind	AND	Vorgang, der zum Verbinden von Metadatenfiltern verwendet wird.
metadata	MetadataRecord[]		Objekt, das das Schlüsselwertpaar für die einzelnen Metadaten bereitstellt.

MetadataRecord

Objekt

Objekt, das das Schlüsselwertpaar für die einzelnen Metadaten bereitstellt.

Name	Typ	Beschreibung
key	string	Metadatenschlüssel aus dem Metadatenwörterbuch, das in der QnA verwendet wird.
value	string	Metadatenwert aus dem Metadatenwörterbuch, das in der QnA verwendet wird.

QueryFilters

Objekt

filtert über die Wissensbasis.

Name	Typ	Standardwert	Beschreibung
logicalOperation	LogicalOperationKind	AND	Logischer Vorgang, der zum Verknüpfen des Metadatenfilters mit dem Quellfilter verwendet wird.
metadataFilter	MetadataFilter		Suchen Sie QnAs, die der angegebenen Liste von Metadaten zugeordnet sind.
sourceFilter	string[]		Suchen Sie QnAs, die einer der angegebenen Quellenliste in der Wissensbasis zugeordnet sind.

RankerKind

Enumeration

Typ des zu verwendenden Rangierers.

Wert	Beschreibung
Default	Standardrangfolger.
QuestionOnly	Frage nur Rangfolger.

ShortAnswerOptions

Objekt

So konfigurieren Sie die Funktion "Antwortspanne-Vorhersage".

Name	Typ	Beschreibung
confidenceScoreThreshold	number (double) minimum: 0 maximum: 1	Mindestschwellenwert, der erforderlich ist, um eine Antwortspanne einzuschließen, liegt der Wert zwischen 0 und 1.
enable	enable	Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.
topAnswersWithSpan	integer (int32) minimum: 1 maximum: 10	Die Anzahl der wichtigsten Antworten, die für die Spannweitenvorhersage von 1 bis 10 berücksichtigt werden sollen.

Freigeben über

Question Answering - Get Answers

URI-Parameter

Anforderungsheader

Anforderungstext

Antworten

Sicherheit

Ocp-Apim-Subscription-Key

Beispiele

Successful query

Beispielanforderung

Beispiel für eine Antwort

Definitionen

AnswersOptions

AnswerSpan

AnswersResult

enable

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

KnowledgeBaseAnswer

KnowledgeBaseAnswerContext

KnowledgeBaseAnswerDialog

KnowledgeBaseAnswerPrompt

LogicalOperationKind

MetadataFilter

MetadataRecord

QueryFilters

RankerKind

ShortAnswerOptions

Zusätzliche Ressourcen