Batch API

Gemini API, tek bir çağrıda birden fazla isteği işlemenize olanak tanıyan toplu API'leri destekler. Daha fazla bilgi için Toplu API kılavuzu başlıklı makaleyi inceleyin.

Yöntem: models.batchGenerateContent

Toplu işleme için models.generateContent isteklerinden oluşan bir grubu sıraya alır.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:batchGenerateContent

Yol parametreleri

batch.model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model'nın adı.

Biçim: models/{model}. models/{model} biçimindedir.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
batch.name string

Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.

Biçim: batches/{batchId}.

batch.displayName string

Zorunlu. Bu toplu işlemin kullanıcı tarafından tanımlanan adı.

batch.inputConfig object (InputConfig)

Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.

batch.output object (GenerateContentBatchOutput)

Yalnızca çıkış. Toplu isteğin çıktısı.

batch.createTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemin oluşturulduğu zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemenin tamamlandığı zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemin son güncellendiği zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batch.batchStats object (BatchStats)

Yalnızca çıkış. Toplu işlemle ilgili istatistikler.

batch.state enum (BatchState)

Yalnızca çıkış. Grubun durumu.

batch.priority string (int64 format)

İsteğe bağlıdır. Toplu işlemin önceliği. Daha yüksek öncelikli değere sahip toplu işlemler, daha düşük öncelikli değere sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.

batch.webhookConfig.uris[] string

İsteğe bağlıdır. Ayarlanırsa bu webhook URI'leri, kayıtlı webhook'lar yerine webhook etkinlikleri için kullanılır.

Yanıt metni

Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.

Yöntem: models.asyncBatchEmbedContent

