Knowledgebase - List All

Dienst:

Azure AI Services

API-Version:

v5.0-preview.2

Ruft alle Wissensdatenbanken für einen Benutzer ab.

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases

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

Antworten

Name	Typ	Beschreibung
200 OK	KnowledgebasesDTO	Sammlung von Wissensdatenbanken.
Other Status Codes	ErrorResponse	Fehlerantwort.

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

Beispiele

Successful query

Beispielanforderung

HTTP

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases

Beispiel für eine Antwort

Statuscode:

200

{
  "knowledgebases": [
    {
      "id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
      "hostName": "https://myqnamakerbot.azurewebsites.net",
      "lastAccessedTimestamp": "2018-03-16T10:59:46Z",
      "lastChangedTimestamp": "2018-03-16T10:58:10Z",
      "lastPublishedTimestamp": "2018-03-16T10:59:56Z",
      "name": "My QnA Maker Bot",
      "userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1",
      "urls": [
        "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
        "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
      ],
      "sources": [
        "Custom Editorial",
        "SurfaceManual.pdf"
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
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.
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.
KnowledgebaseDTO	Antwortschema für CreateKb-Vorgang.
KnowledgebasesDTO	Sammlung von Wissensdatenbanken, die einem Benutzer gehören.

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.

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.

KnowledgebaseDTO

Objekt

Antwortschema für CreateKb-Vorgang.

Name	Typ	Beschreibung
hostName	string	URL-Hostname, unter dem die Knowledgebase gehostet wird.
id	string	Eindeutige ID, die eine Wissensdatenbank identifiziert.
lastAccessedTimestamp	string	Zeitstempel, auf den die Wissensdatenbank zuletzt zugegriffen wurde (UTC).
lastChangedTimestamp	string	Zeitstempel, zu dem die Wissensdatenbank zuletzt geändert wurde (UTC).
lastPublishedTimestamp	string	Zeitstempel, zu dem die Wissensdatenbank zuletzt veröffentlicht wurde (UTC).
name	string	Anzeigename der Wissensdatenbank.
sources	string[]	Benutzerdefinierte Quellen, aus denen Q-A extrahiert oder explizit der Knowledgebase hinzugefügt wurden.
urls	string[]	URL-Quellen, aus denen Q-A extrahiert und der Wissensdatenbank hinzugefügt wurden.
userId	string	Der Benutzer, der die Wissensdatenbank erstellt/besitzt.

KnowledgebasesDTO

Objekt

Sammlung von Wissensdatenbanken, die einem Benutzer gehören.

Name	Typ	Beschreibung
knowledgebases	KnowledgebaseDTO[]	Sammlung von Knowledgebase-Datensätzen.