查询知识块列表
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| KbUuid |
string |
是 |
知识库 ID。 |
kb-*** |
| DocumentName |
string |
否 |
文档名称。 |
test.md |
| NextToken |
string |
否 |
分页游标标识。说明 如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。 |
zCXSmY0CJbybp6FZV7vo0Wjw64X-***** |
| MaxResults |
integer |
否 |
每页的最大数据条数。 取值范围：1~100。 默认值：20。 |
20 |
| ChunkTitlePattern |
string |
否 |
知识块过滤，返回知识块标题中包含该值的知识块。 |
test |
| SortFieldName |
string |
否 |
排序字段。取值范围：
|
hits |
| SortOrder |
string |
否 |
排序方向。取值范围：
|
DESC |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
本次调用的唯一 ID。出现错误后，您可以根据该 ID 排查问题。 |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| Data |
array |
知识块列表。 |
|
| OneMetaKnowledgeBaseChunk |
返回结构体。 |
||
| Success |
boolean |
请求是否成功，返回值如下：
|
true |
| ErrorCode |
string |
错误码，请求异常时返回。 |
KnowledgeBaseNotFound |
| ErrorMessage |
string |
调用失败时，返回的错误信息。 |
Resource not found kb-*** |
| TotalCount |
integer |
满足条件的知识块总数（目前暂不支持，返回值恒定为 0）。 |
0 |
| MaxResults |
integer |
分页大小。 |
20 |
| NextToken |
string |
分页游标标识。 |
zCXSmY0CJbybp6FZV7vo0Wjw64X-***** |
示例
正常返回示例
JSON格式
{
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"Data": [
{
"Id": "",
"DocName": "",
"Content": "",
"ChunkTitle": "",
"ChunkMtime": ""
}
],
"Success": true,
"ErrorCode": "KnowledgeBaseNotFound",
"ErrorMessage": "Resource not found kb-***",
"TotalCount": 0,
"MaxResults": 20,
"NextToken": "zCXSmY0CJbybp6FZV7vo0Wjw64X-*****"
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。