Toplu işleme için models.embedContent isteklerinden oluşan bir grubu sıraya alır. GenerativeService içinde models.batchEmbedContents işleyicimiz var, ancak senkronize edildi. Bu nedenle, karışıklığı önlemek için bu alanı Async olarak adlandırıyoruz.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{batch.model=models/*}:asyncBatchEmbedContent

Yol parametreleri

batch.model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model'nın adı.

Biçim: models/{model}. models/{model} biçimindedir.

İstek metni

İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:

Alanlar
batch.name string

Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.

Biçim: batches/{batchId}.

batch.displayName string

Zorunlu. Bu toplu işlemin kullanıcı tarafından tanımlanan adı.

batch.inputConfig object (InputEmbedContentConfig)

Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.

batch.output object (EmbedContentBatchOutput)

Yalnızca çıkış. Toplu isteğin çıktısı.

batch.createTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemin oluşturulduğu zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batch.endTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemenin tamamlandığı zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batch.updateTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemin son güncellendiği zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batch.batchStats object (EmbedContentBatchStats)

Yalnızca çıkış. Toplu işlemle ilgili istatistikler.

batch.state enum (BatchState)

Yalnızca çıkış. Grubun durumu.

batch.priority string (int64 format)

İsteğe bağlıdır. Toplu işlemin önceliği. Daha yüksek öncelikli değere sahip toplu işlemler, daha düşük öncelikli değere sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.

batch.webhookConfig.uris[] string

İsteğe bağlıdır. Ayarlanırsa bu webhook URI'leri, kayıtlı webhook'lar yerine webhook etkinlikleri için kullanılır.

Yanıt metni

Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.

Yöntem: batches.get

Uzun süreli bir işlemin en son durumunu bildirir. İstemciler bu yöntemi kullanarak API hizmetinin önerdiği aralıklarla işlem sonucunu sorgulayabilir.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Yol parametreleri

name string

İşlem kaynağının adı. batches/{batches} biçimindedir.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, Operation öğesinin bir örneğini içerir.

Yöntem: batches.list

İstekte belirtilen filtreyle eşleşen işlemleri listeler. Sunucu bu yöntemi desteklemiyorsa UNIMPLEMENTED döndürülür.

Uç nokta

get https://generativelanguage.googleapis.com/v1beta/{name=batches}

Yol parametreleri

name string

İşlemin üst kaynağının adı. batches biçimindedir.

Sorgu parametreleri

filter string

Standart liste filtresi.

pageSize integer

Standart liste sayfası boyutu.

pageToken string

Standart liste sayfası jetonu.

returnPartialSuccess boolean

true olarak ayarlandığında, erişilebilir işlemler normal şekilde döndürülür ve erişilemeyen işlemler ListOperationsResponse.unreachable alanında döndürülür.

Bu durum yalnızca koleksiyonlar arasında okuma yaparken true olabilir. Örneğin, parent değeri "projects/example/locations/-" olarak ayarlandığında.

Bu alan varsayılan olarak desteklenmez ve hizmete veya ürüne özel dokümanlarda açıkça belirtilmediği sürece ayarlanırsa UNIMPLEMENTED hatasına neden olur.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Başarılıysa yanıt metni, ListOperationsResponse öğesinin bir örneğini içerir.

Yöntem: batches.cancel

Uzun süren bir işlemde eşzamansız iptal başlatır. Sunucu, işlemi iptal etmek için elinden geleni yapar ancak başarı garanti edilmez. Sunucu bu yöntemi desteklemiyorsa google.rpc.Code.UNIMPLEMENTED döndürülür. İstemciler, iptalin başarılı olup olmadığını veya iptale rağmen işlemin tamamlanıp tamamlanmadığını kontrol etmek için Operations.GetOperation ya da başka yöntemler kullanabilir. Başarılı bir iptal işleminden sonra işlem silinmez. Bunun yerine, Operation.error değeri Code.CANCELLED'e karşılık gelen 1 olan bir google.rpc.Status.code ile değiştirilir.

Uç nokta

post https://generativelanguage.googleapis.com/v1beta/{name=batches/*}:cancel

Yol parametreleri

name string

İptal edilecek işlem kaynağının adı. batches/{batches} biçimindedir.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Başarılı olursa yanıt gövdesi boş bir JSON nesnesi olur.

Yöntem: batches.delete

Uzun süreli bir işlemi siler. Bu yöntem, istemcinin artık işlem sonucuyla ilgilenmediğini gösterir. İşlem iptal edilmez. Sunucu bu yöntemi desteklemiyorsa google.rpc.Code.UNIMPLEMENTED döndürülür.

Uç nokta

delete https://generativelanguage.googleapis.com/v1beta/{name=batches/*}

Yol parametreleri

name string

Silinecek işlem kaynağının adı. batches/{batches} biçimindedir.

İstek metni

İstek metni boş olmalıdır.

Yanıt metni

Başarılı olursa yanıt gövdesi boş bir JSON nesnesi olur.

Yöntem: batches.updateGenerateContentBatch

Toplu işleme için bir grup GenerateContent isteğini günceller.

Uç nokta

patch https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{generateContentBatch.name=batches/*}:updateGenerateContentBatch

Yol parametreleri

generateContentBatch.name string

Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.

Biçim: batches/{batchId}. batches/{batches} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

İsteğe bağlıdır. Güncellenecek alanların listesi.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış listesidir. Örnek: "user.displayName,photo".

İstek metni

İstek metni, GenerateContentBatch öğesinin bir örneğini içerir.

Alanlar
model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model öğesinin adı.

Biçim: models/{model}.

displayName string

Zorunlu. Bu toplu işlemin kullanıcı tarafından tanımlanan adı.

inputConfig object (InputConfig)

Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.

priority string (int64 format)

İsteğe bağlıdır. Toplu işlemin önceliği. Daha yüksek öncelikli değere sahip toplu işlemler, daha düşük öncelikli değere sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.

Yanıt metni

Başarılıysa yanıt metni, GenerateContentBatch öğesinin bir örneğini içerir.

GenerateContentRequest

Modelden tamamlama oluşturma isteği.

Alanlar
model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model'nın adı.

Biçim: models/{model}.

contents[] object (Content)

Zorunlu. Modelle yapılan mevcut görüşmenin içeriği.

Tek dönüşlü sorgular için bu tek bir örnektir. Sohbet gibi çok turlu sorgular için bu, sohbet geçmişini ve son isteği içeren tekrarlanan bir alandır.

tools[] object (Tool)

İsteğe bağlıdır. Tools, bir sonraki yanıtı oluşturmak için kullanabileceği Model listesi.

Tool, sistemin Model'nin bilgisi ve kapsamı dışında bir işlem veya işlemler dizisi gerçekleştirmek için harici sistemlerle etkileşime girmesini sağlayan bir kod parçasıdır. Desteklenen Tool'ler Function ve codeExecution'dir. Daha fazla bilgi için İşlev çağırma ve Kod yürütme kılavuzlarına bakın.

toolConfig object (ToolConfig)

İsteğe bağlıdır. İstekte belirtilen tüm Tool için araç yapılandırması. Kullanım örneği için İşlev çağırma rehberine bakın.

safetySettings[] object (SafetySetting)

İsteğe bağlıdır. Güvenli olmayan içeriğin engellenmesi için benzersiz SafetySetting örneklerinin listesi.

Bu değişiklik, GenerateContentRequest.contents ve GenerateContentResponse.candidates tarihinde zorunlu kılınacak. Her SafetyCategory türü için birden fazla ayar olmamalıdır. API, bu ayarlarda belirlenen eşikleri karşılamayan tüm içerikleri ve yanıtları engeller. Bu liste, safetySettings içinde belirtilen her SafetyCategory için varsayılan ayarları geçersiz kılar. Listede sağlanan belirli bir SafetyCategory için SafetySetting yoksa API, bu kategori için varsayılan güvenlik ayarını kullanır. HARM_CATEGORY_HATE_SPEECH, HARM_CATEGORY_SEXUALLY_EXPLICIT, HARM_CATEGORY_DANGEROUS_CONTENT, HARM_CATEGORY_HARASSMENT, HARM_CATEGORY_CIVIC_INTEGRITY, HARM_CATEGORY_JAILBREAK zarar kategorileri desteklenir. Kullanılabilen güvenlik ayarları hakkında ayrıntılı bilgi için kılavuza bakın. Ayrıca, yapay zeka uygulamalarınıza güvenlik unsurlarını nasıl dahil edeceğinizi öğrenmek için Güvenlik rehberine de göz atın.

labels map (key: string, value: string)

İsteğe bağlıdır. İstek için kullanıcı tanımlı meta verileri içeren etiketler.

İsteğe bağlıdır. Etiketler, standart birleştirilmiş Cloud etiketleme şartlarına uymalıdır: - Etiket anahtarları bir harfle başlamalıdır. - Etiket anahtarları ve değerleri 63 karakterden (Unicode kod noktaları) uzun olamaz ve yalnızca küçük harf, sayısal karakter, alt çizgi ve kısa çizgi içerebilir. - Uluslararası karakterlere izin verilir.

Kullanım: - Toplayıcılardan alınan güvenlik tanımlayıcıları: safety_identifier anahtarını kullanın (ör.{"safety_identifier": "user_session_123"}).

"key": value çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

systemInstruction object (Content)

İsteğe bağlıdır. Geliştirici tarafından belirlenen sistem talimatları. Şu anda yalnızca metin desteklenmektedir.

generationConfig object (GenerationConfig)

İsteğe bağlıdır. Model oluşturma ve çıkışlarla ilgili yapılandırma seçenekleri.

cachedContent string

İsteğe bağlıdır. Tahmini sunmak için bağlam olarak kullanılacak önbelleğe alınan içeriğin adı. Biçim: cachedContents/{cachedContent}

serviceTier enum (ServiceTier)

İsteğe bağlıdır. İsteğin hizmet katmanı.

store boolean

İsteğe bağlıdır. Belirli bir istek için günlük kaydı davranışını yapılandırır. Ayarlanırsa proje düzeyindeki günlük yapılandırmasına göre öncelikli olur.

JSON gösterimi 
{
  "model": string,
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "toolConfig": {
    object (ToolConfig)
  },
  "safetySettings": [
    {
      object (SafetySetting)
    }
  ],
  "labels": {
    string: string,
    ...
  },
  "systemInstruction": {
    object (Content)
  },
  "generationConfig": {
    object (GenerationConfig)
  },
  "cachedContent": string,
  "serviceTier": enum (ServiceTier),
  "store": boolean
}

Yöntem: batches.updateEmbedContentBatch

Toplu işleme için bir grup EmbedContent isteğini günceller.

Uç nokta

patch https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

PATCH https://generativelanguage.googleapis.com/v1beta/{embedContentBatch.name=batches/*}:updateEmbedContentBatch

Yol parametreleri

embedContentBatch.name string

Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.

Biçim: batches/{batchId}. batches/{batches} biçimindedir.

Sorgu parametreleri

updateMask string (FieldMask format)

İsteğe bağlıdır. Güncellenecek alanların listesi.

Bu, alanların tam nitelikli adlarının virgülle ayrılmış listesidir. Örnek: "user.displayName,photo".

İstek metni

İstek metni, EmbedContentBatch öğesinin bir örneğini içerir.

Alanlar
model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model öğesinin adı.

Biçim: models/{model}.

displayName string

Zorunlu. Bu toplu işlemin kullanıcı tarafından tanımlanan adı.

inputConfig object (InputEmbedContentConfig)

Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.

priority string (int64 format)

İsteğe bağlıdır. Toplu işlemin önceliği. Daha yüksek öncelikli değere sahip toplu işlemler, daha düşük öncelikli değere sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.

Yanıt metni

Başarılıysa yanıt metni, EmbedContentBatch öğesinin bir örneğini içerir.

EmbedContentRequest

Yerleştirilecek modelin Content değerini içeren istek.

Alanlar
model string

Zorunlu. Modelin kaynak adı. Bu, Model'in kullanacağı bir kimlik görevi görür.

Bu ad, ListModels yöntemi tarafından döndürülen bir model adıyla eşleşmelidir.

Biçim: models/{model}

content object (Content)

Zorunlu. Yerleştirilecek içerik. Yalnızca parts.text alanları sayılır.

taskType
(deprecated) enum (TaskType)

İsteğe bağlıdır. Desteği sonlandırıldı: Lütfen bunun yerine EmbedContentConfig.task_type kullanın. Gömme işlemlerinin kullanılacağı isteğe bağlı görev türü. Daha eski modellerde (models/embedding-001) desteklenmez.

title
(deprecated) string

İsteğe bağlıdır. Desteği sonlandırıldı: Lütfen bunun yerine EmbedContentConfig.title kullanın. Metin için isteğe bağlı bir başlık. Yalnızca TaskType RETRIEVAL_DOCUMENT olduğunda geçerlidir.

Not: title için RETRIEVAL_DOCUMENT belirtmek, alma işlemi için daha kaliteli yerleştirmeler sağlar.

outputDimensionality
(deprecated) integer

İsteğe bağlıdır. Desteği sonlandırıldı: Lütfen bunun yerine EmbedContentConfig.output_dimensionality kullanın. Çıkış yerleştirme için isteğe bağlı olarak azaltılmış boyut. Ayarlanırsa çıkış yerleştirmesindeki aşırı değerler sondan kesilir. Yalnızca 2024'ten itibaren çıkan yeni modellerde desteklenir. Daha önceki modeli (models/embedding-001) kullanıyorsanız bu değeri ayarlayamazsınız.

embedContentConfig object (EmbedContentConfig)

İsteğe bağlıdır. EmbedContent isteğinin yapılandırması.

JSON gösterimi 
{
  "model": string,
  "content": {
    object (Content)
  },
  "taskType": enum (TaskType),
  "title": string,
  "outputDimensionality": integer,
  "embedContentConfig": {
    object (EmbedContentConfig)
  }
}

REST Kaynağı: batches

Kaynak: İşlem

Bu kaynak, bir ağ API çağrısının sonucu olan uzun süreli bir işlemi temsil eder.

Alanlar
name string

Sunucu tarafından atanan ad. Yalnızca bu adı ilk kez sağlayan hizmet kapsamında benzersizdir. Varsayılan HTTP eşlemesini kullanıyorsanız name değeri, operations/{unique_id} ile biten bir kaynak adı olmalıdır.

metadata object

İşlemle ilişkilendirilen, hizmete özgü meta veriler. Genellikle ilerleme bilgilerini ve oluşturma zamanı gibi ortak meta verileri içerir. Bazı hizmetler bu tür meta verileri sağlamayabilir. Uzun süreli bir işlemi döndüren tüm yöntemler, varsa meta veri türünü belirtmelidir.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

done boolean

Değer false olması işlemin devam ettiği anlamına gelir. Değer true olduğunda işlem tamamlanmış olup error veya response kullanılabilir.

result Union type
İşlem sonucu. error veya geçerli bir response olabilir. done == false ise error öğesi de response öğesi de ayarlanmaz. done == true ise error veya response öğelerinden yalnızca biri ayarlanabilir. Bazı hizmetler sonuç vermeyebilir. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
error object (Status)

İşlem başarısız olduğunda veya iptal edildiğinde sistemin verdiği hata bilgisi.

response object

İşlem başarılı olduğunda sistemin verdiği normal yanıt. Orijinal yöntem başarılı olduğunda veri döndürmüyorsa (ör. Delete) yanıt google.protobuf.Empty olur. Orijinal yöntem standart Get/Create/Update ise yanıt kaynak olmalıdır. Diğer yöntemler için yanıtın türü XxxResponse olmalıdır. Burada Xxx, orijinal yöntem adıdır. Örneğin, orijinal yöntem adı TakeSnapshot() ise tahmin edilen yanıt türü TakeSnapshotResponse olur.

Herhangi türde alanlar içeren bir nesne. Ek bir "@type" alanı, türü tanımlayan bir URI içerir. Örnek: { "id": 1234, "@type": "types.example.com/standard/id" }.

Karşılıklı olarak hariç tutulan alanların sonu.
JSON gösterimi 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

  // result
  "error": {
    object (Status)
  },
  "response": {
    "@type": string,
    field1: ...,
    ...
  }
  // Union type
}

GenerateContentBatch

Bir grup GenerateContent isteğini temsil eden kaynak.

Alanlar
model string

Zorunlu. Tamamlama oluşturmak için kullanılacak Model'nın adı.

Biçim: models/{model}.

name string

Yalnızca çıkış. Tanımlayıcı. Toplu işlemin kaynak adı.

Biçim: batches/{batchId}.

displayName string

Zorunlu. Bu toplu işlemin kullanıcı tarafından tanımlanan adı.

inputConfig object (InputConfig)

Zorunlu. Toplu işleme işlemlerinin gerçekleştirildiği örneklerin giriş yapılandırması.

output object (GenerateContentBatchOutput)

Yalnızca çıkış. Toplu isteğin çıktısı.

createTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemin oluşturulduğu zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

endTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemenin tamamlandığı zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

updateTime string (Timestamp format)

Yalnızca çıkış. Toplu işlemin son güncellendiği zaman.

Zaman damgasında RFC 3339 kullanılır. Yani oluşturulan çıkış her zaman Z ile normalleştirilir ve 0, 3, 6 veya 9 kesirli basamak kullanılır. "Z" dışındaki zaman farkları da kabul edilir. Örnekler: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" veya "2014-10-02T15:01:23+05:30".

batchStats object (BatchStats)

Yalnızca çıkış. Toplu işlemle ilgili istatistikler.

state enum (BatchState)

Yalnızca çıkış. Grubun durumu.

priority string (int64 format)

İsteğe bağlıdır. Toplu işlemin önceliği. Daha yüksek öncelikli değere sahip toplu işlemler, daha düşük öncelikli değere sahip toplu işlemlerden önce işlenir. Negatif değerlere izin verilir. Varsayılan değer 0'dır.

JSON gösterimi 
{
  "model": string,
  "name": string,
  "displayName": string,
  "inputConfig": {
    object (InputConfig)
  },
  "output": {
    object (GenerateContentBatchOutput)
  },
  "createTime": string,
  "endTime": string,
  "updateTime": string,
  "batchStats": {
    object (BatchStats)
  },
  "state": enum (BatchState),
  "priority": string
}

InputConfig

Toplu istek için girişi yapılandırır.

Alanlar
source Union type
Zorunlu. Girişin kaynağı. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
fileName string

Giriş isteklerini içeren File öğesinin adı.

requests object (InlinedRequests)

Toplu işlemde işlenecek istekler.

Karşılıklı olarak hariç tutulan alanların sonu.
JSON gösterimi 
{

  // source
  "fileName": string,
  "requests": {
    object (InlinedRequests)
  }
  // Union type
}

InlinedRequests

Toplu oluşturma isteğinin bir parçası olarak sağlanırsa toplu işlemde işlenecek istekler.

Alanlar
requests[] object (InlinedRequest)

Zorunlu. Toplu işlemde işlenecek istekler.

JSON gösterimi 
{
  "requests": [
    {
      object (InlinedRequest)
    }
  ]
}

InlinedRequest

Toplu işlemde işlenecek istek.

Alanlar
request object (GenerateContentRequest)

Zorunlu. Toplu işlemde işlenecek istek.

metadata object (Struct format)

İsteğe bağlıdır. İstekle ilişkilendirilecek meta veriler.

JSON gösterimi 
{
  "request": {
    object (GenerateContentRequest)
  },
  "metadata": {
    object
  }
}

GenerateContentBatchOutput

Toplu isteğin çıktısı. Bu değer, BatchGenerateContentResponse veya GenerateContentBatch.output alanında döndürülür.

Alanlar
output Union type
Toplu isteğin çıktısı. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
responsesFile string

Yalnızca çıkış. Yanıtları içeren dosyanın dosya kimliği. Dosya, her satırda tek bir yanıt içeren bir JSONL dosyası olur. Yanıtlar, JSON olarak biçimlendirilmiş GenerateContentResponse mesajlarıdır. Yanıtlar, giriş istekleriyle aynı sırada yazılır.

inlinedResponses object (InlinedResponses)

Yalnızca çıkış. Toplu işlemdeki isteklere verilen yanıtlar. Toplu işlem, satır içi istekler kullanılarak oluşturulduğunda döndürülür. Yanıtlar, giriş istekleriyle aynı sırada yer alır.

Karşılıklı olarak hariç tutulan alanların sonu.
JSON gösterimi 
{

  // output
  "responsesFile": string,
  "inlinedResponses": {
    object (InlinedResponses)
  }
  // Union type
}

InlinedResponses

Toplu işlemdeki isteklere verilen yanıtlar.

Alanlar
inlinedResponses[] object (InlinedResponse)

Yalnızca çıkış. Toplu işlemdeki isteklere verilen yanıtlar.

JSON gösterimi 
{
  "inlinedResponses": [
    {
      object (InlinedResponse)
    }
  ]
}

InlinedResponse

Toplu işlemdeki tek bir isteğe verilen yanıt.

Alanlar
metadata object (Struct format)

Yalnızca çıkış. İstekle ilişkili meta veriler.

output Union type
İsteğin çıktısı. Aşağıda, aynı anda kullanılamayan alanların listesi verilmiştir. Yanıt içinde en fazla bir alan ayarlanır:
error object (Status)

Yalnızca çıkış. İstek işlenirken karşılaşılan hata.

response object (GenerateContentResponse)

Yalnızca çıkış. İsteğe verilen yanıt.

Karşılıklı olarak hariç tutulan alanların sonu.
JSON gösterimi 
{
  "metadata": {
    object
  },

  // output
  "error": {
    object (Status)
  },
  "response": {
    object (GenerateContentResponse)
  }
  // Union type
}

BatchStats

Toplu işlemle ilgili istatistikler.

Alanlar
requestCount string (int64 format)

Yalnızca çıkış. Topludaki istek sayısı.

successfulRequestCount string (int64 format)

Yalnızca çıkış. Başarıyla işlenen istek sayısı.

failedRequestCount string (int64 format)

Yalnızca çıkış. İşlenemeyen isteklerin sayısı.

pendingRequestCount string (int64 format)

Yalnızca çıkış. Hâlâ işlenmeyi bekleyen isteklerin sayısı.

JSON gösterimi 
{
  "requestCount": string,
  "successfulRequestCount": string,
  "failedRequestCount": string,
  "pendingRequestCount": string
}

BatchState

Grubun durumu.

Sıralamalar
BATCH_STATE_UNSPECIFIED Toplu iş durumu belirtilmemiş.
BATCH_STATE_PENDING Hizmet, grubu çalıştırmaya hazırlanıyor.
BATCH_STATE_RUNNING Toplu işlem devam ediyor.
BATCH_STATE_SUCCEEDED Toplu işlem başarıyla tamamlandı.
BATCH_STATE_FAILED Toplu işlem başarısız oldu.
BATCH_STATE_CANCELLED Toplu işlem iptal edildi.
BATCH_STATE_EXPIRED Toplu işlemin süresi doldu.

ServiceTier

İsteğin hizmet katmanı.

Sıralamalar
unspecified Varsayılan hizmet katmanı (standart).
standard Standart hizmet katmanı.
flex Flex hizmet katmanı.
priority Öncelikli hizmet katmanı.