跳至主要内容
版本:PrivStation 4.0.0
Markdown 原文

取得所有知識版本列表

此 API 用於取得目前所有的 Fileset(知識版本)清單。每個 Fileset 都包含其唯一 ID、名稱、狀態、建立與提交時間,以及檔案統計資訊,可用於挑選要查詢的知識版本、確認 commit 進度或執行維運管理。

curl -X 'GET' \
'http://127.0.0.1:8000/v1/filesets?limit=20&order=desc' \
-H 'accept: application/json' \
-H "Authorization: Bearer $PRIVAI_API_KEY"

Request Headers​

KeyValue
Request MethodGET
acceptapplication/json
AuthorizationBearer $PRIVAI_API_KEY

Query Parameters​

FieldTypeNoteRequired
limitint1 - 10000,預設為 10000false
orderstring依 created_at 排序,asc 或 desc,預設為 descfalse
afterstringuuid,分頁游標(Fileset ID),取得此 Fileset 之後的資料。不可與 before 同時使用false
beforestringuuid,分頁游標(Fileset ID),取得此 Fileset 之前的資料。不可與 after 同時使用false

Response Body​

{
"object": "list",
"data": [
{
"object": "fileset",
"id": "c7ea032b-eb16-4ccb-94a6-88af66db5d22",
"name": "Company Policy Files v1.0",
"metadata": {
"tag": ["policy", "operation"],
"embedding_model": "apmic-embedding-v1",
"parsing_mode": "HQ"
},
"state": "completed",
"created_at": "2025-01-01T00:00:00.000Z",
"committed_at": "2025-01-01T00:10:00.000Z",
"updated_at": "2025-01-01T00:15:00.000Z",
"file_counts": {
"draft": 0,
"queued": 0,
"processing": 0,
"completed": 1,
"failed": 0,
"total": 1
}
}
],
"first_id": "c7ea032b-eb16-4ccb-94a6-88af66db5d22",
"last_id": "c7ea032b-eb16-4ccb-94a6-88af66db5d22",
"has_more": false
}

Field Explanation

FieldDetail
object固定為 list
data[]請參考「知識版本物件」章節列表
first_id本頁第一個知識版本的 ID,無資料時為 null
last_id本頁最後一個知識版本的 ID,無資料時為 null
has_more是否還有更多的知識版本

備註:file_counts 是依據 Fileset File State 計算,而非 File 物件本身的解析狀態。

常見錯誤代碼​

Error CodeHTTP Status情境
VAL_001422同時帶入 after 與 before
VAL_002404after/before 指定的 Fileset ID 不存在

身份驗證錯誤(AUTH_001~AUTH_003)詳見「錯誤代碼說明-身份驗證類」章節;參數驗證錯誤請參考 錯誤代碼說明-傳遞參數驗證類。