百川智能

知识库列表查询接口

开发环境

http://dev-cn.your-api-server.com

GET

/v1/kbs

获取全部的知识库信息

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/v1/kbs' \
--header 'Authorization: Bearer $API_KEY'

响应示例

{
  "object": "list",
  "data": [
    {
      "id": "kb-abc123",
      "object": "knowledge-base",
      "name": "kb-name",
      "description": "kb-desc",
      "file_ids": [
        "file-123",
        "file-124"
      ],
      "created_at": 1701828706,
      "updated_at": 1701828706,
      "status": "online",
      "split_type": "2",
      "split_config": {
        "chunk_overlap_len": 100,
        "chunk_max_len": 520,
        "separators": [
          "?",
          "？",
          ".",
          "。",
          "!",
          "！",
          "\n"
        ]
      }
    }
  ]
}

请求参数

Header 参数

Authorization

string

必需

请求鉴权的 APIKey，由百川提供。Bearer 开头

示例值:

Bearer $API_KEY

返回响应

🟢200成功

application/json

Body

object

string

必需

对象类型"list"

data

array [object {10}]

必需

返回文件对象的 list

string

可选

唯一标识，在 api 请求中使用

object

string

可选

对象类型，固定为“knowledge-base”

name

string

可选

知识库名称，20 字以内

description

string

可选

知识库描述，200 字以内

file_ids

array[string]

知识库关联文件列表

可选

created_at

integer

可选

创建时间，Unix 时间戳（秒）

updated_at

integer

可选

更新时间，Unix 时间戳（秒）

status

string

可选

init:待解析；parsing:解析中；online:解析成功；fail:解析失败。

split_type

string

可选

1:默认分片；2:自定义分片

split_config

object

分片配置

可选

删除知识库接口

创建知识库文件接口