Knowledgebase - List All

Service:

Azure AI Services

API-versie:

v5.0-preview.2

Haalt alle knowledgebases voor een gebruiker op.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).

Aanvraagkoptekst

Name	Vereist	Type	Description
Ocp-Apim-Subscription-Key	True	string

Antwoorden

Name	Type	Description
200 OK	KnowledgebasesDTO	Verzameling knowledgebases.
Other Status Codes	ErrorResponse	Foutreactie.

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

Definities

Name	Description
Error	Het foutobject. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Een van een door de server gedefinieerde set foutcodes.
ErrorResponse	Foutreactie. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KnowledgebaseDTO	Antwoordschema voor de bewerking CreateKb.
KnowledgebasesDTO	Verzameling knowledgebases die eigendom zijn van een gebruiker.

Error

Object

Het foutobject. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	ErrorCodeType	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innerError	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCodeType

Inventarisatie

Een van een door de server gedefinieerde set foutcodes.

Waarde	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Object

Foutreactie. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	Een specifiekere foutcode dan is opgegeven door de bijbehorende fout.
innerError	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.

KnowledgebaseDTO

Object

Antwoordschema voor de bewerking CreateKb.

Name	Type	Description
hostName	string	URL-hostnaam waarop de knowledgebase wordt gehost.
id	string	Unieke id die een knowledge base identificeert.
lastAccessedTimestamp	string	Tijdstempel waarop de knowledgebase voor het laatst is geopend (UTC).
lastChangedTimestamp	string	Tijdstempel waarop de knowledgebase voor het laatst is gewijzigd (UTC).
lastPublishedTimestamp	string	Tijdstempel waarop de knowledgebase voor het laatst is gepubliceerd (UTC).
name	string	Beschrijvende naam van de knowledgebase.
sources	string[]	Aangepaste bronnen waaruit Q-A is geëxtraheerd of expliciet zijn toegevoegd aan de knowledgebase.
urls	string[]	URL-bronnen waaruit Q-A is geëxtraheerd en toegevoegd aan de knowledgebase.
userId	string	Gebruiker die de knowledgebase heeft gemaakt/bezit.

KnowledgebasesDTO

Object

Verzameling knowledgebases die eigendom zijn van een gebruiker.

Name	Type	Description
knowledgebases	KnowledgebaseDTO[]	Verzameling knowledgebaserecords.