Gemini API mendukung API batch, yang memungkinkan Anda memproses beberapa permintaan dalam satu panggilan. Untuk mengetahui detail selengkapnya, lihat panduan Batch API.
Metode: models.batchGenerateContent
Mengantrekan batch permintaan models.generateContent untuk batch processing.
Endpoint
postinganhttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:batchGenerateContent
Parameter jalur
batch.model
string
Wajib. Nama Model yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}. Formatnya adalah models/{model}.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
batch.name
string
Hanya output. ID. Nama resource batch.
Format: batches/{batchId}.
batch.displayName
string
Wajib. Nama batch yang ditentukan pengguna.
batch.inputConfig
object (InputConfig)
Wajib. Konfigurasi input instance tempat pemrosesan batch dilakukan.
batch.output
object (GenerateContentBatchOutput)
Hanya output. Output permintaan batch.
batch.createTime
string (Timestamp format)
Hanya output. Waktu saat batch dibuat.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batch.endTime
string (Timestamp format)
Hanya output. Waktu saat pemrosesan batch selesai.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batch.updateTime
string (Timestamp format)
Hanya output. Waktu saat batch terakhir diperbarui.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batch.batchStats
object (BatchStats)
Hanya output. Statistik tentang batch.
batch.state
enum (BatchState)
Hanya output. Status batch.
batch.priority
string (int64 format)
Opsional. Prioritas batch. Batch dengan nilai prioritas yang lebih tinggi akan diproses sebelum batch dengan nilai prioritas yang lebih rendah. Nilai negatif diizinkan. Defaultnya adalah 0.
Isi respons
Jika berhasil, isi respons memuat instance Operation.
Metode: models.asyncBatchEmbedContent
Mengantrekan batch permintaan models.embedContent untuk batch processing. Kita memiliki handler models.batchEmbedContents di GenerativeService, tetapi disinkronkan. Jadi, kita beri nama yang ini Async untuk menghindari kebingungan.
Endpoint
postinganhttps: / /generativelanguage.googleapis.com /v1beta /{batch.model=models /*}:asyncBatchEmbedContent
Parameter jalur
batch.model
string
Wajib. Nama Model yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}. Formatnya adalah models/{model}.
Isi permintaan
Isi permintaan memuat data dengan struktur berikut:
batch.name
string
Hanya output. ID. Nama resource batch.
Format: batches/{batchId}.
batch.displayName
string
Wajib. Nama batch yang ditentukan pengguna.
batch.inputConfig
object (InputEmbedContentConfig)
Wajib. Konfigurasi input instance tempat pemrosesan batch dilakukan.
batch.output
object (EmbedContentBatchOutput)
Hanya output. Output permintaan batch.
batch.createTime
string (Timestamp format)
Hanya output. Waktu saat batch dibuat.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batch.endTime
string (Timestamp format)
Hanya output. Waktu saat pemrosesan batch selesai.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batch.updateTime
string (Timestamp format)
Hanya output. Waktu saat batch terakhir diperbarui.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batch.batchStats
object (EmbedContentBatchStats)
Hanya output. Statistik tentang batch.
batch.state
enum (BatchState)
Hanya output. Status batch.
batch.priority
string (int64 format)
Opsional. Prioritas batch. Batch dengan nilai prioritas yang lebih tinggi akan diproses sebelum batch dengan nilai prioritas yang lebih rendah. Nilai negatif diizinkan. Defaultnya adalah 0.
Isi respons
Jika berhasil, isi respons memuat instance Operation.
Metode: batches.get
Mendapatkan status terbaru dari operasi yang berjalan lama. Klien dapat menggunakan metode ini untuk polling hasil operasi pada interval seperti yang direkomendasikan oleh layanan API.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}
Parameter jalur
name
string
Nama resource operasi. Formatnya adalah batches/{batches}.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat instance Operation.
Metode: batches.list
Menampilkan operasi yang cocok dengan filter yang ditentukan dalam permintaan. Jika server tidak mendukung metode ini, UNIMPLEMENTED akan ditampilkan.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=batches}
Parameter jalur
name
string
Nama resource induk operasi. Formatnya adalah batches.
Parameter kueri
filter
string
Filter daftar standar.
pageSize
integer
Ukuran halaman daftar standar.
pageToken
string
Token halaman daftar standar.
returnPartialSuccess
boolean
Jika disetel ke true, operasi yang dapat dijangkau akan ditampilkan seperti biasa, dan operasi yang tidak dapat dijangkau akan ditampilkan di kolom [ListOperationsResponse.unreachable].
Nilai ini hanya dapat berupa true saat membaca di seluruh koleksi, misalnya saat parent disetel ke "projects/example/locations/-".
Kolom ini tidak didukung secara default dan akan menghasilkan error UNIMPLEMENTED jika disetel, kecuali jika didokumentasikan secara eksplisit dalam dokumentasi khusus produk atau layanan.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat instance ListOperationsResponse.
Metode: batches.cancel
Memulai pembatalan asinkron pada operasi yang berjalan lama. Server berusaha semaksimal mungkin untuk membatalkan operasi, tetapi keberhasilan tidak dijamin. Jika server tidak mendukung metode ini, google.rpc.Code.UNIMPLEMENTED akan ditampilkan. Klien dapat menggunakan Operations.GetOperation atau metode lain untuk memeriksa apakah pembatalan berhasil atau apakah operasi selesai meskipun terjadi pembatalan. Jika pembatalan berhasil, operasi tidak dihapus; sebagai gantinya, operasi ini menjadi operasi dengan nilai Operation.error dengan google.rpc.Status.code 1, yang sesuai dengan Code.CANCELLED.
Endpoint
postinganhttps: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}:cancel
Parameter jalur
name
string
Nama resource operasi yang akan dibatalkan. Formatnya adalah batches/{batches}.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons adalah objek JSON kosong.
Metode: batches.delete
Menghapus operasi yang berjalan lama. Metode ini menunjukkan bahwa klien tidak lagi tertarik dengan hasil operasi. Metode tersebut tidak membatalkan operasi. Jika server tidak mendukung metode ini, google.rpc.Code.UNIMPLEMENTED akan ditampilkan.
Endpoint
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=batches /*}
Parameter jalur
name
string
Nama resource operasi yang akan dihapus. Formatnya adalah batches/{batches}.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons adalah objek JSON kosong.
GenerateContentBatch
- Representasi JSON
- InputConfig
- InlinedRequests
- InlinedRequest
- GenerateContentBatchOutput
- InlinedResponses
- InlinedResponse
- BatchStats
Resource yang mewakili batch permintaan GenerateContent.
model
string
Wajib. Nama Model yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}.
name
string
Hanya output. ID. Nama resource batch.
Format: batches/{batchId}.
displayName
string
Wajib. Nama batch yang ditentukan pengguna.
inputConfig
object (InputConfig)
Wajib. Konfigurasi input instance tempat pemrosesan batch dilakukan.
output
object (GenerateContentBatchOutput)
Hanya output. Output permintaan batch.
createTime
string (Timestamp format)
Hanya output. Waktu saat batch dibuat.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
endTime
string (Timestamp format)
Hanya output. Waktu saat pemrosesan batch selesai.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
Hanya output. Waktu saat batch terakhir diperbarui.
Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
batchStats
object (BatchStats)
Hanya output. Statistik tentang batch.
state
enum (BatchState)
Hanya output. Status batch.
priority
string (int64 format)
Opsional. Prioritas batch. Batch dengan nilai prioritas yang lebih tinggi akan diproses sebelum batch dengan nilai prioritas yang lebih rendah. Nilai negatif diizinkan. Defaultnya adalah 0.
| Representasi JSON |
|---|
{ "model": string, "name": string, "displayName": string, "inputConfig": { object ( |
InputConfig
Mengonfigurasi input ke permintaan batch.
source
Union type
source hanya dapat berupa salah satu dari hal berikut:fileName
string
Nama File yang berisi permintaan input.
requests
object (InlinedRequests)
Permintaan yang akan diproses dalam batch.
| Representasi JSON |
|---|
{
// source
"fileName": string,
"requests": {
object ( |
InlinedRequests
Permintaan yang akan diproses dalam batch jika diberikan sebagai bagian dari permintaan pembuatan batch.
requests[]
object (InlinedRequest)
Wajib. Permintaan yang akan diproses dalam batch.
| Representasi JSON |
|---|
{
"requests": [
{
object ( |
InlinedRequest
Permintaan yang akan diproses dalam batch.
request
object (GenerateContentRequest)
Wajib. Permintaan yang akan diproses dalam batch.
metadata
object (Struct format)
Opsional. Metadata yang akan dikaitkan dengan permintaan.
| Representasi JSON |
|---|
{
"request": {
object ( |
GenerateContentBatchOutput
Output permintaan batch. Ini ditampilkan di kolom BatchGenerateContentResponse atau GenerateContentBatch.output.
output
Union type
output hanya dapat berupa salah satu dari hal berikut:responsesFile
string
Hanya output. ID file yang berisi respons. File ini akan berupa file JSONL dengan satu respons per baris. Respons akan berupa pesan GenerateContentResponse yang diformat sebagai JSON. Respons akan ditulis dalam urutan yang sama dengan permintaan input.
inlinedResponses
object (InlinedResponses)
Hanya output. Respons terhadap permintaan dalam batch. Ditampilkan saat batch dibuat menggunakan permintaan inline. Respons akan memiliki urutan yang sama dengan permintaan input.
| Representasi JSON |
|---|
{
// output
"responsesFile": string,
"inlinedResponses": {
object ( |
InlinedResponses
Respons terhadap permintaan dalam batch.
inlinedResponses[]
object (InlinedResponse)
Hanya output. Respons terhadap permintaan dalam batch.
| Representasi JSON |
|---|
{
"inlinedResponses": [
{
object ( |
InlinedResponse
Respons terhadap satu permintaan dalam batch.
metadata
object (Struct format)
Hanya output. Metadata yang terkait dengan permintaan.
output
Union type
output hanya dapat berupa salah satu dari hal berikut:error
object (Status)
Hanya output. Error yang terjadi saat memproses permintaan.
response
object (GenerateContentResponse)
Hanya output. Respons terhadap permintaan.
| Representasi JSON |
|---|
{ "metadata": { object }, // output "error": { object ( |
BatchStats
Statistik tentang batch.
requestCount
string (int64 format)
Hanya output. Jumlah permintaan dalam batch.
successfulRequestCount
string (int64 format)
Hanya output. Jumlah permintaan yang berhasil diproses.
failedRequestCount
string (int64 format)
Hanya output. Jumlah permintaan yang gagal diproses.
pendingRequestCount
string (int64 format)
Hanya output. Jumlah permintaan yang masih menunggu pemrosesan.
| Representasi JSON |
|---|
{ "requestCount": string, "successfulRequestCount": string, "failedRequestCount": string, "pendingRequestCount": string } |
Metode: batches.updateEmbedContentBatch
Memperbarui batch permintaan EmbedContent untuk pemrosesan batch.
Endpoint
patchhttps: / /generativelanguage.googleapis.com /v1beta /{embedContentBatch.name=batches /*}:updateEmbedContentBatch
PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch
Parameter jalur
embedContentBatch.name
string
Hanya output. ID. Nama resource batch.
Format: batches/{batchId}. Formatnya adalah batches/{batches}.
Parameter kueri
updateMask
string (FieldMask format)
Opsional. Daftar kolom yang akan diperbarui.
Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".
Isi permintaan
Isi permintaan memuat instance EmbedContentBatch.
model
string
Wajib. Nama Model yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}.
displayName
string
Wajib. Nama batch yang ditentukan pengguna.
inputConfig
object (InputEmbedContentConfig)
Wajib. Konfigurasi input instance tempat pemrosesan batch dilakukan.
priority
string (int64 format)
Opsional. Prioritas batch. Batch dengan nilai prioritas yang lebih tinggi akan diproses sebelum batch dengan nilai prioritas yang lebih rendah. Nilai negatif diizinkan. Defaultnya adalah 0.
Isi respons
Jika berhasil, isi respons memuat instance EmbedContentBatch.
EmbedContentRequest
Permintaan yang berisi Content untuk model yang akan disematkan.
model
string
Wajib. Nama resource model. Ini berfungsi sebagai ID yang akan digunakan Model.
Nama ini harus cocok dengan nama model yang ditampilkan oleh metode ListModels.
Format: models/{model}
content
object (Content)
Wajib. Konten yang akan disematkan. Hanya kolom parts.text yang akan dihitung.
taskType
enum (TaskType)
Opsional. Jenis tugas opsional yang akan menggunakan embedding. Tidak didukung di model sebelumnya (models/embedding-001).
title
string
Opsional. Judul opsional untuk teks. Hanya berlaku jika TaskType adalah RETRIEVAL_DOCUMENT.
Catatan: Menentukan title untuk RETRIEVAL_DOCUMENT memberikan embedding berkualitas lebih baik untuk pengambilan.
outputDimensionality
integer
Opsional. Dimensi yang dikurangi opsional untuk penyematan output. Jika ditetapkan, nilai berlebihan dalam penyematan output akan dipangkas dari akhir. Hanya didukung oleh model yang lebih baru sejak tahun 2024. Anda tidak dapat menetapkan nilai ini jika menggunakan model sebelumnya (models/embedding-001).
Metode: batches.updateGenerateContentBatch
- Endpoint
- Parameter jalur
- Parameter kueri
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- GenerateContentRequest
Memperbarui batch permintaan GenerateContent untuk batch processing.
Endpoint
patchhttps: / /generativelanguage.googleapis.com /v1beta /{generateContentBatch.name=batches /*}:updateGenerateContentBatch
PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch
Parameter jalur
generateContentBatch.name
string
Hanya output. ID. Nama resource batch.
Format: batches/{batchId}. Formatnya adalah batches/{batches}.
Parameter kueri
updateMask
string (FieldMask format)
Opsional. Daftar kolom yang akan diperbarui.
Ini adalah comma-separated list berisi nama kolom yang sepenuhnya memenuhi syarat. Contoh: "user.displayName,photo".
Isi permintaan
Isi permintaan memuat instance GenerateContentBatch.
model
string
Wajib. Nama Model yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}.
displayName
string
Wajib. Nama batch yang ditentukan pengguna.
inputConfig
object (InputConfig)
Wajib. Konfigurasi input instance tempat pemrosesan batch dilakukan.
priority
string (int64 format)
Opsional. Prioritas batch. Batch dengan nilai prioritas yang lebih tinggi akan diproses sebelum batch dengan nilai prioritas yang lebih rendah. Nilai negatif diizinkan. Defaultnya adalah 0.
Isi respons
Jika berhasil, isi respons memuat instance GenerateContentBatch.
GenerateContentRequest
Permintaan untuk membuat penyelesaian dari model.
model
string
Wajib. Nama Model yang akan digunakan untuk membuat penyelesaian.
Format: models/{model}.
tools[]
object (Tool)
Opsional. Daftar Tools yang dapat digunakan Model untuk membuat respons berikutnya.
Tool adalah bagian kode yang memungkinkan sistem berinteraksi dengan sistem eksternal untuk melakukan tindakan, atau serangkaian tindakan, di luar pengetahuan dan cakupan Model. Tool yang didukung adalah Function dan codeExecution. Lihat panduan Panggilan fungsi dan Eksekusi kode untuk mempelajari lebih lanjut.
toolConfig
object (ToolConfig)
Opsional. Konfigurasi alat untuk Tool yang ditentukan dalam permintaan. Lihat Panduan panggilan fungsi untuk contoh penggunaan.
safetySettings[]
object (SafetySetting)
Opsional. Daftar instance SafetySetting unik untuk memblokir konten tidak aman.
Kebijakan ini akan diterapkan pada GenerateContentRequest.contents dan GenerateContentResponse.candidates. Tidak boleh ada lebih dari satu setelan untuk setiap jenis SafetyCategory. API akan memblokir konten dan respons apa pun yang tidak memenuhi nilai minimum yang ditetapkan oleh setelan ini. Daftar ini menggantikan setelan default untuk setiap SafetyCategory yang ditentukan dalam safetySettings. Jika tidak ada SafetySetting untuk SafetyCategory tertentu yang diberikan dalam daftar, API akan menggunakan setelan keamanan default untuk kategori tersebut. Kategori bahaya HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY didukung. Lihat panduan untuk mengetahui informasi mendetail tentang setelan keamanan yang tersedia. Lihat juga Panduan keselamatan untuk mempelajari cara memasukkan pertimbangan keselamatan dalam aplikasi AI Anda.
systemInstruction
object (Content)
Opsional. Developer menetapkan petunjuk sistem. Saat ini, hanya teks.
generationConfig
object (GenerationConfig)
Opsional. Opsi konfigurasi untuk pembuatan dan output model.
cachedContent
string
Opsional. Nama konten yang di-cache untuk digunakan sebagai konteks dalam menyajikan prediksi. Format: cachedContents/{cachedContent}
| Representasi JSON |
|---|
{ "model": string, "contents": [ { object ( |
BatchState
Status batch.
| Enum | |
|---|---|
BATCH_STATE_UNSPECIFIED |
Status batch tidak ditentukan. |
BATCH_STATE_PENDING |
Layanan sedang bersiap untuk menjalankan batch. |
BATCH_STATE_RUNNING |
Batch sedang dalam proses. |
BATCH_STATE_SUCCEEDED |
Batch berhasil diselesaikan. |
BATCH_STATE_FAILED |
Batch gagal. |
BATCH_STATE_CANCELLED |
Batch telah dibatalkan. |
BATCH_STATE_EXPIRED |
Masa berlaku batch telah berakhir. |
REST Resource: batch
Resource: Operation
Resource ini mewakili operasi yang berjalan lama yang merupakan hasil dari panggilan API jaringan.
name
string
Nama server yang ditetapkan, yang hanya bersifat unik dalam layanan yang sama yang awalnya menampilkannya. Jika Anda menggunakan pemetaan HTTP default, name harus berupa nama resource yang diakhiri dengan operations/{unique_id}.
metadata
object
Metadata spesifik per layanan yang terkait dengan operasi. Metadata ini biasanya berisi informasi progres dan metadata umum, seperti waktu pembuatan. Beberapa layanan mungkin tidak menyediakan metadata semacam itu. Setiap metode yang menampilkan operasi yang berjalan lama harus mendokumentasikan jenis metadatanya, jika ada.
Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.
done
boolean
Jika nilainya adalah false, itu berarti operasi masih berlangsung. Jika true, operasi sudah selesai, dan error atau response tersedia.
result
Union type
error atau response yang valid. Jika done == false, error atau response tidak ditetapkan. Jika done == true, hanya salah satu dari error atau response yang dapat ditetapkan. Beberapa layanan mungkin tidak memberikan hasil. result hanya dapat berupa salah satu dari hal berikut:error
object (Status)
Hasil error operasi jika terjadi kegagalan atau pembatalan.
response
object
Respons normal dan berhasil dari operasi. Jika metode asli tidak menampilkan data saat berhasil, seperti Delete, responsnya adalah google.protobuf.Empty. Jika metode asli adalah Get/Create/Update standar, responsnya harus berupa resource. Untuk metode lain, respons harus memiliki jenis XxxResponse, dengan Xxx yang merupakan nama metode asli. Misalnya, jika nama metode asli adalah TakeSnapshot(), jenis respons yang disimpulkan adalah TakeSnapshotResponse.
Objek yang berisi kolom tipe arbitrer. Kolom tambahan "@type" berisi URI yang mengidentifikasi jenis arbitrer. Contoh: { "id": 1234, "@type": "types.example.com/standard/id" }.
| Representasi JSON |
|---|
{
"name": string,
"metadata": {
"@type": string,
field1: ...,
...
},
"done": boolean,
// result
"error": {
object ( |