查詢知識庫中的文檔列表
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
POST HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| KbUuid |
string |
是 |
知識庫 ID。 |
kb-*** |
| NextToken |
string |
否 |
分頁遊標標識。說明 如果不設定該參數，則表示擷取第一頁的資料。當該參數有傳回值時，說明還有下一頁，您可以將返回的 NextToken 作為參數再次請求獲得下一頁的資料，直到返回為 Null 為止，表示擷取到了所有的資料。 |
zCXSmY0CJbybp6FZV7vo0Wjw64X-***** |
| MaxResults |
integer |
否 |
每頁的最巨量資料條數。 取值範圍：1~100。 預設值：20。 |
20 |
| NamePattern |
string |
否 |
文檔名稱過濾，返迴文檔名稱中包含該值的文檔 |
test |
| SortFieldName |
string |
否 |
排序欄位，取值：
|
hits |
| SortOrder |
string |
否 |
排序方向，取值範圍：
|
DESC |
| Filters |
string |
否 |
文件屬性過濾，支援以下兩種屬性：
|
{"fileExt":"pdf","state":0} |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
Schema of Response |
||
| RequestId |
string |
本次調用的唯一 ID。出現錯誤後，您可以根據該 ID 排查問題。 |
67E910F2-4B62-5B0C-ACA3-7547695C**** |
| TotalCount |
integer |
滿足條件的文檔總數（目前暫不支援，傳回值恒定為 0）。 |
0 |
| Data |
array |
文檔列表。 |
|
| OneMetaKnowledgeBaseDocument |
返回結構體 |
||
| NextToken |
string |
分頁遊標標識。 |
zCXSmY0CJbybp6FZV7vo0Wjw64X-***** |
| MaxResults |
integer |
分頁大小。 |
20 |
| Success |
boolean |
請求是否成功，傳回值如下：
|
true |
| ErrorCode |
string |
錯誤碼，請求異常時返回。 |
KnowledgeBaseNotFound |
| ErrorMessage |
string |
調用失敗時，返回的錯誤資訊。 |
Resource not found kb-*** |
樣本
正常返回樣本
JSON格式
{
"RequestId": "67E910F2-4B62-5B0C-ACA3-7547695C****",
"TotalCount": 0,
"Data": [
{
"KbUuid": "",
"Name": "",
"Description": "",
"FileExt": "",
"DocumentLoaderName": "",
"TextSplitterName": "",
"GmtCreate": "",
"GmtModified": "",
"FileSize": 0,
"DocsCount": 0,
"State": 0,
"Summary": "",
"Keywords": ""
}
],
"NextToken": "zCXSmY0CJbybp6FZV7vo0Wjw64X-*****",
"MaxResults": 20,
"Success": true,
"ErrorCode": "KnowledgeBaseNotFound",
"ErrorMessage": "Resource not found kb-***"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。