Knowledgebase - Get Details

Reference

Service:: Azure AI Services

API Version:: v5.0-preview.2

Gets details of a specific knowledgebase.

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

URI Parameters

Name	In	Required	Type	Description
Endpoint	path	True	string	Supported Cognitive Services endpoint (e.g., https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
kbId	path	True	string	Knowledgebase id.

Request Header

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

Responses

Name	Type	Description
200 OK	KnowledgebaseDTO	Details of the knowledgebase.
Other Status Codes	ErrorResponse	Error response.

Security

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Examples

Successful query

Sample request

HTTP

GET {Endpoint}/qnamaker/v5.0-preview.2/knowledgebases/9d091697-fb8c-4ed5-9ac0-35bf8273bfff

Sample response

Status code:: 200

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

Definitions

Name	Description
Error	The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	One of a server-defined set of error codes.
ErrorResponse	Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
InnerErrorModel	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KnowledgebaseDTO	Response schema for CreateKb operation.

Error

The error object. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	ErrorCodeType	One of a server-defined set of error codes.
details	Error[]	An array of details about specific errors that led to this reported error.
innerError	InnerErrorModel	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

ErrorCodeType

One of a server-defined set of error codes.

Name	Type	Description
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

Error response. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
error	Error	The error object.

InnerErrorModel

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	string	A more specific error code than was provided by the containing error.
innerError	InnerErrorModel	An object containing more specific information than the current object about the error.

KnowledgebaseDTO

Response schema for CreateKb operation.

Name	Type	Description
hostName	string	URL host name at which the knowledgebase is hosted.
id	string	Unique id that identifies a knowledgebase.
lastAccessedTimestamp	string	Time stamp at which the knowledgebase was last accessed (UTC).
lastChangedTimestamp	string	Time stamp at which the knowledgebase was last modified (UTC).
lastPublishedTimestamp	string	Time stamp at which the knowledgebase was last published (UTC).
name	string	Friendly name of the knowledgebase.
sources	string[]	Custom sources from which Q-A were extracted or explicitly added to the knowledgebase.
urls	string[]	URL sources from which Q-A were extracted and added to the knowledgebase.
userId	string	User who created / owns the knowledgebase.

Share via