知识库检索接口

开发环境

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

GET

https://api.baichuan-ai.com/v1/kbs/{kb_id}

返回指定 id 的知识库信息。

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.baichuan-ai.com/v1/kbs/' \
--header 'Authorization: Bearer $API_KEY'

响应示例

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

请求参数

Path 参数

kb_id

string

必需

Header 参数

Authorization

string

必需

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

示例值:

Bearer $API_KEY

返回响应

🟢200成功

application/json

Body

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]

文件切分字符

必需

修改于 2023-12-21 08:56:16

创建知识库接口

修改知识库接口