LSPlatform

添加文档

开发中

POST

/v1/knowledge-bases/{{index_id}}/documents

请求参数

Header 参数

Content-Type

string

可选

示例值:

application/json

Authorization

string

可选

示例值:

Bearer {{token}}

Body 参数application/json

documents

array [object {2}]

文档数组

必需

每个文档都表示为一个 JSON 对象。

doc_name

string

文档名称

必需

doc_url

string

文档读取连接

必需

text_splitter

object

文档拆分策略

必需

method

string

文档分片策略

必需

可选：separator（按分隔符）auto（自动分片）

options

object

分片策略参数

可选

示例

{
  "documents": [
    {
      "doc_name": "string",
      "doc_url": "string"
    }
  ],
  "text_splitter": {
    "method": "string",
    "options": {
      "chunk_size": 0,
      "chunk_overlap": 0,
      "separator": 0
    }
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST '/v1/knowledge-bases/{{index_id}}/documents' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documents": [
        {
            "doc_name": "string",
            "doc_url": "string"
        }
    ],
    "text_splitter": {
        "method": "string",
        "options": {
            "chunk_size": 0,
            "chunk_overlap": 0,
            "separator": 0
        }
    }
}'

返回响应

🟢200成功

application/json

Body

message

string

必需

data

object

必需

示例

{
  "message": "创建成功",
  "data": {}
}

修改于 2024-04-11 11:57:55

创建知识库

文档分片预览