REST Resource: cachedContents

Kaynak: CachedContent

Ön işlenmiş ve GenerativeService'e sonraki isteklerde kullanılabilecek içerik.

Önbelleğe alınan içerik yalnızca oluşturulduğu modelle kullanılabilir.

JSON gösterimi 
{
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "usageMetadata": {
    object (UsageMetadata)
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
  "name": string,
  "displayName": string,
  "model": string,
  "systemInstruction": {
    object (Content)
  },
  "toolConfig": {
    object (ToolConfig)
  }
}
Alanlar
contents[]

object (Content)

İsteğe bağlı. Yalnızca giriş. Sabit. Önbelleğe alınacak içerik.
tools[]

object (Tool)

İsteğe bağlı. Yalnızca giriş. Sabit. Modelin bir sonraki yanıtı oluşturmak için kullanabileceği Tools listesi
createTime

string (Timestamp format)

Yalnızca çıkış. Önbellek girişinin oluşturulma zamanı.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Yalnızca çıkış. Önbellek girişinin en son UTC saatiyle güncellendiği zaman.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
usageMetadata

object (UsageMetadata)

Yalnızca çıkış. Önbelleğe alınan içeriğin kullanımına ilişkin meta veriler.
Birleştirme alanı expiration. Bu kaynağın süresinin ne zaman sona ereceğini belirtir. expiration şunlardan yalnızca biri olabilir:
expireTime

string (Timestamp format)

Bu kaynağın süresinin dolmuş olarak kabul edildiği UTC zaman damgası. Bu, girişte ne gönderildiğine bakılmaksızın her zaman çıkışta sağlanır.

RFC3339 UTC "Zulu" biçiminde, nanosaniye çözünürlüğüne ve en fazla dokuz kesirli basamağa sahip bir zaman damgası. Örnekler: "2014-10-02T15:01:23Z" ve "2014-10-02T15:01:23.045123456Z".
ttl

string (Duration format)

Yalnızca giriş. Bu kaynak için yeni TTL (yalnızca giriş).

"s" ile biten, en fazla dokuz kesir basamağı içeren, saniye cinsinden süre. Örnek: "3.5s".
name

string

İsteğe bağlı. Tanımlayıcı. Önbelleğe alınan içeriğe işaret eden kaynak adı. Biçim: cachedContents/{id}
displayName

string

İsteğe bağlı. Sabit. Önbelleğe alınan içeriğin kullanıcı tarafından oluşturulan anlamlı görünen adı. En fazla 128 Unicode karakteri.
model

string

Zorunlu. Sabit. Önbelleğe alınmış içerik için kullanılacak Model adı Biçim: models/{model}
systemInstruction

object (Content)

İsteğe bağlı. Yalnızca giriş. Sabit. Geliştiricinin sistem talimatını ayarladı. Şu anda yalnızca metin olarak kullanılabilir.
toolConfig

object (ToolConfig)

İsteğe bağlı. Yalnızca giriş. Sabit. Araç yapılandırması. Bu yapılandırma tüm araçlar için paylaşılır.

İçerik

Bir mesajın çok parçalı içeriğini barındıran temel yapılandırılmış veri türü.

Content, Content öğesinin yapımcısını belirten bir role alanı ve mesaj dönüşünün içeriğini barındıran çok parçalı verilerin bulunduğu bir parts alanı içerir.

JSON gösterimi 
{
  "parts": [
    {
      object (Part)
    }
  ],
  "role": string
}
Alanlar
parts[]

object (Part)

Tek bir mesaj oluşturan Parts sipariş edildi. Bölümlerin farklı MIME türleri olabilir.
role

string

İsteğe bağlı. İçeriğin yapımcısı. "user" (kullanıcı) veya "model" (model) değeri olmalıdır.

Çok dönüşlü ileti dizilerinde ayarlamak için yararlıdır. Aksi takdirde boş bırakılabilir veya ayarlanmamış olabilir.

Parça

Çok parçalı Content mesajının parçası olan medyayı içeren bir veri türü.

Part, ilişkili bir veri türüne sahip verilerden oluşur. Part, Part.data alanında kabul edilen türlerden yalnızca birini içerebilir.

Part, inlineData alanı işlenmemiş baytlarla doldurulursa medyanın türünü ve alt türünü tanımlayan sabit bir IANA MIME türüne sahip olmalıdır.

JSON gösterimi 
{

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "functionCall": {
    object (FunctionCall)
  },
  "functionResponse": {
    object (FunctionResponse)
  },
  "fileData": {
    object (FileData)
  }
  // End of list of possible types for union field data.
}
Alanlar

Birleştirme alanı data.

data şunlardan yalnızca biri olabilir:
text

string

Satır içi metin.
inlineData

object (Blob)

Satır içi medya baytları.
functionCall

object (FunctionCall)

Bağımsız değişkenler ve bunların değerleriyle birlikte FunctionDeclaration.name öğesini temsil eden bir dizenin yer aldığı modelden, tahmin edilen bir FunctionCall döndürüldü.
functionResponse

object (FunctionResponse)

FunctionDeclaration.name öğesini temsil eden bir dize içeren FunctionCall ve işlevden alınan herhangi bir çıkışı içeren yapılandırılmış JSON nesnesinin sonuç çıktısı, modelin bağlamı olarak kullanılır.
fileData

object (FileData)

URI tabanlı veri.

Blob

Ham medya baytları.

Metin, ham bayt olarak gönderilmemelidir. "text" alanını kullanın.

JSON gösterimi 
{
  "mimeType": string,
  "data": string
}
Alanlar
mimeType

string

Kaynak verilerin IANA standart MIME türü. Örnekler: - image/png - resim/jpeg Desteklenmeyen bir MIME türü sağlanırsa bir hata döndürülür. Desteklenen türlerin tam listesi için Desteklenen dosya biçimleri başlıklı makaleyi inceleyin.
data

string (bytes format)

Medya biçimleri için ham baytlar.

base64 kodlu bir dize.

FunctionCall

Bağımsız değişkenler ve bunların değerleriyle birlikte FunctionDeclaration.name öğesini temsil eden bir dizenin yer aldığı modelden, tahmin edilen bir FunctionCall döndürüldü.

JSON gösterimi 
{
  "name": string,
  "args": {
    object
  }
}
Alanlar
name

string

Zorunlu. Çağrılacak işlevin adı. En fazla 63 karakter olacak şekilde, a-z, A-Z, 0-9 biçiminde olmalı veya alt çizgi ve tire içermelidir.
args

object (Struct format)

İsteğe bağlı. JSON nesnesi biçimindeki işlev parametreleri ve değerleri.

FunctionResponse

FunctionDeclaration.name öğesini temsil eden bir dizeyi ve işlevden alınan herhangi bir çıkışı içeren yapılandırılmış JSON nesnesini içeren FunctionCall sonuç çıkışı, modelin bağlamı olarak kullanılır. Bu, model tahminine dayalı olarak oluşturulan FunctionCall sonucunu içermelidir.

JSON gösterimi 
{
  "name": string,
  "response": {
    object
  }
}
Alanlar
name

string

Zorunlu. Çağrılacak işlevin adı. En fazla 63 karakter olacak şekilde, a-z, A-Z, 0-9 biçiminde olmalı veya alt çizgi ve tire içermelidir.
response

object (Struct format)

Zorunlu. JSON nesnesi biçiminde işlev yanıtı.

FileData

URI tabanlı veri.

JSON gösterimi 
{
  "mimeType": string,
  "fileUri": string
}
Alanlar
mimeType

string

İsteğe bağlı. Kaynak verilerin IANA standart MIME türü.
fileUri

string

Zorunlu. URI.

Araç

Modelin yanıt oluşturmak için kullanabileceği araç ayrıntıları.

Tool, modelin bilgisi ve kapsamı dışında bir işlem veya işlem kümesi gerçekleştirmek için sistemin harici sistemlerle etkileşime girmesini sağlayan bir kod parçasıdır.

JSON gösterimi 
{
  "functionDeclarations": [
    {
      object (FunctionDeclaration)
    }
  ]
}
Alanlar
functionDeclarations[]

object (FunctionDeclaration)

İsteğe bağlı. Modelde kullanılabilen ve işlev çağrısında kullanılabilecek FunctionDeclarations listesi.

Model veya sistem, işlevi yürütmez. Bunun yerine, tanımlanan işlev, yürütme için istemci tarafında bağımsız değişkenlerle birlikte bir [FunctionCall][content.part.function_call] olarak döndürülebilir. Model, yanıtta [FunctionCall][content.part.function_call] öğesini doldurarak bu işlevlerin bir alt kümesini çağırmaya karar verebilir. Bir sonraki ileti dizisi dönüşü, sonraki model dönüşü için [content.role] "function" oluşturma bağlamına sahip bir [FunctionResponse][content.part.function_response] içerebilir.

FunctionDeclaration

OpenAPI 3.03 spesifikasyonu ile tanımlanan şekilde bir işlev bildiriminin yapılandırılmış gösterimi. Bu bildirime işlev adı ve parametreler de dahildir. Bu FunctionDeclaration, model tarafından Tool olarak kullanılabilen ve istemci tarafından yürütülen bir kod bloğunu temsil eder.

JSON gösterimi 
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  }
}
Alanlar
name

