Skip to content

知识库

内置知识库管理操作


获取所有知识库

GET
/api/v1/knowledge/bases

获取所有内置知识库列表

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

响应

成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"bases": [
{
}
]
}
}

试验场

服务器
授权

示例


创建知识库

POST
/api/v1/knowledge/bases

创建新的内置知识库

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

请求体

application/json
JSON
{
"name": "string",
"description": "string",
"embedding_model_uuid": "string"
}

响应

创建成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"uuid": "string"
}
}

试验场

服务器
授权
主体

示例


获取知识库详情

GET
/api/v1/knowledge/bases/{kb_uuid}

获取指定知识库的详细信息

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填

响应

成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"base": {
}
}
}

试验场

服务器
授权
变量

示例


更新知识库

PUT
/api/v1/knowledge/bases/{kb_uuid}

更新知识库信息

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填

请求体

application/json
JSON
{
"name": "string",
"description": "string"
}

响应

更新成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
}
}

试验场

服务器
授权
变量
主体

示例


删除知识库

DELETE
/api/v1/knowledge/bases/{kb_uuid}

删除指定的知识库

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填

响应

删除成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
}
}

试验场

服务器
授权
变量

示例


获取知识库文件列表

GET
/api/v1/knowledge/bases/{kb_uuid}/files

获取指定知识库中的所有文件

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填

响应

成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"files": [
{
}
]
}
}

试验场

服务器
授权
变量

示例


添加文件到知识库

POST
/api/v1/knowledge/bases/{kb_uuid}/files

将已上传的文件添加到知识库进行处理

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填

请求体

application/json
JSON
{
"file_id": "string"
}

响应

添加成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"task_id": "string"
}
}

试验场

服务器
授权
变量
主体

示例


从知识库删除文件

DELETE
/api/v1/knowledge/bases/{kb_uuid}/files/{file_id}

从指定知识库中删除文件

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填
file_id*

文件 ID

类型string
必填

响应

删除成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
}
}

试验场

服务器
授权
变量

示例


检索知识库

POST
/api/v1/knowledge/bases/{kb_uuid}/retrieve

在知识库中搜索相关知识

授权

ApiKeyAuth

使用 X-API-Key 请求头进行 API 密钥认证。
示例:X-API-Key: lbk_your_api_key_here

类型API Key (header: X-API-Key)
BearerAuth

Bearer 令牌认证。可以是用户 JWT 令牌或 API 密钥。
示例:Authorization: Bearer <token_or_key>

类型HTTP (bearer)

参数

路径参数

kb_uuid*

知识库 UUID

类型string
必填

请求体

application/json
JSON
{
"query": "string"
}

响应

检索成功

application/json
JSON
{
"code": 0,
"msg": "ok",
"data": {
"results": [
{
}
]
}
}

试验场

服务器
授权
变量
主体

示例


技术支持 VitePress OpenAPI