知识库API介绍

本文介绍了千帆Appbuilder提供的知识库相关API能力，以及如何调用API的流程等。

API列表

平台提供了覆盖知识检索、知识库管理等API能力，您可以根据具体需求在下表中选择使用。

• 知识库检索：从指定的知识库中进行切片检索召回。

知识库管理

• 创建知识库：为当前用户创建知识库。
• 获取知识库详情：获取指定知识库详情。
• 获取知识库列表：获取当前用户知识库列表。
• 更新知识库：更新指定知识库。
• 删除知识库：删除指定知识库。

文档管理

• 上传文件到知识库：上传文件到知识库。
• 导入url到知识库：导入到知识库，当前仅支持单个web的url导入。
• 获取知识库文档列表：该接口用于查询指定知识库中的文档列表。
• 删除知识库文档：该接口用于删除知识库中的指定文档。

切片管理

• 新增切片：为当前知识库中指定文档新增切片。
• 获取切片列表：获取文件的切片列表。
• 获取切片详情 ：获取指定切片详情。
• 更新切片：更新指定切片内容。
• 删除切片：删除指定切片。

标签管理

• 新建标签：为知识库新增标签。

在线调试

千帆AppBuilder提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用，更多内容请查看API在线调试介绍。

错误码

在调用API请求后，可以通过返回的错误码、错误信息及排查建议等进行问题排查，请参考错误码。

快速开始-知识库检索

创建API密钥

首先登录控制台-安全认证-API Key。点击创建API Key。创建的API Key可用于千帆AppBuilder、ModelBuilder、AI开放能力

一个API Key支持同时调用千帆AppBuilder、ModelBuilder、AI开放能力三方面的能力。

您可以点击页面的『添加权限』选择计划用该API Key调用的范围，即可实现多方向调用。

使用API Key发送请求时，在请求的Header头域中的Authorization字段，需要包含API Key的鉴权信息。

注意: 填入鉴权信息时，需要在API Key前面加上Bearer，请求示例如下：

发送请求

拥有API Key之后，您就可以发送第一个API请求了。您可直接使用您选择的HTTP客户端REST API，也可以使用千帆官方SDK。

HTTP 请求

POST /v2/knowledgebases/query HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: Bearer <API Key>
Content-Type: application/json

{
    "type": "fulltext",
    "query": "query_str",
    "knowledgebase_ids": [
        "knowledgebase_id"
    ],
    "top": 10,
    "skip": 0
}