ListKnowledgeBaseChunks - 获取知识库切片列表

获取知识库切片列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks HTTP/1.1

请求参数

名称类型必填描述示例值
KnowledgeBaseIdstring

知识库 ID。

d-ab****89
VersionNamestring

知识库版本。默认为 v1。

v1
MetaDataobject

原始文件信息。为空表示遍历整个知识库版本。

FileUristring

文件地址。若同时传入 FileMetaId 则忽略此参数值。

oss://mybucketpath/file1.txt
FileMetaIdstring

文件元数据 ID。

xd8e****79du
ChunkStatusstring

切片状态。

  • Enable: 有效。
  • Disable: 无效。
Enable
PageNumberinteger

当前页数。

1
PageSizeinteger

每页查询数量。

20

返回参数

名称类型描述示例值
object
KnowledgeBaseChunksarray<object>

切片列表。

KnowledgeBaseChunkobject

切片详情。

KnowledgeBaseChunkIdstring

切片 ID。

123e4567-e89b-12d3-a456-426655440000
KnowledgeBaseIdstring

知识库 ID。

d-ix****o9
VersionNamestring

知识库版本。

v1
ChunkStartinteger

切片起始位置。返回从文件播放开始的毫秒数。

0
ChunkEndinteger

切片结束位置。返回从文件播放开始的毫秒数。

30000
ChunkSequenceinteger

切片在文件中的序号。

1
ChunkContentstring

切片内容。

content
ChunkSizeinteger

切片大小。

1873
ChunkStatusstring

切片状态。

  • Enable: 启用。
  • Disable: 禁用。
Enable
DownloadUrlstring

切片下载地址。图片和视频文件返回。

https://mybucket.oss-cn-shanghai.aliyuncs.com/...
ThumbnailUrlstring

切片缩略图。图片和视频文件返回。

https://mybucket.oss-cn-shanghai.aliyuncs.com/...
ChunkAttachmentarray<object>

切片附件列表。

ChunkAttachmentItemobject

切片附件。

PlaceholderIdstring

占位符 ID。

IMAGE_PLACEHOLDER_0
Typestring

附件类型。

image
Uristring

附件路径。

oss://mybucket/path/file.txt
DownloadUrlstring

下载地址。

https://mybucket.oss-cn-shanghai.aliyuncs.com/...
MetaDataobject

原始文件信息。

FileNamestring

文件名。

file1.txt
FileUristring

文件路径。

oss://mybucketpath/file1.txt
FileMetaIdstring

文件元数据 ID。

xd8e****79du
MaxResultsinteger

本次请求允许返回的最大记录条数。

10
TotalCountinteger

切片总量。

25
RequestIdstring

请求 ID。

963BD7F9-0C02-5594-9550-BCC6DD43E3C0

示例

正常返回示例

JSON格式

{
  "KnowledgeBaseChunks": [
    {
      "KnowledgeBaseChunkId": "123e4567-e89b-12d3-a456-426655440000",
      "KnowledgeBaseId": "d-ix****o9",
      "VersionName": "v1",
      "ChunkStart": 0,
      "ChunkEnd": 30000,
      "ChunkSequence": 1,
      "ChunkContent": "content",
      "ChunkSize": 1873,
      "ChunkStatus": "Enable",
      "DownloadUrl": "https://mybucket.oss-cn-shanghai.aliyuncs.com/...",
      "ThumbnailUrl": "https://mybucket.oss-cn-shanghai.aliyuncs.com/...",
      "ChunkAttachment": [
        {
          "PlaceholderId": "IMAGE_PLACEHOLDER_0",
          "Type": "image",
          "Uri": "oss://mybucket/path/file.txt",
          "DownloadUrl": "https://mybucket.oss-cn-shanghai.aliyuncs.com/..."
        }
      ],
      "MetaData": {
        "FileName": "file1.txt",
        "FileUri": "oss://mybucketpath/file1.txt",
        "FileMetaId": "xd8e****79du"
      }
    }
  ],
  "MaxResults": 10,
  "TotalCount": 25,
  "RequestId": "963BD7F9-0C02-5594-9550-BCC6DD43E3C0"
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2026-01-14新增 OpenAPI查看变更详情