1. 接口描述
接口请求域名： es.tencentcloudapi.com 。
文本切片是将长文本分割为短片段的技术，用于适配模型输入、提升处理效率或信息检索，平衡片段长度与语义连贯性，适用于NLP、数据分析等场景。
本接口为分隔符规则切片接口，有单账号调用上限控制，如您有提高并发限制的需求请 联系我们 。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ChunkDocument。 |
| Version | 是 | String | 公共参数，本接口取值：2025-01-01。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Document | 是 | ChunkDocument | 切片文件信息。 示例值：Document |
| ModelName | 是 | String | 模型名称，可选模型列表：doc-chunk。 示例值：doc-chunk |
| Config | 否 | ChunkConfig | 文件切片配置。 示例值：Config |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Chunks | Array of Chunk | 无 |
| Usage | Usage | token消耗量 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 实时文档切片
输入示例
POST / HTTP/1.1
Host: es.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChunkDocument
<公共请求参数>
{
"Document": {
"FileType": "TXT",
"FileContent": "基于分隔符、文本长度进行切片，适用规则性较强的文本"
},
"ModelName": "doc-chunk",
"Config": {
"MaxChunkSize": 100
}
}输出示例
{
"Response": {
"Chunks": [
{
"Content": "基于分隔符、文本长度进行切片，适用规则性较强的文本",
"Index": 0
}
],
"RequestId": "eeb0d39a-8a4a-431b-a577-2595202afaa1"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。
