文档分块

获取指定文档的分块列表，可用于排查文档切分效果和检索命中内容。

Try It

GET/documents/document_chunks?doc_id=doc_1https://api-platform.ope.ai

认证

使用 Bearer Token 认证。

• Header：Authorization: Bearer <token>
• 示例：Authorization: Bearer sk-xxxxxx

查询参数

字段	类型	必填	说明	默认值 / 范围
doc_id	string	是	要查询分块的文档 ID	-

请求示例

cURL

curl -X GET "https://api-platform.ope.ai/documents/document_chunks?doc_id=doc_1" \
  -H "Authorization: Bearer $OPEAI_API_KEY"

JavaScript

const url = new URL("https://api-platform.ope.ai/documents/document_chunks");
url.searchParams.set("doc_id", "doc_1");

const res = await fetch(url, {
  headers: {
    Authorization: `Bearer ${process.env.OPEAI_API_KEY}`,
  },
});

console.log(await res.json());

响应示例

{
  "chunks": [
    {
      "chunk_id": "chunk_1",
      "chunk_text": "这里是文档分块内容。",
      "enabled": true
    }
  ]
}

错误响应

状态码	场景	说明
401	鉴权失败	API Key 缺失、无效或权限不足
422	参数校验失败	doc_id 缺失或格式不正确
500	查询失败	数据库查询失败或查询结果异常