批次
/batches 路徑提供關於非同步操作批次的進度資訊。
批次物件
{
"uid": 0,
"details": {
"receivedDocuments": 6,
"indexedDocuments": 6
},
"stats": {
"totalNbTasks": 1,
"status": {
"succeeded": 1
},
"types": {
"documentAdditionOrUpdate": 1
},
"indexUids": {
"INDEX_NAME": 1
}
},
"duration": "PT0.250518S",
"startedAt": "2024-12-10T15:20:30.18182Z",
"finishedAt": "2024-12-10T15:20:30.432338Z",
"progress": {
"steps": [
{
"currentStep": "extracting words",
"finished": 2,
"total": 9,
},
{
"currentStep": "document",
"finished": 30546,
"total": 31944,
}
],
"percentage": 32.8471
}
}
uid
類型：整數
描述：批次的唯一循序識別碼。從 0 開始，每次新增批次時加一。
詳細資訊
類型：物件
描述：批次中任務類型的基本資訊。請參閱任務物件參考，以取得所有可能值的完整列表。
進度
類型：物件
描述：包含兩個欄位的物件：steps 和 percentage。一旦 Meilisearch 完全處理完批次，其 progress 會設定為 null。
步驟
關於 Meilisearch 在此批次中執行的目前操作的資訊。一個步驟可能包含多個子步驟。
| 名稱 | 描述 |
|---|---|
currentStep | 描述操作的字串 |
total | 步驟中的操作總數 |
finished | Meilisearch 已完成的操作數 |
如果 Meilisearch 處理批次的時間比預期的長，請監控 steps 陣列。如果 steps 陣列中最後一個項目的 finished 欄位沒有更新，則 Meilisearch 可能卡住了。
percentage
根據所有目前步驟和子步驟計算出的已完成操作百分比。由於不同步驟的處理速度不同，此值是一個粗略的估計值，可能無法總是反映批次的目前狀態。
統計資料
類型：物件
描述：批次中所有任務的有效負載詳細資訊。
totalNbTasks
批次中的任務數。
狀態
列出批次中每個任務狀態的物件。包含五個鍵，其值對應於具有該狀態的任務數。
類型
包含在批次中的任務類型列表。
indexUids
批次中任務數的列表，按其影響的索引分隔。
持續時間
類型：字串
描述：批次在 processing 狀態下所花費的總時間，以ISO 8601格式表示。當批次正在處理任務時，設定為 null。
startedAt
類型：字串
描述：批次開始 processing 的日期和時間，以RFC 3339格式表示
finishedAt
類型：字串
描述：任務完成 processing 的日期和時間，無論是 failed、succeeded 還是 canceled，都以RFC 3339格式表示
取得批次
列出所有批次，無論索引為何。批次物件包含在 results 陣列中。
批次永遠以 uid 的降序返回。這表示預設情況下，最近建立的批次物件會先顯示。
`/batches` 參數和任務
/batches 的某些查詢參數，例如 uids 和 statuses，目標是任務而非批次。
例如，?uids=0 會返回包含 taskUid 等於 0 的任務的批次，而不是 batchUid 等於 0 的批次。
查詢參數
| 查詢參數 | 預設值 | 描述 |
|---|---|---|
uids | * (所有任務 uid) | 選取包含具有指定 uid 的任務的批次。以逗號 (,) 分隔多個任務 uids |
batchUids | * (所有批次 uid) | 依其 uid 篩選批次。以逗號 (,) 分隔多個批次 uids |
indexUids | * (所有索引) | 選取包含影響指定索引的任務的批次。以逗號 (,) 分隔多個 indexUids |
statuses | * (所有狀態) | 選取包含具有指定 status 的任務的批次。以逗號 (,) 分隔多個任務 statuses |
類型 | * (所有類型) | 選取包含具有指定 type 的任務的批次。以逗號 (,) 分隔多個任務 types |
limit | 20 | 要返回的批次數 |
from | 最後建立的批次的 uid | 返回的第一個批次的 uid |
reverse | false | 如果為 true，則以反向順序返回結果，從最舊到最新 |
beforeEnqueuedAt | * (所有任務) | 選取包含具有指定 enqueuedAt 欄位的任務的批次 |
beforeStartedAt | * (所有任務) | 選取包含具有指定 startedAt 欄位的任務的批次 |
beforeFinishedAt | * (所有任務) | 選取包含具有指定 finishedAt 欄位的任務的批次 |
afterEnqueuedAt | * (所有任務) | 選取包含具有指定 enqueuedAt 欄位的任務的批次 |
afterStartedAt | * (所有任務) | 選取包含具有指定 startedAt 欄位的任務的批次 |
afterFinishedAt | * (所有任務) | 選取包含具有指定 finishedAt 欄位的任務的批次 |
回應
| 名稱 | 類型 | 描述 |
|---|---|---|
results | 陣列 | 批次物件的陣列 |
total | 整數 | 符合篩選條件或查詢的批次總數 |
limit | 整數 | 返回的批次數 |
from | 整數 | 返回的第一個批次的 uid |
next | 整數 | 傳遞至 from 以檢視下一「頁」結果的值。當 next 的值為 null 時，表示沒有更多任務可檢視 |
範例
curl \
-X GET 'https://127.0.0.1:7700/batches'回應：200 Ok
{
"results": [
{
"uid": 2,
"details": {
"stopWords": [
"of",
"the"
]
},
"progress": null,
"stats": {
"totalNbTasks": 1,
"status": {
"succeeded": 1
},
"types": {
"settingsUpdate": 1
},
"indexUids": {
"INDEX_NAME": 1
}
},
"duration": "PT0.110083S",
"startedAt": "2024-12-10T15:49:04.995321Z",
"finishedAt": "2024-12-10T15:49:05.105404Z"
}
],
"total": 3,
"limit": 1,
"from": 2,
"next": 1
}
取得一個批次
取得單個批次。
路徑參數
| 名稱 | 類型 | 描述 |
|---|---|---|
batch_uid * | 字串 | 請求的批次的uid |
範例
curl \
-X GET 'https://127.0.0.1:7700/batches/BATCH_UID'回應：200 Ok
{
"uid": 1,
"details": {
"receivedDocuments": 1,
"indexedDocuments": 1
},
"progress": null,
"stats": {
"totalNbTasks": 1,
"status": {
"succeeded": 1
},
"types": {
"documentAdditionOrUpdate": 1
},
"indexUids": {
"INDEX_NAME": 1
}
},
"duration": "PT0.364788S",
"startedAt": "2024-12-10T15:48:49.672141Z",
"finishedAt": "2024-12-10T15:48:50.036929Z"
}