Knowledgebase - Create
Asynchroner Vorgang zum Erstellen einer neuen Wissensdatenbank.
POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Unterstützte Cognitive Services-Endpunkte (z. B. https://< qnamaker-resource-name >.api.cognitiveservices.azure.com). |
Anforderungsheader
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Anforderungstext
Name | Erforderlich | Typ | Beschreibung |
---|---|---|---|
name | True |
string |
Anzeigename für die Wissensdatenbank. |
defaultAnswer |
string |
Standardantwort, die an den Benutzer gesendet wird, wenn keine gute Übereinstimmung in der KB gefunden wird. |
|
defaultAnswerUsedForExtraction |
string |
Textzeichenfolge, die als Antwort in einer beliebigen Q-A verwendet werden soll, die keine extrahierte Antwort aus dem Dokument enthält, aber eine Hierarchie aufweist. Erforderlich, wenn das Feld EnableHierarchicalExtraction auf True festgelegt ist. |
|
enableHierarchicalExtraction |
boolean |
Aktivieren Sie die hierarchische Extraktion von Q-A aus Dateien und URLs. Wert, der als False betrachtet werden soll, wenn dieses Feld nicht vorhanden ist. |
|
enableMultipleLanguages |
boolean |
Legen Sie auf true fest, um das Erstellen von KBs in verschiedenen Sprachen für dieselbe Ressource zu aktivieren. |
|
files |
FileDTO[] |
Liste der Dateien, aus denen Q-A extrahiert werden soll. |
|
language |
string |
Sprache der Wissensdatenbank. Die Liste der unterstützten Sprachen finden Sie hier. |
|
qnaList |
QnADTO[] |
Liste der Q-A (QnADTO), die der Wissensdatenbank hinzugefügt werden sollen. Q-A-Ids werden vom Dienst zugewiesen und sollten weggelassen werden. |
|
urls |
string[] |
Liste der URLs, die zum Extrahieren von Q-A verwendet werden sollen. |
Antworten
Name | Typ | Beschreibung |
---|---|---|
202 Accepted |
Details des asynchronen Vorgangs. |
|
Other Status Codes |
Fehlerantwort. |
Sicherheit
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Beispiele
Successful query
Sample Request
POST {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/create
{
"name": "QnA Maker FAQ",
"qnaList": [
{
"id": 0,
"answer": "You can change the default message if you use the QnAMakerDialog. See this for details: https://docs.botframework.com/en-us/azure-bot-service/templates/qnamaker/#navtitle",
"source": "Custom Editorial",
"questions": [
"How can I change the default message from QnA Maker?"
],
"metadata": []
},
{
"id": 0,
"answer": "You can use our REST apis to create a KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/create",
"source": "Custom Editorial",
"questions": [
"How do I programmatically create a KB?"
],
"metadata": [
{
"name": "category",
"value": "api"
}
],
"context": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"displayText": "Update KB",
"qna": {
"answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update",
"questions": [
"How do I programmatically update my KB?"
],
"metadata": [
{
"name": "category",
"value": "api"
}
],
"context": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"displayText": "Refresh Endpoint Keys",
"qna": {
"answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys",
"questions": [
"How do I programmatically refresh endpoint keys?"
]
}
}
]
}
}
}
]
}
}
],
"urls": [
"https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
"https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
],
"files": [
{
"fileName": "SurfaceManual.pdf",
"fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
}
]
}
Sample Response
{
"operationState": "NotStarted",
"createdTimestamp": "2018-03-19T07:38:46Z",
"lastActionTimestamp": "2018-03-19T07:39:29Z",
"userId": "86bb8390-56c0-42c2-9f81-3de161981191",
"operationId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1"
}
Definitionen
Name | Beschreibung |
---|---|
Context |
Kontext, der Qna zugeordnet ist, um aktualisiert zu werden. |
Create |
Posttextschema für den CreateKb-Vorgang. |
Error |
Das Fehlerobjekt. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Error |
Einer der vom Server definierten Fehlercodes. |
Error |
Fehlerantwort. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
FileDTO |
DTO, um Details der hochgeladenen Dateien zu speichern. |
Inner |
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. |
Operation |
Zeichnen Sie auf, um den Betrieb mit langer Ausführung nachzuverfolgen. |
Operation |
Vorgangsstatus. |
PromptDTO |
Fordern Sie eine Antwort an. |
Qna |
QnADTO: Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein. |
QnADTO |
Q-A-Objekt. |
Context
Kontext, der Qna zugeordnet ist, um aktualisiert zu werden.
Name | Typ | Beschreibung |
---|---|---|
isContextOnly |
boolean |
So markieren Sie, 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 false ein . Ignoriert den Kontext und schließt diese QnA in das Suchergebnis ein. |
promptsToAdd |
Liste der Eingabeaufforderungen, die dem qna hinzugefügt werden sollen. |
|
promptsToDelete |
integer[] |
Liste der zu löschenden Eingabeaufforderungen, die qna zugeordnet sind |
CreateKbDTO
Posttextschema für den CreateKb-Vorgang.
Name | Typ | Beschreibung |
---|---|---|
defaultAnswer |
string |
Standardantwort, die an den Benutzer gesendet wird, wenn keine gute Übereinstimmung in der KB gefunden wird. |
defaultAnswerUsedForExtraction |
string |
Textzeichenfolge, die als Antwort in einer beliebigen Q-A verwendet werden soll, die keine extrahierte Antwort aus dem Dokument enthält, aber eine Hierarchie aufweist. Erforderlich, wenn das Feld EnableHierarchicalExtraction auf True festgelegt ist. |
enableHierarchicalExtraction |
boolean |
Aktivieren Sie die hierarchische Extraktion von Q-A aus Dateien und URLs. Wert, der als False betrachtet werden soll, wenn dieses Feld nicht vorhanden ist. |
enableMultipleLanguages |
boolean |
Legen Sie auf true fest, um das Erstellen von KBs in verschiedenen Sprachen für dieselbe Ressource zu aktivieren. |
files |
FileDTO[] |
Liste der Dateien, aus denen Q-A extrahiert werden soll. |
language |
string |
Sprache der Wissensdatenbank. Die Liste der unterstützten Sprachen finden Sie hier. |
name |
string |
Anzeigename für die Wissensdatenbank. |
qnaList |
QnADTO[] |
Liste der Q-A (QnADTO), die der Wissensdatenbank hinzugefügt werden sollen. Q-A-Ids werden vom Dienst zugewiesen und sollten weggelassen werden. |
urls |
string[] |
Liste der URLs, die zum Extrahieren von Q-A verwendet werden sollen. |
Error
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 |
Einer der vom Server definierten 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 für Menschen lesbare Darstellung des Fehlers. |
target |
string |
Das Ziel des Fehlers. |
ErrorCodeType
Einer der vom Server definierten Fehlercodes.
Name | Typ | Beschreibung |
---|---|---|
BadArgument |
string |
|
EndpointKeysError |
string |
|
ExtractionFailure |
string |
|
Forbidden |
string |
|
KbNotFound |
string |
|
NotFound |
string |
|
OperationNotFound |
string |
|
QnaRuntimeError |
string |
|
QuotaExceeded |
string |
|
SKULimitExceeded |
string |
|
ServiceError |
string |
|
Unauthorized |
string |
|
Unspecified |
string |
|
ValidationFailure |
string |
ErrorResponse
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 |
Das Fehlerobjekt. |
FileDTO
DTO, um Details der hochgeladenen Dateien zu speichern.
Name | Typ | Beschreibung |
---|---|---|
fileName |
string |
Dateiname Unterstützte Dateitypen sind ".tsv", ".pdf", ".txt", ".docx", ".xlsx". |
fileUri |
string |
Öffentlicher URI der Datei. |
isUnstructured |
boolean |
Optionales Flag, um anzugeben, ob die angegebene Datei unstrukturiert ist. |
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 |
string |
Ein spezifischerer Fehlercode als vom enthaltenden Fehler bereitgestellt wurde. |
innerError |
Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler. |
MetadataDTO
Name: Wertpaar von Metadaten.
Name | Typ | Beschreibung |
---|---|---|
name |
string |
Metadatenname |
value |
string |
Metadatenwert |
Operation
Zeichnen Sie auf, um den Betrieb mit langer Ausführung nachzuverfolgen.
Name | Typ | Beschreibung |
---|---|---|
createdTimestamp |
string |
Zeitstempel beim Erstellen des Vorgangs. |
errorResponse |
Fehlerdetails bei Fehlern. |
|
lastActionTimestamp |
string |
Zeitstempel, bei dem der aktuelle Zustand eingegeben wurde. |
operationId |
string |
Vorgangs-ID. |
operationState |
Vorgangsstatus. |
|
resourceLocation |
string |
Relativer URI zum Zielressourcenspeicherort für abgeschlossene Ressourcen. |
userId |
string |
Benutzer-ID |
OperationStateType
Vorgangsstatus.
Name | Typ | Beschreibung |
---|---|---|
Failed |
string |
|
NotStarted |
string |
|
Running |
string |
|
Succeeded |
string |
PromptDTO
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 |
qna |
QnADTO: Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein. |
|
qnaId |
integer |
Qna-ID entspricht der Eingabeaufforderung: Wenn QnaId vorhanden ist, wird das QnADTO-Objekt ignoriert. |
Qna
QnADTO: Entweder QnaId oder QnADTO muss in einem PromptDTO-Objekt vorhanden sein.
Name | Typ | Beschreibung |
---|---|---|
answer |
string |
Antworttext |
context |
Kontext einer QnA |
|
id |
integer |
Eindeutige ID für die Q-A. |
lastUpdatedTimestamp |
string |
Zeitstempel, wann die QnA zuletzt aktualisiert wurde. |
metadata |
Liste der Metadaten, die der Antwort zugeordnet sind. |
|
questions |
string[] |
Liste der Fragen, die der Antwort zugeordnet sind. |
source |
string |
Quelle, aus der Q-A indiziert wurde. Zb. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs |
QnADTO
Q-A-Objekt.
Name | Typ | Beschreibung |
---|---|---|
answer |
string |
Antworttext |
context |
Kontext einer QnA |
|
id |
integer |
Eindeutige ID für die Q-A. |
lastUpdatedTimestamp |
string |
Zeitstempel, wann die QnA zuletzt aktualisiert wurde. |
metadata |
Liste der Metadaten, die der Antwort zugeordnet sind. |
|
questions |
string[] |
Liste der Fragen, die der Antwort zugeordnet sind. |
source |
string |
Quelle, aus der Q-A indiziert wurde. Zb. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs |