Bağlam önbelleğe alma, tekrar tekrar kullanmak istediğiniz önceden hesaplanmış giriş jetonlarını (ör. aynı medya dosyası hakkında farklı sorular sorarken) kaydetmenize ve yeniden kullanmanıza olanak tanır. Bu, kullanıma bağlı olarak maliyet ve hız tasarrufu sağlayabilir. Ayrıntılı bir giriş için Bağlam önbelleğe alma kılavuzuna bakın.
Yöntem: cachedContents.create
CachedContent kaynağı oluşturur.
Uç nokta
yayınlahttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
İstek içeriği
İstek metni, CachedContent
öğesinin bir örneğini içerir.
contents[]
object (Content
)
İsteğe bağlı. Yalnızca giriş. Değişmez. Önbelleğe alınacak içerik.
tools[]
object (Tool
)
İsteğe bağlı. Yalnızca giriş. Değişmez. Modelin sonraki yanıtı oluşturmak için kullanabileceği Tools
öğelerinin listesi
expiration
Union type
expiration
yalnızca aşağıdakilerden biri olabilir:expireTime
string (Timestamp
format)
Bu kaynağın geçerliliğinin sona erdiği kabul edilen zamanı gösteren UTC zaman damgası. Bu değer, girişte gönderilenden bağımsız olarak çıkışta her zaman sağlanır.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
veya "2014-10-02T15:01:23+05:30"
.
ttl
string (Duration
format)
Yalnızca giriş. Bu kaynak için yeni TTL, yalnızca giriş.
En fazla dokuz kesirli basamak içeren ve "s
" ile biten, saniye cinsinden süre. Örnek: "3.5s"
.
displayName
string
İsteğe bağlı. Değişmez. Önbelleğe alınan içeriğin kullanıcı tarafından oluşturulan anlamlı görünen adı. Maksimum 128 Unicode karakteri.
model
string
Zorunlu. Değişmez. Ö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ş. Değişmez. Geliştirici tarafından ayarlanan sistem talimatı. Şu anda yalnızca metin olarak kullanılabilir.
toolConfig
object (ToolConfig
)
İsteğe bağlı. Yalnızca giriş. Değişmez. Araç yapılandırması. Bu yapılandırma tüm araçlar için paylaşılır.
Örnek istek
Temel
Python
Node.js
Go
kabuk
Gönderen adı
Python
Node.js
Go
Sohbetten
Python
Node.js
Go
Yanıt gövdesi
Başarılı olursa yanıt metni, yeni oluşturulmuş bir CachedContent
örneği içerir.
Yöntem: cachedContents.list
CachedContents öğesini listeler.
Uç nokta
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Sorgu parametreleri
pageSize
integer
İsteğe bağlı. Döndürülecek maksimum önbelleğe alınmış içerik sayısı. Hizmet bu değerden daha az sonuç döndürebilir. Belirtilmemişse varsayılan (maksimumun altında) bir öğe sayısı döndürülür. Maksimum değer 1.000'dür. 1.000'den büyük değerler 1.000'e zorlanacaktır.
pageToken
string
İsteğe bağlı. Önceki bir cachedContents.list
çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bunu sağlayın.
Sayfalandırma yaparken cachedContents.list
parametresine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
CachedContents listesi içeren yanıt.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
cachedContents[]
object (CachedContent
)
Önbelleğe alınmış içeriklerin listesi.
nextPageToken
string
Sonraki sayfayı almak için pageToken
olarak gönderilebilen bir jeton. Bu alan atlanırsa sonraki sayfalar olmaz.
JSON gösterimi |
---|
{
"cachedContents": [
{
object ( |
Yöntem: cachedContents.get
CachedContent kaynağını okur.
Uç nokta
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Yol parametreleri
name
string
Zorunlu. İçerik önbelleği girişine atıfta bulunan kaynak adı. Biçim: cachedContents/{id}
cachedContents/{cachedcontent}
biçimindedir.
İstek içeriği
İstek metni boş olmalıdır.
Örnek istek
Python
Node.js
Go
kabuk
Yanıt gövdesi
Başarılıysa yanıt metni, CachedContent
öğesinin bir örneğini içerir.
Yöntem: cachedContents.patch
CachedContent kaynağını günceller (yalnızca geçerlilik süresi güncellenebilir).
Uç nokta
yamahttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
Yol parametreleri
cachedContent.name
string
Yalnızca çıkış. Tanımlayıcı. Önbelleğe alınan içeriğe atıfta bulunan kaynak adı. Biçim: cachedContents/{id}
cachedContents/{cachedcontent}
biçimindedir.
Sorgu parametreleri
updateMask
string (FieldMask
format)
Güncellenecek alanların listesi.
Bu, alanların tam nitelikli adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo"
.
İstek içeriği
İstek metni, CachedContent
öğesinin bir örneğini içerir.
expiration
Union type
expiration
yalnızca aşağıdakilerden biri olabilir:expireTime
string (Timestamp
format)
Bu kaynağın geçerliliğinin sona erdiği kabul edilen zamanı gösteren UTC zaman damgası. Bu değer, girişte gönderilenden bağımsız olarak çıkışta her zaman sağlanır.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
veya "2014-10-02T15:01:23+05:30"
.
ttl
string (Duration
format)
Yalnızca giriş. Bu kaynak için yeni TTL, yalnızca giriş.
En fazla dokuz kesirli basamak içeren ve "s
" ile biten, saniye cinsinden süre. Örnek: "3.5s"
.
Örnek istek
Python
Node.js
Go
kabuk
Yanıt gövdesi
Başarılıysa yanıt metni, CachedContent
öğesinin bir örneğini içerir.
Yöntem: cachedContents.delete
CachedContent kaynağını siler.
Uç nokta
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Yol parametreleri
name
string
Zorunlu. İçerik önbelleği girişine atıfta bulunan kaynak adı Biçim: cachedContents/{id}
cachedContents/{cachedcontent}
biçimindedir.
İstek içeriği
İstek metni boş olmalıdır.
Örnek istek
Python
Node.js
Go
kabuk
Yanıt gövdesi
Başarılı olursa yanıt metni boş bir JSON nesnesi olur.
REST Kaynağı: cachedContents
- Kaynak: CachedContent
- İçerik
- Bölüm
- Blob
- FunctionCall
- FunctionResponse
- Planlama
- FileData
- ExecutableCode
- Dil
- CodeExecutionResult
- Sonuç
- VideoMetadata
- Araç
- FunctionDeclaration
- Şema
- Tür
- Davranış
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- Mod
- CodeExecution
- GoogleSearch
- Aralık
- UrlContext
- ToolConfig
- FunctionCallingConfig
- Mod
- UsageMetadata
- Yöntemler
Kaynak: CachedContent
Önceden işlenmiş ve GenerativeService'e yapılan sonraki isteklerde kullanılabilen içerik.
Önbelleğe alınan içerikler yalnızca oluşturuldukları modelde kullanılabilir.
contents[]
object (Content
)
İsteğe bağlı. Yalnızca giriş. Değişmez. Önbelleğe alınacak içerik.
tools[]
object (Tool
)
İsteğe bağlı. Yalnızca giriş. Değişmez. Modelin sonraki yanıtı oluşturmak için kullanabileceği Tools
öğelerinin listesi
createTime
string (Timestamp
format)
Yalnızca çıkış. Önbellek girişinin oluşturulma zamanı.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de 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ış. Önbelleğe alınan girişin UTC saatinde son güncellenme zamanı.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
veya "2014-10-02T15:01:23+05:30"
.
usageMetadata
object (UsageMetadata
)
Yalnızca çıkış. Önbelleğe alınmış içeriğin kullanımıyla ilgili meta veriler.
expiration
Union type
expiration
yalnızca aşağıdakilerden biri olabilir:expireTime
string (Timestamp
format)
Bu kaynağın geçerliliğinin sona erdiği kabul edilen zamanı gösteren UTC zaman damgası. Bu değer, girişte gönderilenden bağımsız olarak çıkışta her zaman sağlanır.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
veya "2014-10-02T15:01:23+05:30"
.
ttl
string (Duration
format)
Yalnızca giriş. Bu kaynak için yeni TTL, yalnızca giriş.
En fazla dokuz kesirli basamak içeren ve "s
" ile biten, saniye cinsinden süre. Örnek: "3.5s"
.
name
string
Yalnızca çıkış. Tanımlayıcı. Önbelleğe alınan içeriğe atıfta bulunan kaynak adı. Biçim: cachedContents/{id}
displayName
string
İsteğe bağlı. Değişmez. Önbelleğe alınan içeriğin kullanıcı tarafından oluşturulan anlamlı görünen adı. Maksimum 128 Unicode karakteri.
model
string
Zorunlu. Değişmez. Ö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ş. Değişmez. Geliştirici tarafından ayarlanan sistem talimatı. Şu anda yalnızca metin olarak kullanılabilir.
toolConfig
object (ToolConfig
)
İsteğe bağlı. Yalnızca giriş. Değişmez. Araç yapılandırması. Bu yapılandırma tüm araçlar için paylaşılır.
JSON gösterimi |
---|
{ "contents": [ { object ( |
İçerik
Bir mesajın çok parçalı içeriğini içeren temel yapılandırılmış veri türü.
Content
, Content
'ün üreticisini belirten bir role
alanı ve ileti sırasının içeriğini içeren çok parçalı verileri içeren bir parts
alanı içerir.
parts[]
object (Part
)
Tek bir mesajı oluşturan sıralı Parts
. Parçaların MIME türleri farklı olabilir.
role
string
İsteğe bağlı. İçeriğin yapımcısı. "user" veya "model" olmalıdır.
Birden çok katılımcının yer aldığı görüşmeler için ayarlanması yararlıdır. Aksi takdirde boş bırakılabilir veya ayarlanmamış olabilir.
JSON gösterimi |
---|
{
"parts": [
{
object ( |
Bölüm
Çok parçalı bir 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
, yalnızca Part.data
'da kabul edilen türlerden birini içerebilir.
inlineData
alanı ham baytlarla doldurulmuşsa Part
, medyanın türünü ve alt türünü tanımlayan sabit bir IANA MIME türüne sahip olmalıdır.
thought
boolean
İsteğe bağlı. Parçanın modelden alınıp alınmadığını belirtir.
data
Union type
data
yalnızca aşağıdakilerden biri olabilir:text
string
Satır içi metin.
inlineData
object (Blob
)
Satır içi medya baytları.
functionCall
object (FunctionCall
)
Modelden döndürülen ve bağımsız değişkenleri ile değerlerini içeren FunctionDeclaration.name
değerini temsil eden bir dize içeren tahmini FunctionCall
.
functionResponse
object (FunctionResponse
)
FunctionDeclaration.name
'yi temsil eden bir dize ve işlevden gelen tüm çıkışları içeren yapılandırılmış bir JSON nesnesi içeren bir FunctionCall
'nin sonuç çıkışı, modelin bağlamı olarak kullanılır.
fileData
object (FileData
)
URI tabanlı veriler.
executableCode
object (ExecutableCode
)
Model tarafından oluşturulan ve yürütülmesi amaçlanan kod.
codeExecutionResult
object (CodeExecutionResult
)
ExecutableCode
işlevinin yürütülmesinin sonucu.
metadata
Union type
metadata
yalnızca aşağıdakilerden biri olabilir:videoMetadata
object (VideoMetadata
)
İsteğe bağlı. Video meta verileri. Meta veriler yalnızca video verileri inlineData veya fileData içinde sunulurken belirtilmelidir.
JSON gösterimi |
---|
{ "thought": boolean, // data "text": string, "inlineData": { object ( |
Blob
Ham medya baytları.
Metin, ham bayt olarak gönderilmemelidir. "metin" alanını kullanın.
mimeType
string
Kaynak verilerin IANA standart MIME türü. Örnekler: - image/png - image/jpeg Desteklenmeyen bir MIME türü sağlanırsa 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.
JSON gösterimi |
---|
{ "mimeType": string, "data": string } |
FunctionCall
Modelden döndürülen ve bağımsız değişkenleri ile değerlerini içeren FunctionDeclaration.name
değerini temsil eden bir dize içeren tahmini FunctionCall
.
id
string
İsteğe bağlı. İşlev çağrısının benzersiz kimliği. Doldurulmuşsa istemci, functionCall
'yi yürütür ve eşleşen id
ile yanıtı döndürür.
name
string
Zorunlu. Çağırılacak işlevin adı. a-z, A-Z, 0-9 arasında olmalı veya alt çizgi ve kısa çizgi içermeli, en fazla 63 karakter uzunluğunda olmalıdır.
args
object (Struct
format)
İsteğe bağlı. JSON nesnesi biçiminde işlev parametreleri ve değerleri.
JSON gösterimi |
---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
FunctionDeclaration.name
'yi temsil eden bir dize ve işlevden gelen tüm çıkışları içeren yapılandırılmış bir JSON nesnesi içeren bir FunctionCall
'den elde edilen sonuç çıkışı, modelin bağlamı olarak kullanılır. Bu, model tahminine göre oluşturulan bir FunctionCall
sonucunu içermelidir.
id
string
İsteğe bağlı. Bu yanıtın ait olduğu işlev çağrısının kimliği. İlgili işlev çağrısı id
ile eşleşecek şekilde istemci tarafından doldurulur.
name
string
Zorunlu. Çağırılacak işlevin adı. a-z, A-Z, 0-9 arasında olmalı veya alt çizgi ve kısa çizgi içermeli, en fazla 63 karakter uzunluğunda olmalıdır.
response
object (Struct
format)
Zorunlu. JSON nesnesi biçiminde işlev yanıtı.
willContinue
boolean
İsteğe bağlı. İşlev çağrısının devam ettiğini ve daha fazla yanıtın döndürüleceğini belirten sinyal. Bu sinyal, işlev çağrısını bir üreticiye dönüştürür. Yalnızca NON_BLOCKING işlev çağrıları için geçerlidir, aksi takdirde yoksayılır. Yanlış değerine ayarlanırsa gelecekteki yanıtlar dikkate alınmaz. İşlev çağrısının sona erdiğini belirtmek için willContinue=False
ile birlikte boş response
döndürülmesine izin verilir. Bu işlem, model oluşturma işlemini tetikleyebilir. Oluşturmayı tetiklememek ve işlev çağrısını sonlandırmak için scheduling
'ü SILENT
olarak da ayarlayın.
scheduling
enum (Scheduling
)
İsteğe bağlı. Yanıtın sohbette nasıl planlanacağını belirtir. Yalnızca NON_BLOCKING işlev çağrıları için geçerlidir, aksi takdirde yoksayılır. Varsayılan olarak WHEN_IDLE değerine ayarlanır.
JSON gösterimi |
---|
{
"id": string,
"name": string,
"response": {
object
},
"willContinue": boolean,
"scheduling": enum ( |
Planlama
Yanıtın sohbette nasıl planlanacağını belirtir.
Sıralamalar | |
---|---|
SCHEDULING_UNSPECIFIED |
Bu değer kullanılmamaktadır. |
SILENT |
Yalnızca sonucu görüşme bağlamına ekleyin, oluşturma işlemini kesintiye uğratmayın veya tetiklemeyin. |
WHEN_IDLE |
Sonucu görüşme bağlamına ekleyin ve devam eden oluşturma işlemini kesintiye uğratmadan çıktı oluşturmayı isteyin. |
INTERRUPT |
Sonucu sohbet bağlamına ekleyin, devam eden oluşturma işlemini kesintiye uğratın ve çıkış oluşturma istemi gösterin. |
FileData
URI tabanlı veriler.
mimeType
string
İsteğe bağlı. Kaynak verilerin IANA standart MIME türü.
fileUri
string
Zorunlu. URI.
JSON gösterimi |
---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
Model tarafından oluşturulan ve çalıştırılmak üzere tasarlanmış kod ve modele döndürülen sonuç.
Yalnızca CodeExecution
aracı kullanılırken oluşturulur. Bu araçta kod otomatik olarak yürütülür ve ilgili bir CodeExecutionResult
da oluşturulur.
language
enum (Language
)
Zorunlu. code
'ün programlama dili.
code
string
Zorunlu. Yürütülecek kod.
JSON gösterimi |
---|
{
"language": enum ( |
Dil
Oluşturulan kod için desteklenen programlama dilleri.
Sıralamalar | |
---|---|
LANGUAGE_UNSPECIFIED |
Belirtilmemiş dil. Bu değer kullanılmamalıdır. |
PYTHON |
Python >= 3.10 (numpy ve simpy kullanılabilir). |
CodeExecutionResult
ExecutableCode
işlevinin yürütülmesinin sonucu.
Yalnızca CodeExecution
kullanıldığında oluşturulur ve her zaman ExecutableCode
içeren bir part
'dan sonra gelir.
outcome
enum (Outcome
)
Zorunlu. Kod yürütmenin sonucu.
output
string
İsteğe bağlı. Kod yürütme başarılı olduğunda stdout, aksi takdirde stderr veya başka bir açıklama içerir.
JSON gösterimi |
---|
{
"outcome": enum ( |
Sonuç
Kod yürütmenin olası sonuçlarının listesi.
Sıralamalar | |
---|---|
OUTCOME_UNSPECIFIED |
Belirtilmemiş durum. Bu değer kullanılmamalıdır. |
OUTCOME_OK |
Kod yürütme işlemi başarıyla tamamlandı. |
OUTCOME_FAILED |
Kod yürütme tamamlandı ancak bir hatayla. stderr , nedeni içermelidir. |
OUTCOME_DEADLINE_EXCEEDED |
Kod yürütme işlemi çok uzun sürdü ve iptal edildi. Kısmi çıkış olabilir veya olmayabilir. |
VideoMetadata
Meta veriler, giriş video içeriğini tanımlar.
startOffset
string (Duration
format)
İsteğe bağlı. Videonun başlangıç ofseti.
En fazla dokuz kesirli basamak içeren ve "s
" ile biten, saniye cinsinden süre. Örnek: "3.5s"
.
endOffset
string (Duration
format)
İsteğe bağlı. Videonun bitiş ofseti.
En fazla dokuz kesirli basamak içeren ve "s
" ile biten, saniye cinsinden süre. Örnek: "3.5s"
.
fps
number
İsteğe bağlı. Modele gönderilen videonun kare hızı. Bir değer belirtilmezse varsayılan değer 1, 0 olur. FPS aralığı [0,0; 24,0] aralığıdır.
JSON gösterimi |
---|
{ "startOffset": string, "endOffset": string, "fps": number } |
Araç
Modelin yanıt oluşturmak için kullanabileceği araç ayrıntıları.
Tool
, sistemin modelin bilgisi ve kapsamı dışında bir işlem veya işlem grubu gerçekleştirmek için harici sistemlerle etkileşime geçmesini sağlayan bir kod parçasıdır.
functionDeclarations[]
object (FunctionDeclaration
)
İsteğe bağlı. Modelin kullanabileceği ve işlev çağrısı için kullanılabilen FunctionDeclarations
öğelerinin listesi.
Model veya sistem işlevi yürütmez. Bunun yerine, tanımlanan işlev, yürütülmek üzere istemci tarafına gönderilecek bağımsız değişkenlerle birlikte bir FunctionCall
olarak döndürülebilir. Model, yanıtta FunctionCall
değerini doldurarak bu işlevlerin bir alt kümesini çağırmaya karar verebilir. Bir sonraki sohbet dönüşümü, bir sonraki model dönüşümü için Content.role
"işlevi" oluşturma bağlamını içeren bir FunctionResponse
içerebilir.
googleSearchRetrieval
object (GoogleSearchRetrieval
)
İsteğe bağlı. Google Arama tarafından desteklenen alma aracı.
codeExecution
object (CodeExecution
)
İsteğe bağlı. Modelin, kod oluşturma işleminin bir parçası olarak kod yürütmesini sağlar.
googleSearch
object (GoogleSearch
)
İsteğe bağlı. Google Arama aracı türü. Modelde Google Arama'yı destekleyen araç. Google tarafından desteklenmektedir.
urlContext
object (UrlContext
)
İsteğe bağlı. URL bağlamını alma işlemini destekleyen araç.
JSON gösterimi |
---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
OpenAPI 3.03 spesifikasyonunda tanımlandığı şekliyle bir işlev beyanının yapılandırılmış gösterimi. Bu beyan, işlev adını ve parametrelerini içerir. Bu FunctionDeclaration, model tarafından Tool
olarak kullanılabilen ve istemci tarafından çalıştırılan bir kod bloğunun temsilidir.
name
string
Zorunlu. İşlevin adı. a-z, A-Z, 0-9 arasında olmalı veya alt çizgi ve kısa çizgi içermeli, en fazla 63 karakter uzunluğunda olmalıdır.
description
string
Zorunlu. İşlevin kısa bir açıklaması.
behavior
enum (Behavior
)
İsteğe bağlı. Davranış işlevini belirtir. Şu anda yalnızca BidiGenerateContent yöntemi tarafından desteklenmektedir.
parameters
object (Schema
)
İsteğe bağlı. Bu işlevin 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.
response
object (Schema
)
İsteğe bağlı. Bu işlevin çıktısını JSON şeması biçiminde açıklar. Open API 3.03 Yanıt Nesnesi'ni yansıtır. Şema, işlevin yanıt değeri için kullanılan türü tanımlar.
Şema
Schema
nesnesi, giriş ve çıkış veri türlerinin tanımlanmasına olanak tanır. Bu türler nesneler olabileceği gibi ilkel ve diziler de olabilir. OpenAPI 3.0 şema nesnesinin belirli bir alt kümesini temsil eder.
type
enum (Type
)
Zorunlu. Veri türü.
format
string
İsteğe bağlı. Verilerin biçimi. Bu, yalnızca ilkel veri türleri için kullanılır. Desteklenen biçimler: SAYI türü için: float, double TAM SAYI türü için: int32, int64 DÜZENLEME türü için: enum, tarih/saat
title
string
İsteğe bağlı. Şemanın başlığı.
description
string
İsteğe bağlı. Parametrenin kısa bir açıklaması. Bu bilgilerde kullanım örnekleri yer alabilir. Parametre açıklaması Markdown olarak biçimlendirilebilir.
nullable
boolean
İsteğe bağlı. Değerin boş olup olamayacağını belirtir.
enum[]
string
İsteğe bağlı. Type.STRING öğesinin, enum biçimindeki olası değerleri. Örneğin, bir Enum Yön'ü şu şekilde tanımlayabiliriz : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
İsteğe bağlı. Type.ARRAY için maksimum öğe sayısı.
minItems
string (int64 format)
İsteğe bağlı. Type.ARRAY için minimum öğe sayısı.
properties
map (key: string, value: object (Schema
))
İsteğe bağlı. Type.OBJECT özelliğinin özellikleri.
"key": value
çiftlerinin listesini içeren bir nesne. Örnek: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
required[]
string
İsteğe bağlı. Type.OBJECT için zorunlu özellikler.
minProperties
string (int64 format)
İsteğe bağlı. Type.OBJECT için minimum mülk sayısı.
maxProperties
string (int64 format)
İsteğe bağlı. Type.OBJECT için maksimum özellik sayısı.
minLength
string (int64 format)
İsteğe bağlı. TYPE STRING İÇİN ŞEMA ALANLARI Type.STRING'in minimum uzunluğu
maxLength
string (int64 format)
İsteğe bağlı. Type.STRING türündeki maksimum uzunluk
pattern
string
İsteğe bağlı. Bir dizeyi normal ifadeyle kısıtlamak için Type.STRING türündeki kalıp.
example
value (Value
format)
İsteğe bağlı. Nesneyi gösteren örnek. Yalnızca nesne kök olduğunda doldurulur.
anyOf[]
object (Schema
)
İsteğe bağlı. Değer, listedeki alt şemalardan herhangi biri (bir veya daha fazlası) ile doğrulanmalıdır.
propertyOrdering[]
string
İsteğe bağlı. Mülklerin sırası. OpenAPI spesifikasyonunda standart bir alan değildir. Yanıttaki mülklerin sırasını belirlemek için kullanılır.
default
value (Value
format)
İsteğe bağlı. Alanın varsayılan değeri. JSON şemasına göre bu alan, doküman oluşturucular için tasarlanmıştır ve doğrulamayı etkilemez. Bu nedenle, default
alanı içeren şemalar gönderen geliştiricilerin bilinmeyen alan hataları almaması için bu alan buraya dahil edilir ve yoksayılır.
items
object (Schema
)
İsteğe bağlı. Type.ARRAY öğelerinin şeması.
minimum
number
İsteğe bağlı. TYPE INTEGER ve NUMBER İÇİN ŞEMA ALANLARI Type.INTEGER ve Type.NUMBER için minimum değer
maximum
number
İsteğe bağlı. Type.INTEGER ve Type.NUMBER türlerinin maksimum değeri
JSON gösterimi |
---|
{ "type": enum ( |
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 |
Belirtilmemiş, 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ü. |
NULL |
Boş tür. |
Davranış
İşlev davranışını tanımlar. Varsayılan olarak BLOCKING
değerine ayarlanır.
Sıralamalar | |
---|---|
UNSPECIFIED |
Bu değer kullanılmamaktadır. |
BLOCKING |
Bu ayar etkinleştirilirse sistem, sohbete devam etmeden önce işlev yanıtını almayı bekler. |
NON_BLOCKING |
Bu ayar etkinleştirilirse sistem, işlev yanıtını almayı beklemez. Bunun yerine, kullanıcı ile model arasındaki görüşmeyi sürdürürken işlev yanıtlarını kullanılabilir hale geldikçe işlemeye çalışır. |
GoogleSearchRetrieval
Google tarafından desteklenen, temellendirme için herkese açık web verilerini alma aracı.
dynamicRetrievalConfig
object (DynamicRetrievalConfig
)
Belirtilen kaynak için dinamik getirme yapılandırmasını belirtir.
JSON gösterimi |
---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Dinamik getirmeyi özelleştirme seçeneklerini açıklar.
mode
enum (Mode
)
Dinamik getirmede kullanılacak öngörücü modu.
dynamicThreshold
number
Dinamik getirmede kullanılacak eşik. Ayarlanmazsa sistem varsayılan değeri kullanılır.
JSON gösterimi |
---|
{
"mode": enum ( |
Mod
Dinamik getirmede kullanılacak öngörücü modu.
Sıralamalar | |
---|---|
MODE_UNSPECIFIED |
Her zaman getirmeyi tetikleyin. |
MODE_DYNAMIC |
Alma işlemini yalnızca sistem gerekli olduğuna karar verdiğinde çalıştırın. |
CodeExecution
Bu türde alan yoktur.
Model tarafından oluşturulan kodu yürüten ve sonucu modele otomatik olarak döndüren araç.
Yalnızca bu araç kullanılırken oluşturulan ExecutableCode
ve CodeExecutionResult
hükümlerine de göz atın.
GoogleSearch
Google Arama aracı türü. Modelde Google Arama'yı destekleyen araç. Google tarafından desteklenmektedir.
timeRangeFilter
object (Interval
)
İsteğe bağlı. Arama sonuçlarını belirli bir zaman aralığına göre filtreleyin. Müşteriler bir başlangıç zamanı ayarlarsa bitiş zamanı da ayarlamalıdır (ve bunun tersi de geçerlidir).
JSON gösterimi |
---|
{
"timeRangeFilter": {
object ( |
Aralık
Zaman damgası başlangıcı (dahil) ve zaman damgası sonu (hariç) olarak kodlanmış bir zaman aralığını temsil eder.
Başlangıç, bitişten küçük veya ona eşit olmalıdır. Başlangıç bitişle aynı olduğunda aralık boştur (hiçbir zamanla eşleşmez). Hem başlangıç hem de bitiş belirtilmediğinde aralık herhangi bir zamanla eşleşir.
startTime
string (Timestamp
format)
İsteğe bağlı. Aranın dahili başlangıcı.
Belirtilmişse bu aralıkla eşleşen bir Zaman Damgası, başlangıçla aynı veya başlangıçtan sonra olmalıdır.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de 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)
İsteğe bağlı. Aranın bitiş zamanı (girilen tarihler dahil değil).
Belirtildiyse bu aralıkla eşleşen bir zaman damgasının bitişten önce olması gerekir.
Oluşturulan çıktının her zaman Z normalleştirileceği ve 0, 3, 6 veya 9 kesirli basamak kullanacağı RFC 3339'u kullanır. "Z" dışındaki ofsetler de kabul edilir. Örnekler: "2014-10-02T15:01:23Z"
, "2014-10-02T15:01:23.045123456Z"
veya "2014-10-02T15:01:23+05:30"
.
JSON gösterimi |
---|
{ "startTime": string, "endTime": string } |
UrlContext
Bu türde alan yoktur.
URL bağlamını alma işlemini destekleyen araç.
ToolConfig
İstekte Tool
kullanımını belirtmek için parametreler içeren araç yapılandırması.
functionCallingConfig
object (FunctionCallingConfig
)
İsteğe bağlı. İşlev çağırma yapılandırması.
JSON gösterimi |
---|
{
"functionCallingConfig": {
object ( |
FunctionCallingConfig
İşlev çağırma davranışını belirtme yapılandırması.
mode
enum (Mode
)
İsteğe bağlı. İşlev çağrısının hangi modda yürütüleceğini belirtir. Belirtilmemişse varsayılan değer AUTO olarak ayarlanır.
allowedFunctionNames[]
string
İsteğe bağlı. Sağlandığında modelin çağıracağı işlevleri sınırlayan bir işlev adı grubu.
Bu ayar yalnızca Mod BİRİSİ olduğunda yapılmalıdır. İşlev adları [FunctionDeclaration.name] ile eşleşmelidir. Mod HERHANGİ olarak ayarlandığında model, sağlanan işlev adları grubundan bir işlev çağrısı tahmin eder.
JSON gösterimi |
---|
{
"mode": enum ( |
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ı 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 kısıtlanmıştır. "allowedFunctionNames" ayarlanırsa tahmin edilen işlev çağrısı, "allowedFunctionNames" değerlerinden herhangi biriyle sınırlı olur. Aksi takdirde tahmin edilen işlev çağrısı, sağlanan "functionDeclarations" değerlerinden herhangi biri olur. |
NONE |
Model herhangi bir işlev çağrısını tahmin etmez. Model davranışı, herhangi bir işlev beyanı iletilmediğinde olduğu gibidir. |
VALIDATED |
Model, bir işlev çağrısını veya doğal dil yanıtını tahmin etmeye karar verir ancak işlev çağrılarını kısıtlanmış kod çözme ile doğrular. |
UsageMetadata
Önbelleğe alınmış içeriğin kullanımıyla ilgili meta veriler.
totalTokenCount
integer
Önbelleğe alınan içeriğin kullandığı toplam jeton sayısı.
JSON gösterimi |
---|
{ "totalTokenCount": integer } |