列出批次¶
GET https://generativelanguage.googleapis.com/v1beta/batches
列出符合請求中指定篩選條件的作業。若伺服器不支援此方法,會傳回 UNIMPLEMENTED。
參數¶
filter: string
標準清單篩選條件。
pageSize: integer
標準清單頁面大小。
pageToken: string
標準清單頁面權杖。
returnPartialSuccess: boolean
設為 true 時,可連線的作業會正常傳回,無法連線的作業則會傳回至 ListOperationsResponse.unreachable 欄位。此設定僅能在跨集合讀取時設為 true。例如,當 parent 設為 "projects/example/locations/-" 時。依預設不支援此欄位,除非服務或產品專屬文件另有明確說明,否則設定後會導致 UNIMPLEMENTED 錯誤。
範例請求
curl -X GET "https://generativelanguage.googleapis.com/v1beta/batches" \
-H "x-goog-api-key: $GEMINI_API_KEY"
回應¶
**operations**: `Operation array` 符合請求中指定篩選條件的作業清單。
**error**: `Status` 作業失敗或取消時的錯誤結果。
**code**: `integer` 狀態碼,應為 google.rpc.Code 的列舉值。 **message**: `string` 面向開發人員的錯誤訊息,應以英文撰寫。任何面向使用者的錯誤訊息都應本地化,並透過 google.rpc.Status.details 欄位傳送,或由用戶端本地化。 **details**: `object array` 承載錯誤詳細資訊的訊息清單。API 可使用一組通用的訊息類型。nextPageToken: string
標準 List 下一頁權杖。
unreachable: string array
未排序的清單。無法連線的資源。當請求設定 ListOperationsRequest.return_partial_success 並跨集合讀取時填入。例如,嘗試列出所有支援位置中的所有資源時。
範例回應
{
"operations": [
{
"error": {
"code": 0,
"message": "string",
"details": [
{}
]
},
"response": {},
"name": "string",
"metadata": {},
"done": true
}
],
"nextPageToken": "string",
"unreachable": [
"string"
]
}