Freigeben über

Knowledgebase - Create

  • Referenz
Dienst:
Azure AI Services
API-Version:
v5.0-preview.2

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ützter Cognitive Services-Endpunkt (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

minLength: 1
maxLength: 100

Anzeigename für die Wissensdatenbank.
defaultAnswer

string

minLength: 1
maxLength: 300

Standardantwort, die an den Benutzer gesendet wird, wenn keine gute Übereinstimmung in der KB gefunden wird.
defaultAnswerUsedForExtraction

string

minLength: 1
maxLength: 300

Textzeichenfolge, die als Antwort in einer beliebigen F-A verwendet werden soll, die keine extrahierte Antwort aus dem Dokument enthält, aber eine Hierarchie hat. 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 "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

minLength: 1
maxLength: 100

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

Operation

Details des asynchronen Vorgangs.
Other Status Codes

ErrorResponse

Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:
202 
{
  "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

Der mit Qna verknüpfte Kontext, der aktualisiert werden soll.
CreateKbDTO

Post body schema for CreateKb operation.
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.
FileDTO

DTO zum Speichern von Details zu hochgeladenen Dateien.
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.
Operation

Aufzeichnen, um den Vorgang mit langer Ausführung nachzuverfolgen.
OperationStateType

Vorgangszustand.
PromptDTO

Zur Eingabe einer Antwort auffordern.
Qna

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

Q-A-Objekt.

Context

Objekt

Der mit Qna verknüpfte Kontext, der aktualisiert werden soll.

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.
promptsToAdd

PromptDTO[]

Liste der Eingabeaufforderungen, die der qna hinzugefügt werden sollen.
promptsToDelete

integer[] (int32)

Liste der mit qna verknüpften Eingabeaufforderungen, die gelöscht werden sollen

CreateKbDTO

Objekt

Post body schema for CreateKb operation.

Name Typ Beschreibung
defaultAnswer

string

minLength: 1
maxLength: 300

Standardantwort, die an den Benutzer gesendet wird, wenn keine gute Übereinstimmung in der KB gefunden wird.
defaultAnswerUsedForExtraction

string

minLength: 1
maxLength: 300

Textzeichenfolge, die als Antwort in einer beliebigen F-A verwendet werden soll, die keine extrahierte Antwort aus dem Dokument enthält, aber eine Hierarchie hat. 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 "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

minLength: 1
maxLength: 100

Sprache der Wissensdatenbank. Die Liste der unterstützten Sprachen finden Sie hier.
name

string

minLength: 1
maxLength: 100

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

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.

FileDTO

Objekt

DTO zum Speichern von Details zu hochgeladenen Dateien.

Name Typ Beschreibung
fileName

string

minLength: 1
maxLength: 200

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

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.

Operation

Objekt

Aufzeichnen, um den Vorgang mit langer Ausführung nachzuverfolgen.

Name Typ Beschreibung
createdTimestamp

string

Zeitstempel beim Erstellen des Vorgangs.
errorResponse

ErrorResponse

Fehlerdetails im Falle von Fehlern.
lastActionTimestamp

string

Zeitstempel, als der aktuelle Zustand eingegeben wurde.
operationId

string

Vorgangs-ID.
operationState

OperationStateType

Vorgangszustand.
resourceLocation

string

Relativer URI zum Zielressourcenspeicherort für abgeschlossene Ressourcen.
userId

string

Benutzer-ID

OperationStateType

Enumeration

Vorgangszustand.

Wert Beschreibung
Failed
NotStarted
Running
Succeeded

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.
lastUpdatedTimestamp

string

maxLength: 300

Zeitstempel, als die QnA zuletzt aktualisiert wurde.
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

QnADTO

Objekt

Q-A-Objekt.

Name Typ Beschreibung
answer

string

minLength: 1
maxLength: 25000

Antworttext
context

Context

Kontext eines QnA
id

integer (int32)

Eindeutige ID für Q-A.
lastUpdatedTimestamp

string

maxLength: 300

Zeitstempel, als die QnA zuletzt aktualisiert wurde.
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