string

Zorunlu. İşlevin adı. En fazla 63 karakter olacak şekilde, a-z, A-Z, 0-9 biçiminde olmalı veya alt çizgi ve tire içermelidir.
description

string

Zorunlu. İşlevin kısa bir açıklaması.
parameters

object (Schema)

İsteğe bağlı. Bu fonksiyonun parametrelerini açıklar. Open API 3.03 Parametre Nesnesi dize anahtarını yansıtır: Parametrenin adı. Parametre adları büyük/küçük harfe duyarlıdır. Şema Değeri: Parametre için kullanılan türü tanımlayan şema.

Şema

Schema nesnesi, giriş ve çıkış veri türlerinin tanımlanmasına olanak tanır. Bu türler nesnelerin yanı sıra temel öğeler ve diziler de olabilir. Bir OpenAPI 3.0 şema nesnesinin belirli alt kümesini temsil eder.

JSON gösterimi 
{
  "type": enum (Type),
  "format": string,
  "description": string,
  "nullable": boolean,
  "enum": [
    string
  ],
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "items": {
    object (Schema)
  }
}
Alanlar
type

enum (Type)

Zorunlu. Veri türü.
format

string

İsteğe bağlı. Verilerin biçimi. Bu, yalnızca temel veri türleri için kullanılır. Desteklenen biçimler: NUMBER türü için kayan noktalı, INTEGER türü için çift değer: int32, int64
description

