ListChunks
查看文字切片列表及資訊。
介面說明
對於文件搜尋類知識庫，本介面可查詢指定檔案的所有切片內容；而對於資料查詢或圖片問答類知識庫，則可取得全部文字切片的資訊。
RAM 使用者（子帳號）需要先取得阿里雲百煉的 API 權限（需要
AliyunBailianDataFullAccess，已包含 sfm:ChunkList 權限點），並加入一個業務空間後，方可呼叫本介面。阿里雲帳號（主帳號）可直接呼叫無須授權。建議您透過最新版阿里雲百煉 SDK來呼叫本介面。呼叫本介面前，請確保您的知識庫已經建立完成且未被刪除（即知識庫 ID
IndexId有效）。本介面具有冪等性。
限流說明： 本介面頻繁呼叫會被限流，頻率請勿超過 10 次/秒。如遇限流，請稍後重試。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sfm:ChunkList |
list |
*All Resource
|
無 | 無 |
請求文法
POST /{WorkspaceId}/index/list_chunks HTTP/1.1路徑參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| WorkspaceId |
string |
是 |
知識庫所屬的業務空間 ID。取得方式請參見如何使用業務空間。 |
llm-3z7uw7fwz0vxxxx |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| body |
object |
否 |
請求參數的主體資訊。 |
|
| Fields |
array |
否 |
Fields 是一個欄位名稱陣列，用於對本介面回傳的 Metadata 欄位中的非私有 Field（以_底線為字首）進行過濾。預設 Fields 為空時，Metadata 欄位中所有非私有的 Field 都會回傳。若您希望回傳的 Metadata 欄位只包含指定的非私有 Field，例如只包含 title，則此處傳入 title 即可。 預設值為空。 |
|
|
string |
否 |
欄位名稱。 |
name |
|
| Filed |
string |
否 |
本欄位為阿里雲百煉舊版 SDK 中的檔案 ID 欄位。具體用法和預設值與
說明
如何查看阿里雲百煉 SDK 版本：造訪阿里雲百煉 SDK 中心，按一下左側導覽列中的「安裝」，API 版本選擇「2023-12-29」，然後選擇您的開發語言，再按一下「歷史版本」即可查看。 |
file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
| FileId |
string |
否 |
檔案 ID，即 AddFile 介面回傳的 |
file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx |
| IndexId |
string |
是 |
知識庫 ID，即 CreateIndex 介面回傳的 |
otoru9xxxx |
| PageNum |
integer |
否 |
指定要查詢的頁碼。起始值為 1，預設值為 1。 |
1 |
| PageSize |
integer |
否 |
指定分頁查詢時每頁顯示的文字切片數量。最大為 100。預設值為 10。 |
10 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| Code |
string |
錯誤狀態碼。 |
Index.InvalidParameter |
| Data |
object |
介面回傳的業務欄位。 |
|
| Nodes |
array<object> |
文字切片列表。 |
|
|
object |
文字切片物件。 |
||
| Metadata |
any |
文字切片的中繼資料 Map。 說明
文件搜尋類知識庫的中繼資料 Map 中 說明
檢索文件搜尋類知識庫時，若切片包含圖片，將透過中繼資料 Map 中的 |
{ "file_path": "https://bailian-***", "parent": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "is_displayed_chunk_content": "true", "image_url": [], "nid": "83***", "source": "0", "_score": 0, "title": "", "doc_id": "file_24e***", "content": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。", "_rc_score": 0, "workspace_id": "llm-zna***", "hier_title": "", "doc_name": "什么是阿里云百炼", "pipeline_id": "j6b***", "_id": "llm-zna5***" } |
| Score |
number |
文本切片的相似度得分。 |
0 |
| Text |
string |
文字切片內容。 |
阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。 |
| Total |
integer |
回傳結果的總筆數。 |
1 |
| Message |
string |
錯誤訊息。 |
Required parameter(%s) missing or invalid, please check the request parameters. |
| RequestId |
string |
請求 ID。 |
8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1 |
| Status |
string |
介面回傳的狀態碼。 |
200 |
| Success |
boolean |
介面呼叫是否成功，可能值：
|
true |
樣本
正常返回樣本
JSON格式
{
"Code": "Index.InvalidParameter",
"Data": {
"Nodes": [
{
"Metadata": "{\n \"file_path\": \"https://bailian-***\",\n \"parent\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n \"is_displayed_chunk_content\": \"true\",\n \"image_url\": [],\n \"nid\": \"83***\",\n \"source\": \"0\",\n \"_score\": 0,\n \"title\": \"\",\n \"doc_id\": \"file_24e***\",\n \"content\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。\",\n \"_rc_score\": 0,\n \"workspace_id\": \"llm-zna***\",\n \"hier_title\": \"\",\n \"doc_name\": \"什么是阿里云百炼\",\n \"pipeline_id\": \"j6b***\",\n \"_id\": \"llm-zna5***\"\n}",
"Score": 0,
"Text": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员，都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作，在 5分钟内开发出一款大模型应用，或在几小时内训练出一个专属模型，从而将更多精力专注于应用创新。"
}
],
"Total": 1
},
"Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
"RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
"Status": "200",
"Success": true
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。