Batch Mode

Gemini API, tek bir çağrıda birden fazla isteği işlemenize olanak tanıyan toplu işlem modunu destekler. Daha fazla ayrıntı için Toplu mod kılavuzu'na bakın.

Yöntem: models.batchGenerateContent

Toplu işleme için bir grup models.generateContent isteğini 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 öğesinin adı.

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

İstek içeriği

İ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/{batch_id}.

batch.displayName string

Zorunlu. Bu toplu işlemin kullanıcı tanımlı 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 çıkışı.

batch.createTime string (Timestamp format)

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

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanı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şleme işleminin tamamlandığı zaman.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanı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üncellenme zamanı.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanı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ış. Toplu işlemin durumu.

batch.priority string (int64 format)

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

Yanıt gövdesi

Başarılıysa yanıt metni, Operation öğ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 öğesinin 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. Chat gibi çok turlu sorgular için bu, sohbet geçmişini ve son isteği içeren yinelenen bir alandır.

tools[] object (Tool)

İsteğe bağlıdır. Bir sonraki yanıtı oluşturmak için Tools kullanılabilecek 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. İstek içinde belirtilen herhangi bir Tool için araç yapılandırması. Kullanım örneği için İşlev çağırma kılavuzuna 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 kısıtlama GenerateContentRequest.contents ve GenerateContentResponse.candidates üzerinde uygulanacak. 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 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 zarar kategorileri desteklenir. Kullanılabilir güvenlik ayarları hakkında ayrıntılı bilgi için kılavuza bakın. Ayrıca, yapay zeka uygulamalarınıza güvenlikle ilgili hususları nasıl dahil edeceğinizi öğrenmek için Güvenlik rehberine de göz atın.

systemInstruction object (Content)

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

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}

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

GenerateContentBatch

Bir grup GenerateContent isteğini temsil eden kaynak.

Alanlar
model string

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

Biçim: models/{model}.

name string

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

Biçim: batches/{batch_id}.

displayName string

Zorunlu. Bu toplu işlemin kullanıcı tanımlı 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 çıkışı.

createTime string (Timestamp format)

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

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanı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şleme işleminin tamamlandığı zaman.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanı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üncellenme zamanı.

Oluşturulan çıkışın her zaman Z ile normalleştirildiği ve 0, 3, 6 veya 9 kesirli basamak kullandığı RFC 3339'u kullanı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ış. Toplu işlemin durumu.

priority string (int64 format)

İsteğe bağlıdır. Toplu işlemin önceliği. Daha yüksek öncelik değerine sahip toplu işlemler, daha düşük öncelik değerine 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ğı. source aşağıdakilerden yalnızca biri olabilir:
fileName string

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

requests object (InlinedRequests)

Toplu işlemde işlenecek istekler.

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, BatchGenerateContentResponse veya GenerateContentBatch.output alanında döndürülür.

Alanlar
output Union type
Toplu isteğin çıkışı. output aşağıdakilerden yalnızca biri olabilir:
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şteki 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.

JSON gösterimi 
{

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

InlinedResponses

Toplu işteki isteklere verilen yanıtlar.

Alanlar
inlinedResponses[] object (InlinedResponse)

Yalnızca çıkış. Toplu işteki 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ı. output aşağıdakilerden yalnızca biri olabilir:
error object (Status)

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

response object (GenerateContentResponse)

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

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ış. Toplu işlemdeki 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 istek sayısı.

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

BatchState

Grubun durumu.

Sıralamalar
BATCH_STATE_UNSPECIFIED Toplu işlem durumu belirtilmemiş.
BATCH_STATE_PENDING Hizmet, toplu işlemi ç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.

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. result aşağıdakilerden yalnızca biri olabilir:
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" }.

JSON gösterimi 
{
  "name": string,
  "metadata": {
    "@type": string,
    field1: ...,
    ...
  },
  "done": boolean,

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

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ü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 sayfa boyutu.

pageToken string

Standart liste sayfası jetonu.

İstek içeriği

İ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ü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 veya başka yöntemler kullanabilir. Başarılı iptal işleminden sonra işlem silinmez. Bunun yerine, Operation.error değeri google.rpc.Status.code olan ve Code.CANCELLED ile eşleşen bir 1 işlemine dönüşür.

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 gövdesi

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ü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 gövdesi

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