string

İsteğe bağlı. Parametrenin kısa bir açıklaması. Bu, kullanım örnekleri içerebilir. Parametre açıklaması Markdown olarak biçimlendirilebilir.
nullable

boolean

İsteğe bağlı. Değerin boş olup olmadığını gösterir.
enum[]

string

İsteğe bağlı. Numaralandırma biçimindeki Type.STRING öğesinin olası değerleri. Örneğin, bir Sıralama Yönünü şu şekilde tanımlayabiliriz : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
properties

map (key: string, value: object (Schema))

İsteğe bağlı. Type.OBJECT özellikleri.

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

string

İsteğe bağlı. Gerekli Type.OBJECT özellikleri.
items

object (Schema)

İsteğe bağlı. Type.ARRAY öğelerinin şeması.

Tür

Tür, https://spec.openapis.org/oas/v3.0.3#data-types tarafından tanımlanan OpenAPI veri türlerinin listesini içerir

Sıralamalar
TYPE_UNSPECIFIED Belirtilmedi, kullanılmamalıdır.
STRING Dize türü.
NUMBER Numara türü.
INTEGER Tam sayı türü.
BOOLEAN Boole türü.
ARRAY Dizi türü.
OBJECT Nesne türü.

ToolConfig

İstekte Tool kullanımını belirtmek için parametreler içeren araç yapılandırması.

JSON gösterimi 
{
  "functionCallingConfig": {
    object (FunctionCallingConfig)
  }
}
Alanlar
functionCallingConfig

object (FunctionCallingConfig)

İsteğe bağlı. İşlev çağrısı yapılandırması.

FunctionCallingConfig

İşlev çağrısı davranışını belirten yapılandırma.

JSON gösterimi 
{
  "mode": enum (Mode),
  "allowedFunctionNames": [
    string
  ]
}
Alanlar
mode

enum (Mode)

İsteğe bağlı. İşlev çağrısının yürütüleceği modu belirtir. Bir değer belirtilmezse varsayılan değer OTOMATİK olarak ayarlanır.
allowedFunctionNames[]

string

İsteğe bağlı. Sağlandığında modelin çağıracağı işlevleri sınırlayan bir dizi işlev adları.

Bu yalnızca Mod ANY olduğunda ayarlanmalıdır. İşlev adları, [FunctionDeclaration.name] işleviyle eşleşmelidir. Mod ANY değerine ayarlandığında model, sağlanan işlev adları kümesinden bir işlev çağrısı tahmin eder.

Mod

Yürütme modunu tanımlayarak işlev çağrısı için yürütme davranışını tanımlar.

Sıralamalar
MODE_UNSPECIFIED Belirtilmemiş işlev çağrısı modu. Bu değer kullanılmamalıdır.
AUTO Varsayılan model davranışı. Model, bir işlev çağrısını veya doğal dil yanıtını tahmin etmeye karar verir.
ANY Model, her zaman yalnızca bir işlev çağrısını tahmin edecek şekilde sınırlandırılır. "allowedFunctionNames" ayarlanırsa, tahmin edilen işlev çağrısı "allowedFunctionNames" öğelerinin herhangi biriyle sınırlanır, aksi takdirde, tahmin edilen işlev çağrısı sağlanan "functionDeclarations" özelliklerinden herhangi biri olur.
NONE Model herhangi bir işlev çağrısını tahmin etmez. Model davranışı, herhangi bir işlev bildirimlerinin iletilmemesiyle aynıdır.

UsageMetadata

Önbelleğe alınan içeriğin kullanımına ilişkin meta veriler.

JSON gösterimi 
{
  "totalTokenCount": integer
}
Alanlar
totalTokenCount

integer

Önbelleğe alınan içeriğin kullandığı toplam jeton sayısı.

Yöntemler

create

 CachedContent kaynağı oluşturur.

delete

 CachedContent kaynağını siler.

get

 CachedContent kaynağını okur.

list

 CachedContents'i listeler.

patch

 CachedContent kaynağını günceller (yalnızca son kullanma tarihi güncellenebilir).