Question Answering - Get Answers
Beantwortet die angegebene Frage mithilfe Ihrer Wissensdatenbank.
POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2023-04-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. |
deployment
|
query | True |
string |
Der Name der spezifischen Bereitstellung des zu verwendenden Projekts. |
project
|
query | True |
string |
Der Name des zu verwendenden Projekts. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
answerSpanRequest |
So konfigurieren Sie das Vorhersagefeature "Antwortspanne". |
|
confidenceScoreThreshold |
number |
Mindestschwellenwert für Antworten, Wert zwischen 0 und 1. |
context |
Context-Objekt mit vorherigen QnA-Informationen. |
|
filters |
Filtern Von QnAs basierend auf der angegebenen Metadatenliste und Wissensdatenbank Quellen. |
|
includeUnstructuredSources |
boolean |
(Optional) Flag, um Abfrage über unstrukturierte Quellen zu aktivieren. |
qnaId |
integer |
Die genaue QnA-ID, die aus dem Wissensdatenbank abgerufen werden soll, hat dieses Feld Vorrang vor der Frage. |
question |
string |
Benutzerfrage, die für die Wissensdatenbank abgefragt werden soll. |
rankerType |
Typ des zu verwendenden Rankers. |
|
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 |
Eine erfolgreiche Antwort, um Antworten von Wissensdatenbank zu erhalten. |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
AADToken
Dies sind die Azure Active Directory OAuth2-Flows . In Kombination mit der rollenbasierten Zugriffssteuerung in Azure kann sie verwendet werden, um den Zugriff auf Azure Maps REST-APIs zu steuern. Rollenbasierte Zugriffssteuerungen in Azure werden verwendet, um den Zugriff auf ein oder mehrere Azure Maps Ressourcenkonto oder Unterressourcen festzulegen. Jedem Benutzer, jeder Gruppe oder einem Dienstprinzipal kann zugriff über eine integrierte Rolle oder eine benutzerdefinierte Rolle gewährt werden, die aus einer oder mehreren Berechtigungen für Azure Maps REST-APIs besteht.
Zur Implementierung von Szenarien wird empfohlen, Authentifizierungskonzepte anzuzeigen. Zusammenfassend bietet diese Sicherheitsdefinition eine Lösung zum Modellieren von Anwendungen über Objekte, die die Zugriffssteuerung für bestimmte APIs und Bereiche ermöglichen.
Hinweise
- Diese Sicherheitsdefinition erfordert die Verwendung des
x-ms-client-id
Headers, um anzugeben, auf welche Azure Maps Ressource die Anwendung Zugriff anfordert. Dies kann über die Kartenverwaltungs-API abgerufen werden.
ist Authorization URL
spezifisch für die öffentliche Azure-Cloud instance. Sovereign Clouds verfügen über eindeutige Autorisierungs-URLs und Azure Active Directory-Konfigurationen.
* Die rollenbasierte Zugriffssteuerung von Azure wird über die Azure-Verwaltungsebene über Azure-Portal, PowerShell, CLI, Azure SDKs oder REST-APIs konfiguriert.
* Die Verwendung des Azure Maps Web SDK ermöglicht die konfigurationsbasierte Einrichtung einer Anwendung für mehrere Anwendungsfälle.
- Derzeit unterstützt Azure Active Directory v1.0 oder v2.0 Arbeit, Schule und Gäste, aber keine persönlichen Konten.
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/authorize
Bereiche
Name | Beschreibung |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Ein Abonnementschlüssel für eine Sprachdienstressource.
Typ:
apiKey
In:
header
Beispiele
Successful query
Beispielanforderung
POST {Endpoint}/language/:query-knowledgebases?projectName=proj1&deploymentName=production&api-version=2023-04-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
{
"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 |
---|---|
Answers |
Parameter zum Abfragen eines Wissensdatenbank. |
Answer |
Answer span-Objekt von QnA. |
Answers |
Stellt die Liste der Fragen und Antworten dar. |
enable |
Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage. |
Error |
Das Fehlerobjekt. |
Error |
Lesbarer Fehlercode. |
Error |
Fehlerantwort. |
Inner |
Lesbarer Fehlercode. |
Inner |
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Knowledge |
Stellt Wissensdatenbank Antwort dar. |
Knowledge |
Context-Objekt mit vorherigen QnA-Informationen. |
Knowledge |
Der Antwort zugeordnetes Dialogfeld. |
Knowledge |
Aufforderung zur Eingabe einer Antwort. |
Logical |
Legen Sie für die Verwendung des entsprechenden logischen Vorgangs auf "OR" oder "AND" fest. |
Metadata |
Suchen Sie QnAs, die der angegebenen Liste der Metadaten zugeordnet sind. |
Metadata |
Objekt, das das Schlüsselwertpaar für die einzelnen Metadaten bereitstellt. |
Query |
filtert Wissensdatenbank. |
Ranker |
Typ des zu verwendenden Rankers. |
Short |
So konfigurieren Sie das Vorhersagefeature "Antwortspanne". |
AnswersOptions
Parameter zum Abfragen eines Wissensdatenbank.
Name | Typ | Beschreibung |
---|---|---|
answerSpanRequest |
So konfigurieren Sie das Vorhersagefeature "Antwortspanne". |
|
confidenceScoreThreshold |
number |
Mindestschwellenwert für Antworten, Wert zwischen 0 und 1. |
context |
Context-Objekt mit vorherigen QnA-Informationen. |
|
filters |
Filtern Von QnAs basierend auf der angegebenen Metadatenliste und Wissensdatenbank Quellen. |
|
includeUnstructuredSources |
boolean |
(Optional) Flag, um Abfrage über unstrukturierte Quellen zu aktivieren. |
qnaId |
integer |
Die genaue QnA-ID, die aus dem Wissensdatenbank abgerufen werden soll, hat dieses Feld Vorrang vor der Frage. |
question |
string |
Benutzerfrage, die für die Wissensdatenbank abgefragt werden soll. |
rankerType |
Typ des zu verwendenden Rankers. |
|
top |
integer |
Maximale Anzahl von Antworten, die für die Frage zurückgegeben werden sollen. |
userId |
string |
Eindeutiger Bezeichner für den Benutzer. |
AnswerSpan
Answer span-Objekt 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 Antwortspannenoffset vom Anfang der Antwort. |
text |
string |
Vorhergesagter Text der Antwortspanne. |
AnswersResult
Stellt die Liste der Fragen und Antworten dar.
Name | Typ | Beschreibung |
---|---|---|
answers |
Stellt die Antwortergebnisliste dar. |
enable
Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage.
Name | Typ | Beschreibung |
---|---|---|
True |
Boolean |
Error
Das Fehlerobjekt.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer von einem serverdefiniertem Satz von Fehlercodes. |
|
details |
Error[] |
Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben. |
innererror |
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
Lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
AzureCognitiveSearchIndexLimitReached |
string |
|
AzureCognitiveSearchIndexNotFound |
string |
|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
Conflict |
string |
|
Forbidden |
string |
|
InternalServerError |
string |
|
InvalidArgument |
string |
|
InvalidRequest |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
ProjectNotFound |
string |
|
QuotaExceeded |
string |
|
ServiceUnavailable |
string |
|
Timeout |
string |
|
TooManyRequests |
string |
|
Unauthorized |
string |
|
Warning |
string |
ErrorResponse
Fehlerantwort.
Name | Typ | Beschreibung |
---|---|---|
error |
Das Fehlerobjekt. |
InnerErrorCode
Lesbarer Fehlercode.
Name | Typ | Beschreibung |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
EmptyRequest |
string |
|
ExtractionFailure |
string |
|
InvalidCountryHint |
string |
|
InvalidDocument |
string |
|
InvalidDocumentBatch |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
InvalidRequestBodyFormat |
string |
|
KnowledgeBaseNotFound |
string |
|
MissingInputDocuments |
string |
|
ModelVersionIncorrect |
string |
|
UnsupportedLanguageCode |
string |
InnerErrorModel
Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Richtlinien der Microsoft One-API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Beschreibung |
---|---|---|
code |
Einer von einem serverdefiniertem Satz von Fehlercodes. |
|
details |
object |
Fehlerdetails. |
innererror |
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 |
Antwort span-Objekt von QnA in Bezug auf die Frage des Benutzers. |
|
confidenceScore |
number |
Antwortvertrauensbewertung, Wert zwischen 0 und 1. |
dialog |
Der Antwort zugeordnetes Dialogfeld. |
|
id |
integer |
ID des QnA-Ergebnisses. |
metadata |
object |
Metadaten, die der Antwort zugeordnet sind, nützlich zum Kategorisieren oder Filtern von Fragenantworten. |
questions |
string[] |
Liste der Fragen, die der Antwort zugeordnet sind. |
source |
string |
Quelle des QnA-Ergebnisses. |
KnowledgeBaseAnswerContext
Context-Objekt mit vorherigen QnA-Informationen.
Name | Typ | Beschreibung |
---|---|---|
previousQnaId |
integer |
QnA-ID des vorherigen Ergebnisses für die top-Antwort. |
previousUserQuery |
string |
Vorherige Benutzerabfrage. |
KnowledgeBaseAnswerDialog
Der Antwort zugeordnetes Dialogfeld.
Name | Typ | Beschreibung |
---|---|---|
isContextOnly |
boolean |
Um zu markieren, 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 |
Liste der Eingabeaufforderungen, die der Antwort zugeordnet sind. |
KnowledgeBaseAnswerPrompt
Aufforderung zur Eingabe einer Antwort.
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 QnAs, die der angegebenen Liste der Metadaten zugeordnet sind.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
logicalOperation | AND |
Vorgang, der zum Einbinden von Metadatenfiltern verwendet wird. |
|
metadata |
Objekt, das das Schlüsselwertpaar für die einzelnen Metadaten bereitstellt. |
MetadataRecord
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 im QnA verwendet wird. |
QueryFilters
filtert Wissensdatenbank.
Name | Typ | Standardwert | Beschreibung |
---|---|---|---|
logicalOperation | AND |
Logischer Vorgang, der zum Verbinden des Metadatenfilters mit dem Quellfilter verwendet wird. |
|
metadataFilter |
Suchen Sie QnAs, die der angegebenen Liste der Metadaten zugeordnet sind. |
||
sourceFilter |
string[] |
Suchen Sie QnAs, die einer der angegebenen Liste von Quellen in Wissensdatenbank zugeordnet sind. |
RankerKind
Typ des zu verwendenden Rankers.
Name | Typ | Beschreibung |
---|---|---|
Default |
string |
Standardrangliste. |
QuestionOnly |
string |
Nur Frage ranker. |
ShortAnswerOptions
So konfigurieren Sie das Vorhersagefeature "Antwortspanne".
Name | Typ | Beschreibung |
---|---|---|
confidenceScoreThreshold |
number |
Mindestschwellenwert, der erforderlich ist, um eine Antwortspanne einzuschließen, der Wert reicht von 0 bis 1. |
enable |
Aktivieren oder deaktivieren Sie die Antwortspanne-Vorhersage. |
|
topAnswersWithSpan |
integer |
Anzahl der wichtigsten Antworten, die für die Spannenvorhersage berücksichtigt werden sollen, von 1 bis 10. |