百川智能
  1. 知识库
百川智能
  • 通用大模型
    • 接口说明
    • 同步接口
      POST
    • 同步请求知识库
      POST
    • 流式接口
      POST
  • 通用大模型(旧版)
    • 接口说明
    • 同步接口
      POST
    • 流式接口
      POST
  • 知识库
    • 创建知识库接口
      POST
    • 知识库检索接口
      GET
    • 修改知识库接口
      POST
    • 删除知识库接口
      DELETE
    • 知识库列表查询接口
      GET
    • 创建知识库文件接口
      POST
    • 知识库文件检索接口
      GET
    • 知识库文件删除接口
      DELETE
    • 知识库文件列表查询接口
      GET
  • 向量化模型
    • 单次请求
      POST
    • 批次请求
      POST
  • 文件管理
    • 文件列表查询
      GET
    • 文件上传接口
      POST
    • 文件删除接口
      DELETE
    • 文件检索接口
      POST
    • 文件下载接口
      GET
  • 财务相关
    • 发票
  1. 知识库

创建知识库接口

开发环境
http://dev-cn.your-api-server.com
开发环境
http://dev-cn.your-api-server.com
POST
/v1/kbs
该接口支持创建、管理知识文档。相关操作流程如下:
1.新建知识库后得到知识库 ID;
2.上传文件,获取文件 ID;
3.通过文件 ID 与知识库 ID 进行知识库文件关联,知识库中可以关联多个文档。
4.调用对话接口时通过 knowledge_base 字段传入知识库 ID 列表,大模型使用检索到的知识信息回答问题。
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://dev-cn.your-api-server.com/v1/kbs' \
--header 'Authorization: Bearer $API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
        "name": "string",
        "description": "string",
        "split_type": 2,
        "split_config": {
          "chunk_overlap_len": 500,
          "chunk_max_len": 100,
          "separators": [".","。","\n"]
        }
      }'
响应示例响应示例
                {
  "id": "kb-abc123",
  "object": "knowledge-base",
  "name": "string",
  "description": "string",
  "file_ids": [],
  "created_at": 1677610602,
  "updated_at": 1677610602,
  "status": "online",
  "split_type": ,
  "split_config": {
    "chunk_overlap_len": 512,
    "chunk_max_len": 100,
    "separators": [".","。","\n"]
  }
}

              

请求参数

Header 参数
Content-Type
string 
必需
示例值:
application/json
Authorization
string 
必需
请求鉴权的 APIKey,由百川提供。Bearer 开头
示例值:
Bearer $API_KEY
Body 参数application/json
name
string 
必需
description
string 
必需
split_type
integer 
必需
split_config
object 
必需
chunk_overlap_len
integer 
必需
chunk_max_len
integer 
必需
separators
array[string]
必需
示例

返回响应

🟢200成功
application/json
Body
id
string 
必需
唯一标识,在 api 请求中使用
object
string 
必需
对象类型,固定为“knowledge-base”
name
string 
必需
知识库名称,50 字以内
description
string 
必需
知识库描述,100 字以内
file_ids
array[string]
知识库关联文件列表
必需
created_at
integer 
必需
创建时间,Unix 时间戳(秒)
updated_at
integer 
必需
更新时间,Unix 时间戳(秒)
status
string 
必需
init:待解析;parsing:解析中;online:解析成功;fail:解析失败。
split_config
object 
分片配置
必需
chunk_overlap_len
integer 
必需

分片重叠长度, (2*chunk_overlap_len+1 <= chunk_max_len)

chunk_max_len
integer 
必需
分片最大长度, 最大 512。
separators
array[string]
文件切分字符
必需
上一页
流式接口
下一页
知识库检索接口
Built with