获取知识库切片列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
pailangstudio:ListKnowledgeBaseChunks |
list |
*全部资源
|
无 | 无 |
请求语法
GET /api/v1/langstudio/knowledgebases/{KnowledgeBaseId}/knowledgebasechunks HTTP/1.1路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KnowledgeBaseId |
string |
是 |
知识库 ID。 |
d-ab****89 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| VersionName |
string |
否 |
知识库版本。默认为 v1。 |
v1 |
| MetaData |
object |
否 |
原始文件信息。为空表示遍历整个知识库版本。 |
1 |
| FileUri |
string |
否 |
文件地址。若同时传入 FileMetaId 则忽略此参数值。 |
oss://mybucketpath/file1.txt |
| FileMetaId |
string |
否 |
文件元数据 ID。 |
xd8e****79du |
| ChunkStatus |
string |
否 |
切片状态。
|
Enable |
| PageNumber |
integer |
否 |
当前页数。 |
1 |
| PageSize |
integer |
否 |
每页查询数量。 |
20 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| KnowledgeBaseChunks |
array<object> |
切片列表。 |
|
|
array<object> |
切片详情。 |
||
| KnowledgeBaseChunkId |
string |
切片 ID。 |
123e4567-e89b-12d3-a456-426655440000 |
| KnowledgeBaseId |
string |
知识库 ID。 |
d-ix****o9 |
| VersionName |
string |
知识库版本。 |
v1 |
| ChunkStart |
integer |
切片起始位置。返回从文件播放开始的毫秒数。 |
0 |
| ChunkEnd |
integer |
切片结束位置。返回从文件播放开始的毫秒数。 |
30000 |
| ChunkSequence |
integer |
切片在文件中的序号。 |
1 |
| ChunkContent |
string |
切片内容。 |
content |
| ChunkSize |
integer |
切片大小。 |
1873 |
| ChunkStatus |
string |
切片状态。
|
Enable |
| DownloadUrl |
string |
切片下载地址。图片和视频文件返回。 |
https://mybucket.oss-cn-shanghai.aliyuncs.com/... |
| ThumbnailUrl |
string |
切片缩略图。图片和视频文件返回。 |
https://mybucket.oss-cn-shanghai.aliyuncs.com/... |
| ChunkAttachment |
array<object> |
切片附件列表。 |
|
|
object |
切片附件。 |
||
| PlaceholderId |
string |
占位符 ID。 |
IMAGE_PLACEHOLDER_0 |
| Type |
string |
附件类型。 |
image |
| Uri |
string |
附件路径。 |
oss://mybucket/path/file.txt |
| DownloadUrl |
string |
下载地址。 |
https://mybucket.oss-cn-shanghai.aliyuncs.com/... |
| MetaData |
object |
原始文件信息。 |
|
| FileName |
string |
文件名。 |
file1.txt |
| FileUri |
string |
文件路径。 |
oss://mybucketpath/file1.txt |
| FileMetaId |
string |
文件元数据 ID。 |
xd8e****79du |
| MaxResults |
integer |
本次请求允许返回的最大记录条数。 |
10 |
| TotalCount |
integer |
切片总量。 |
25 |
| RequestId |
string |
请求 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"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。