對於非結構化知識庫，擷取指定文檔的所有切片的詳細資料；對於結構化知識庫，擷取所有文本切片的詳細資料。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
sfm:ChunkList |
list |
*全部資源
|
無 | 無 |
請求文法
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。 |
{ "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
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。