你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Knowledgebase - Get Details

获取特定知识库的详细信息。

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

URI 参数

Name In Required Type Description
Endpoint
path True
  • string

支持的认知服务终结点 (,例如 https://< qnamaker-resource-name >.api.cognitiveservices.azure.com) 。

kbId
path True
  • string

知识库 ID。

请求头

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

响应

Name Type Description
200 OK

知识库的详细信息。

Other Status Codes

错误响应。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Successful query

Sample Request

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

Sample Response

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

定义

Error

错误对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

ErrorCodeType

服务器定义的错误代码集之一。

ErrorResponse

错误响应。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

InnerErrorModel

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

KnowledgebaseDTO

CreateKb 操作的响应架构。

Error

错误对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

服务器定义的错误代码集之一。

details

有关导致此错误的特定错误的详细信息数组。

innerError

包含与当前对象有关错误的更具体信息的对象。

message
  • string

错误的可读表示形式。

target
  • string

错误的目标。

ErrorCodeType

服务器定义的错误代码集之一。

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

错误响应。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
error

错误对象。

InnerErrorModel

包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code
  • string

比包含的错误更具体的错误代码。

innerError

包含与当前对象有关错误的更具体信息的对象。

KnowledgebaseDTO

CreateKb 操作的响应架构。

Name Type Description
hostName
  • string

托管知识库的 URL 主机名。

id
  • string

标识知识库的唯一 ID。

lastAccessedTimestamp
  • string

上次访问知识库的时间戳 (UTC) 。

lastChangedTimestamp
  • string

知识库上次修改的时间戳 (UTC) 。

lastPublishedTimestamp
  • string

知识库上次发布的时间戳 (UTC) 。

name
  • string

知识库的友好名称。

sources
  • string[]

从中提取 Q-A 或显式添加到知识库的自定义源。

urls
  • string[]

从中提取 Q-A 并将其添加到知识库的 URL 源。

userId
  • string

创建/拥有知识库的用户。