Question Answering - Get Answers

Referenz

Service:: Cognitive Services

API Version:: 2021-10-01

Beantwortet die angegebene Frage mithilfe Ihres Wissensdatenbank.

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 das Vorhersagefeature "Antwortspanne".
confidenceScoreThreshold	number	Mindestschwellenwert für Antworten, Der Wert liegt zwischen 0 und 1.
context	KnowledgeBaseAnswerContext	Context-Objekt mit früheren QnA-Informationen.
filters	QueryFilters	Filtern Sie QnAs basierend auf der angegebenen Metadatenliste und Wissensdatenbank Quellen.
includeUnstructuredSources	boolean	(Optional) Flag, um Abfrage über unstrukturierte Quellen zu aktivieren.
qnaId	integer	Genaue QnA-ID zum Abrufen aus dem Wissensdatenbank hat dieses Feld Vorrang vor der Frage.
question	string	Benutzerfrage zum Abfragen des Wissensdatenbank.
rankerType	RankerKind	Typ des zu verwendenden Rangfolgers.
top	integer	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 Wissensdatenbank zu erhalten.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Beispiele

Successful query

Sample Request

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
}

Sample Response

Status code:: 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 eines Wissensdatenbank.
AnswerSpan	Antwortspanneobjekt von QnA.
AnswersResult	Stellt die Liste der Frageantworten dar.
enable	Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.
Error	Das Fehlerobjekt.
ErrorCode	Für Menschen lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Für Menschen 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 Wissensdatenbank Antwort dar.
KnowledgeBaseAnswerContext	Context-Objekt mit früheren QnA-Informationen.
KnowledgeBaseAnswerDialog	Dialogfeld, das der Antwort zugeordnet ist.
KnowledgeBaseAnswerPrompt	Fordern Sie eine Antwort an.
LogicalOperationKind	Legen Sie für die Verwendung des entsprechenden logischen Vorgangs auf "OR" oder "AND" fest.
MetadataFilter	Suchen Sie nach QnAs, die der angegebenen Liste von Metadaten zugeordnet sind.
MetadataRecord	Objekt, um das Schlüsselwertpaar für die einzelnen Metadaten bereitzustellen.
QueryFilters	filtert über Wissensdatenbank.
RankerKind	Typ des zu verwendenden Rangfolgers.
ShortAnswerOptions	So konfigurieren Sie das Vorhersagefeature "Antwortspanne".

AnswersOptions

Parameter zum Abfragen eines Wissensdatenbank.

Name	Typ	Beschreibung
answerSpanRequest	ShortAnswerOptions	So konfigurieren Sie das Vorhersagefeature "Antwortspanne".
confidenceScoreThreshold	number	Mindestschwellenwert für Antworten, Der Wert liegt zwischen 0 und 1.
context	KnowledgeBaseAnswerContext	Context-Objekt mit früheren QnA-Informationen.
filters	QueryFilters	Filtern Sie QnAs basierend auf der angegebenen Metadatenliste und Wissensdatenbank Quellen.
includeUnstructuredSources	boolean	(Optional) Flag, um Abfrage über unstrukturierte Quellen zu aktivieren.
qnaId	integer	Genaue QnA-ID zum Abrufen aus dem Wissensdatenbank hat dieses Feld Vorrang vor der Frage.
question	string	Benutzerfrage zum Abfragen des Wissensdatenbank.
rankerType	RankerKind	Typ des zu verwendenden Rangfolgers.
top	integer	Maximale Anzahl von Antworten, die für die Frage zurückgegeben werden sollen.
userId	string	Eindeutiger Bezeichner für den Benutzer.

AnswerSpan

Antwortspanneobjekt von QnA.

Name	Typ	Beschreibung
confidenceScore	number	Vorhergesagte Bewertung der Antwortspanne, Der Wert liegt zwischen 0 und 1.
length	integer	Die Länge der Antwortspanne.
offset	integer	Der Offset der Antwortspanne vom Anfang der Antwort.
text	string	Vorhergesagter Text der Antwortspanne.

AnswersResult

Stellt die Liste der Frageantworten dar.

Name	Typ	Beschreibung
answers	KnowledgeBaseAnswer[]	Stellt die Antwortergebnisliste dar.

enable

Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.

Name	Typ	Beschreibung
True	Boolean

Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Einer der vom Server definierten 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 für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Für Menschen lesbarer Fehlercode.

Name	Typ	Beschreibung
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

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.

Name	Typ	Beschreibung
code	InnerErrorCode	Einer der vom Server definierten 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

Stellt Wissensdatenbank Antwort dar.

Name	Typ	Beschreibung
answer	string	Antworttext.
answerSpan	AnswerSpan	Antwort span-Objekt von QnA in Bezug auf die Frage des Benutzers.
confidenceScore	number	Antwortvertrauensbewertung, Der Wert liegt zwischen 0 und 1.
dialog	KnowledgeBaseAnswerDialog	Dialogfeld, das der Antwort zugeordnet ist.
id	integer	ID des QnA-Ergebnisses.
metadata	object	Metadaten, die der Antwort zugeordnet sind, sind nützlich, um Fragenantworten zu kategorisieren oder zu filtern.
questions	string[]	Liste der Fragen, die der Antwort zugeordnet sind.
source	string	Quelle des QnA-Ergebnisses.

KnowledgeBaseAnswerContext

Context-Objekt mit früheren QnA-Informationen.

Name	Typ	Beschreibung
previousQnaId	integer	QnA-ID der vorherigen Turn-Top-Antwort.
previousUserQuery	string	Vorherige Benutzerabfrage.

KnowledgeBaseAnswerDialog

Dialogfeld, das der Antwort zugeordnet ist.

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

KnowledgeBaseAnswerPrompt

Fordern Sie eine Antwort an.

Name	Typ	Beschreibung
displayOrder	integer	Index der Eingabeaufforderung : Wird für die Reihenfolge der Eingabeaufforderungen verwendet.
displayText	string	Text, der angezeigt wird, um eine Nachfrageaufforderung darzustellen.
qnaId	integer	QnA-ID, die der Eingabeaufforderung entspricht.

LogicalOperationKind

Legen Sie für die Verwendung des entsprechenden logischen Vorgangs auf "OR" oder "AND" fest.

Name	Typ	Beschreibung
AND	string
OR	string

MetadataFilter

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

Name	Typ	Standardwert	Beschreibung
logicalOperation	LogicalOperationKind	AND	Vorgang zum Verknüpfen von Metadatenfiltern.
metadata	MetadataRecord[]		Objekt, um das Schlüsselwertpaar für die einzelnen Metadaten bereitzustellen.

MetadataRecord

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

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

filtert über Wissensdatenbank.

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

RankerKind

Typ des zu verwendenden Rangfolgers.

Name	Typ	Beschreibung
Default	string	Standardrangliste.
QuestionOnly	string	Frage nur Rangfolger.

ShortAnswerOptions

So konfigurieren Sie das Vorhersagefeature "Antwortspanne".

Name	Typ	Beschreibung
confidenceScoreThreshold	number	Der Mindestschwellenwert, der für die Aufnahme einer Antwortspanne erforderlich ist, liegt zwischen 0 und 1.
enable	enable	Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.
topAnswersWithSpan	integer	Anzahl der wichtigsten Antworten, die für die Spannenvorhersage von 1 bis 10 berücksichtigt werden sollen.