Context caching memungkinkan Anda menyimpan dan menggunakan kembali token input yang telah dihitung sebelumnya dan ingin Anda gunakan berulang kali, misalnya saat mengajukan pertanyaan yang berbeda tentang file media yang sama. Hal ini dapat menghemat biaya dan kecepatan, bergantung pada penggunaannya. Untuk pengantar mendetail, lihat panduan Penyimpanan cache konteks.
Metode: cachedContents.create
Membuat resource CachedContent.
Endpoint
postinganhttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Isi permintaan
Isi permintaan memuat instance CachedContent
.
contents[]
object (Content
)
Opsional. Hanya input. Tidak dapat diubah. Konten yang akan di-cache.
tools[]
object (Tool
)
Opsional. Hanya input. Tidak dapat diubah. Daftar Tools
yang dapat digunakan model untuk menghasilkan respons berikutnya
expiration
Union type
expiration
hanya dapat berupa salah satu dari hal berikut:expireTime
string (Timestamp
format)
Stempel waktu dalam UTC saat resource ini dianggap habis masa berlakunya. Ini selalu diberikan pada output, terlepas dari apa yang dikirim pada input.
Menggunakan RFC 3339, dengan output yang dihasilkan 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"
.
ttl
string (Duration
format)
Hanya input. TTL baru untuk resource ini, hanya input.
Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's
'. Contoh: "3.5s"
.
displayName
string
Opsional. Tidak dapat diubah. Nama tampilan bermakna buatan pengguna dari konten yang di-cache. Maksimum 128 karakter Unicode.
model
string
Wajib. Tidak dapat diubah. Nama Model
yang akan digunakan untuk konten yang di-cache Format: models/{model}
systemInstruction
object (Content
)
Opsional. Hanya input. Tidak dapat diubah. Petunjuk sistem yang ditetapkan developer. Saat ini hanya berupa teks.
toolConfig
object (ToolConfig
)
Opsional. Hanya input. Tidak dapat diubah. Konfigurasi alat. Konfigurasi ini dibagikan untuk semua alat.
Contoh permintaan
Dasar
Python
Node.js
Go
Shell
Nama pengirim
Python
Node.js
Go
Dari chat
Python
Node.js
Go
Isi respons
Jika berhasil, isi respons memuat instance CachedContent
yang baru dibuat.
Metode: cachedContents.list
Mencantumkan CachedContents.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Parameter kueri
pageSize
integer
Opsional. Jumlah maksimum konten yang di-cache untuk ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini. Jika tidak ditentukan, beberapa item default (di bawah maksimum) akan ditampilkan. Nilai maksimum adalah 1.000; nilai di atas 1.000 akan dikonversi menjadi 1.000.
pageToken
string
Opsional. Token halaman, diterima dari panggilan cachedContents.list
sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.
Saat melakukan penomoran halaman, semua parameter lain yang diberikan untuk cachedContents.list
harus sesuai dengan panggilan yang menyediakan token halaman.
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Respons dengan daftar CachedContents.
Jika berhasil, isi respons memuat data dengan struktur berikut:
cachedContents[]
object (CachedContent
)
Daftar konten yang di-cache.
nextPageToken
string
Token yang dapat dikirim sebagai pageToken
untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.
Representasi JSON |
---|
{
"cachedContents": [
{
object ( |
Metode: cachedContents.get
Membaca resource CachedContent.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Parameter jalur
name
string
Wajib. Nama resource yang merujuk ke entri cache konten. Format: cachedContents/{id}
Formatnya adalah cachedContents/{cachedcontent}
.
Isi permintaan
Isi permintaan harus kosong.
Contoh permintaan
Python
Node.js
Go
Shell
Isi respons
Jika berhasil, isi respons memuat instance CachedContent
.
Metode: cachedContents.patch
Memperbarui resource CachedContent (hanya waktu habis masa berlaku yang dapat diperbarui).
Endpoint
patchhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
Parameter jalur
cachedContent.name
string
Hanya output. ID. Nama resource yang merujuk ke konten yang di-cache. Format: cachedContents/{id}
Formatnya adalah cachedContents/{cachedcontent}
.
Parameter kueri
updateMask
string (FieldMask
format)
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 CachedContent
.
expiration
Union type
expiration
hanya dapat berupa salah satu dari hal berikut:expireTime
string (Timestamp
format)
Stempel waktu dalam UTC saat resource ini dianggap habis masa berlakunya. Ini selalu diberikan pada output, terlepas dari apa yang dikirim pada input.
Menggunakan RFC 3339, dengan output yang dihasilkan 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"
.
ttl
string (Duration
format)
Hanya input. TTL baru untuk resource ini, hanya input.
Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's
'. Contoh: "3.5s"
.
Contoh permintaan
Python
Node.js
Go
Shell
Isi respons
Jika berhasil, isi respons memuat instance CachedContent
.
Metode: cachedContents.delete
Menghapus resource CachedContent.
Endpoint
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Parameter jalur
name
string
Wajib. Nama resource yang merujuk ke entri cache konten Format: cachedContents/{id}
Bentuknya adalah cachedContents/{cachedcontent}
.
Isi permintaan
Isi permintaan harus kosong.
Contoh permintaan
Python
Node.js
Go
Shell
Isi respons
Jika berhasil, isi respons adalah objek JSON kosong.
REST Resource: cachedContents
- Resource: CachedContent
- Konten
- Bagian
- Blob
- FunctionCall
- FunctionResponse
- Penjadwalan
- FileData
- ExecutableCode
- Bahasa
- CodeExecutionResult
- Hasil
- VideoMetadata
- Alat
- FunctionDeclaration
- Skema
- Jenis
- Perilaku
- GoogleSearchRetrieval
- DynamicRetrievalConfig
- Mode
- CodeExecution
- GoogleSearch
- Interval
- UrlContext
- ToolConfig
- FunctionCallingConfig
- Mode
- UsageMetadata
- Metode
Resource: CachedContent
Konten yang telah diproses sebelumnya dan dapat digunakan dalam permintaan berikutnya ke GenerativeService.
Konten yang di-cache hanya dapat digunakan dengan model yang digunakan untuk membuatnya.
contents[]
object (Content
)
Opsional. Hanya input. Tidak dapat diubah. Konten yang akan di-cache.
tools[]
object (Tool
)
Opsional. Hanya input. Tidak dapat diubah. Daftar Tools
yang dapat digunakan model untuk menghasilkan respons berikutnya
createTime
string (Timestamp
format)
Hanya output. Waktu pembuatan entri cache.
Menggunakan RFC 3339, dengan output yang dihasilkan 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. Kapan entri cache terakhir kali diperbarui dalam waktu UTC.
Menggunakan RFC 3339, dengan output yang dihasilkan 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"
.
usageMetadata
object (UsageMetadata
)
Hanya output. Metadata tentang penggunaan konten yang di-cache.
expiration
Union type
expiration
hanya dapat berupa salah satu dari hal berikut:expireTime
string (Timestamp
format)
Stempel waktu dalam UTC saat resource ini dianggap habis masa berlakunya. Ini selalu diberikan pada output, terlepas dari apa yang dikirim pada input.
Menggunakan RFC 3339, dengan output yang dihasilkan 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"
.
ttl
string (Duration
format)
Hanya input. TTL baru untuk resource ini, hanya input.
Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's
'. Contoh: "3.5s"
.
name
string
Hanya output. ID. Nama resource yang merujuk ke konten yang di-cache. Format: cachedContents/{id}
displayName
string
Opsional. Tidak dapat diubah. Nama tampilan bermakna buatan pengguna dari konten yang di-cache. Maksimum 128 karakter Unicode.
model
string
Wajib. Tidak dapat diubah. Nama Model
yang akan digunakan untuk konten yang di-cache Format: models/{model}
systemInstruction
object (Content
)
Opsional. Hanya input. Tidak dapat diubah. Petunjuk sistem yang ditetapkan developer. Saat ini hanya berupa teks.
toolConfig
object (ToolConfig
)
Opsional. Hanya input. Tidak dapat diubah. Konfigurasi alat. Konfigurasi ini dibagikan untuk semua alat.
Representasi JSON |
---|
{ "contents": [ { object ( |
Konten
Jenis data terstruktur dasar yang berisi konten multi-bagian dari pesan.
Content
mencakup kolom role
yang menunjukkan produser Content
dan kolom parts
yang berisi data multi-bagian yang berisi konten giliran pesan.
parts[]
object (Part
)
Parts
yang diurutkan dan membentuk satu pesan. Bagian dapat memiliki jenis MIME yang berbeda.
role
string
Opsional. Produser konten. Harus 'user' atau 'model'.
Berguna untuk ditetapkan pada percakapan bolak-balik, jika tidak, dapat dibiarkan kosong atau tidak ditetapkan.
Representasi JSON |
---|
{
"parts": [
{
object ( |
Bagian
Jenis data yang berisi media yang merupakan bagian dari pesan Content
multi-bagian.
Part
terdiri dari data yang memiliki jenis data terkait. Part
hanya dapat berisi salah satu jenis yang diterima di Part.data
.
Part
harus memiliki jenis MIME IANA tetap yang mengidentifikasi jenis dan subjenis media jika kolom inlineData
diisi dengan byte mentah.
thought
boolean
Opsional. Menunjukkan apakah bagian tersebut diperkirakan dari model.
thoughtSignature
string (bytes format)
Opsional. Tanda tangan buram untuk pemikiran sehingga dapat digunakan kembali dalam permintaan berikutnya.
String berenkode base64.
data
Union type
data
hanya dapat berupa salah satu dari hal berikut:text
string
Teks inline.
inlineData
object (Blob
)
Byte media inline.
functionCall
object (FunctionCall
)
FunctionCall
yang diprediksi dan ditampilkan dari model yang berisi string yang merepresentasikan FunctionDeclaration.name
dengan argumen dan nilainya.
functionResponse
object (FunctionResponse
)
Output hasil FunctionCall
yang berisi string yang merepresentasikan FunctionDeclaration.name
dan objek JSON terstruktur yang berisi output apa pun dari fungsi digunakan sebagai konteks untuk model.
fileData
object (FileData
)
Data berbasis URI.
executableCode
object (ExecutableCode
)
Kode yang dihasilkan oleh model yang dimaksudkan untuk dieksekusi.
codeExecutionResult
object (CodeExecutionResult
)
Hasil eksekusi ExecutableCode
.
metadata
Union type
metadata
hanya dapat berupa salah satu dari hal berikut:videoMetadata
object (VideoMetadata
)
Opsional. Metadata video. Metadata hanya boleh ditentukan saat data video ditampilkan di inlineData atau fileData.
Representasi JSON |
---|
{ "thought": boolean, "thoughtSignature": string, // data "text": string, "inlineData": { object ( |
Blob
Byte media mentah.
Teks tidak boleh dikirim sebagai byte mentah, gunakan kolom 'text'.
mimeType
string
Jenis MIME standar IANA dari data sumber. Contoh: - image/png - image/jpeg Jika jenis MIME yang tidak didukung diberikan, error akan ditampilkan. Untuk mengetahui daftar lengkap jenis yang didukung, lihat Format file yang didukung.
data
string (bytes format)
Byte mentah untuk format media.
String berenkode base64.
Representasi JSON |
---|
{ "mimeType": string, "data": string } |
FunctionCall
FunctionCall
yang diprediksi dan ditampilkan dari model yang berisi string yang merepresentasikan FunctionDeclaration.name
dengan argumen dan nilainya.
id
string
Opsional. ID unik panggilan fungsi. Jika diisi, klien akan menjalankan functionCall
dan menampilkan respons dengan id
yang cocok.
name
string
Wajib. Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 63.
args
object (Struct
format)
Opsional. Parameter dan nilai fungsi dalam format objek JSON.
Representasi JSON |
---|
{ "id": string, "name": string, "args": { object } } |
FunctionResponse
Output hasil dari FunctionCall
yang berisi string yang merepresentasikan FunctionDeclaration.name
dan objek JSON terstruktur yang berisi output apa pun dari fungsi digunakan sebagai konteks untuk model. Kolom ini harus berisi hasil aFunctionCall
yang dibuat berdasarkan prediksi model.
id
string
Opsional. ID panggilan fungsi yang menjadi tujuan respons ini. Diisi oleh klien agar cocok dengan panggilan fungsi id
yang sesuai.
name
string
Wajib. Nama fungsi yang akan dipanggil. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 63.
response
object (Struct
format)
Wajib. Respons fungsi dalam format objek JSON.
willContinue
boolean
Opsional. Menandakan bahwa panggilan fungsi berlanjut, dan lebih banyak respons akan ditampilkan, sehingga mengubah panggilan fungsi menjadi generator. Hanya berlaku untuk panggilan fungsi NON_BLOCKING, dan diabaikan jika tidak. Jika disetel ke salah (false), respons mendatang tidak akan dipertimbangkan. Fungsi ini diizinkan untuk menampilkan response
kosong dengan willContinue=False
untuk menandakan bahwa panggilan fungsi telah selesai. Hal ini masih dapat memicu pembuatan model. Untuk menghindari pemicuan pembuatan dan menyelesaikan panggilan fungsi, setel scheduling
ke SILENT
.
scheduling
enum (Scheduling
)
Opsional. Menentukan cara respons harus dijadwalkan dalam percakapan. Hanya berlaku untuk panggilan fungsi NON_BLOCKING, diabaikan jika tidak. Default-nya adalah WHEN_IDLE.
Representasi JSON |
---|
{
"id": string,
"name": string,
"response": {
object
},
"willContinue": boolean,
"scheduling": enum ( |
Penjadwalan
Menentukan cara respons harus dijadwalkan dalam percakapan.
Enum | |
---|---|
SCHEDULING_UNSPECIFIED |
Nilai ini tidak digunakan. |
SILENT |
Hanya tambahkan hasil ke konteks percakapan, jangan mengganggu atau memicu pembuatan. |
WHEN_IDLE |
Tambahkan hasil ke konteks percakapan, dan minta untuk membuat output tanpa mengganggu pembuatan yang sedang berlangsung. |
INTERRUPT |
Menambahkan hasil ke konteks percakapan, menghentikan pembuatan yang sedang berlangsung, dan meminta untuk menghasilkan output. |
FileData
Data berbasis URI.
mimeType
string
Opsional. Jenis MIME standar IANA dari data sumber.
fileUri
string
Wajib. URI.
Representasi JSON |
---|
{ "mimeType": string, "fileUri": string } |
ExecutableCode
Kode yang dihasilkan oleh model yang dimaksudkan untuk dieksekusi, dan hasilnya dikembalikan ke model.
Hanya dibuat saat menggunakan alat CodeExecution
, yang kode akan dieksekusi secara otomatis, dan CodeExecutionResult
yang sesuai juga akan dibuat.
language
enum (Language
)
Wajib. Bahasa pemrograman code
.
code
string
Wajib. Kode yang akan dieksekusi.
Representasi JSON |
---|
{
"language": enum ( |
Language
Bahasa pemrograman yang didukung untuk kode yang dihasilkan.
Enum | |
---|---|
LANGUAGE_UNSPECIFIED |
Bahasa tidak ditentukan. Nilai ini tidak boleh digunakan. |
PYTHON |
Python >= 3.10, dengan numpy dan simpy tersedia. |
CodeExecutionResult
Hasil eksekusi ExecutableCode
.
Hanya dibuat saat menggunakan CodeExecution
, dan selalu mengikuti part
yang berisi ExecutableCode
.
outcome
enum (Outcome
)
Wajib. Hasil eksekusi kode.
output
string
Opsional. Berisi stdout saat eksekusi kode berhasil, stderr, atau deskripsi lainnya.
Representasi JSON |
---|
{
"outcome": enum ( |
Hasil
Enumerasi kemungkinan hasil eksekusi kode.
Enum | |
---|---|
OUTCOME_UNSPECIFIED |
Status tidak ditentukan. Nilai ini tidak boleh digunakan. |
OUTCOME_OK |
Eksekusi kode berhasil diselesaikan. |
OUTCOME_FAILED |
Eksekusi kode selesai, tetapi gagal. stderr harus berisi alasan. |
OUTCOME_DEADLINE_EXCEEDED |
Eksekusi kode berjalan terlalu lama, dan dibatalkan. Mungkin ada atau tidak ada output parsial. |
VideoMetadata
Metadata menjelaskan konten video input.
startOffset
string (Duration
format)
Opsional. Offset awal video.
Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's
'. Contoh: "3.5s"
.
endOffset
string (Duration
format)
Opsional. Offset akhir video.
Durasi dalam detik dengan maksimal sembilan digit pecahan, yang diakhiri dengan 's
'. Contoh: "3.5s"
.
fps
number
Opsional. Kecepatan frame video yang dikirim ke model. Jika tidak ditentukan, nilai defaultnya adalah 1.0. Rentang fps adalah (0.0, 24.0].
Representasi JSON |
---|
{ "startOffset": string, "endOffset": string, "fps": number } |
Alat
Detail alat yang dapat digunakan model untuk menghasilkan respons.
Tool
adalah bagian kode yang memungkinkan sistem berinteraksi dengan sistem eksternal untuk melakukan tindakan, atau serangkaian tindakan, di luar pengetahuan dan cakupan model.
functionDeclarations[]
object (FunctionDeclaration
)
Opsional. Daftar FunctionDeclarations
yang tersedia untuk model yang dapat digunakan untuk panggilan fungsi.
Model atau sistem tidak menjalankan fungsi. Sebagai gantinya, fungsi yang ditentukan dapat ditampilkan sebagai FunctionCall
dengan argumen ke sisi klien untuk dieksekusi. Model dapat memutuskan untuk memanggil sebagian fungsi ini dengan mengisi FunctionCall
dalam respons. Giliran percakapan berikutnya dapat berisi FunctionResponse
dengan konteks pembuatan Content.role
"function" untuk giliran model berikutnya.
googleSearchRetrieval
object (GoogleSearchRetrieval
)
Opsional. Alat pengambilan yang didukung oleh penelusuran Google.
codeExecution
object (CodeExecution
)
Opsional. Memungkinkan model menjalankan kode sebagai bagian dari pembuatan.
googleSearch
object (GoogleSearch
)
Opsional. Jenis alat GoogleSearch. Alat untuk mendukung Google Penelusuran di Model. Didukung oleh Google.
urlContext
object (UrlContext
)
Opsional. Alat untuk mendukung pengambilan konteks URL.
Representasi JSON |
---|
{ "functionDeclarations": [ { object ( |
FunctionDeclaration
Representasi terstruktur dari deklarasi fungsi seperti yang ditentukan oleh spesifikasi OpenAPI 3.03. Yang disertakan dalam deklarasi ini adalah nama dan parameter fungsi. FunctionDeclaration ini adalah representasi blok kode yang dapat digunakan sebagai Tool
oleh model dan dieksekusi oleh klien.
name
string
Wajib. Nama fungsi. Harus a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimum 63.
description
string
Wajib. Deskripsi singkat fungsi.
behavior
enum (Behavior
)
Opsional. Menentukan Perilaku fungsi. Saat ini hanya didukung oleh metode BidiGenerateContent.
parameters
object (Schema
)
Opsional. Menjelaskan parameter untuk fungsi ini. Mencerminkan Kunci string Objek Parameter Open API 3.03: nama parameter. Nama parameter peka huruf besar/kecil. Nilai Skema: Skema yang menentukan jenis yang digunakan untuk parameter.
parametersJsonSchema
value (Value
format)
Opsional. Menjelaskan parameter ke fungsi dalam format Skema JSON. Skema harus menjelaskan objek yang propertinya adalah parameter ke fungsi. Contoh:
{
"type": "object",
"properties": {
"name": { "type": "string" },
"age": { "type": "integer" }
},
"additionalProperties": false,
"required": ["name", "age"],
"propertyOrdering": ["name", "age"]
}
Kolom ini sama eksklusifnya dengan parameters
.
response
object (Schema
)
Opsional. Mendeskripsikan output dari fungsi ini dalam format Skema JSON. Mencerminkan Objek Respons Open API 3.03. Skema menentukan jenis yang digunakan untuk nilai respons fungsi.
responseJsonSchema
value (Value
format)
Opsional. Mendeskripsikan output dari fungsi ini dalam format Skema JSON. Nilai yang ditentukan oleh skema adalah nilai respons fungsi.
Kolom ini sama eksklusifnya dengan response
.
Skema
Objek Schema
memungkinkan definisi jenis data input dan output. Jenis ini dapat berupa objek, tetapi juga primitif dan array. Mewakili subset pilihan dari objek skema OpenAPI 3.0.
type
enum (Type
)
Wajib. Jenis data.
format
string
Opsional. Format data. Ini hanya digunakan untuk jenis data primitif. Format yang didukung: untuk jenis NUMBER: float, double untuk jenis INTEGER: int32, int64 untuk jenis STRING: enum, date-time
title
string
Opsional. Judul skema.
description
string
Opsional. Deskripsi singkat parameter. Hal ini dapat berisi contoh penggunaan. Deskripsi parameter dapat diformat sebagai Markdown.
nullable
boolean
Opsional. Menunjukkan apakah nilai boleh berupa null.
enum[]
string
Opsional. Kemungkinan nilai elemen Type.STRING dengan format enum. Misalnya, kita dapat menentukan Enum Direction sebagai : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}
maxItems
string (int64 format)
Opsional. Jumlah maksimum elemen untuk Type.ARRAY.
minItems
string (int64 format)
Opsional. Jumlah minimum elemen untuk Type.ARRAY.
properties
map (key: string, value: object (Schema
))
Opsional. Properti Type.OBJECT.
Objek yang berisi daftar pasangan "key": value
. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
required[]
string
Opsional. Properti wajib Type.OBJECT.
minProperties
string (int64 format)
Opsional. Jumlah minimum properti untuk Type.OBJECT.
maxProperties
string (int64 format)
Opsional. Jumlah maksimum properti untuk Type.OBJECT.
minLength
string (int64 format)
Opsional. KOLOM SKEMA UNTUK JENIS STRING Panjang minimum Type.STRING
maxLength
string (int64 format)
Opsional. Panjang maksimum Type.STRING
pattern
string
Opsional. Pola Type.STRING untuk membatasi string ke ekspresi reguler.
example
value (Value
format)
Opsional. Contoh objek. Hanya akan diisi saat objek adalah root.
anyOf[]
object (Schema
)
Opsional. Nilai harus divalidasi terhadap subskema apa pun (satu atau beberapa) dalam daftar.
propertyOrdering[]
string
Opsional. Urutan properti. Bukan kolom standar dalam spesifikasi open API. Digunakan untuk menentukan urutan properti dalam respons.
default
value (Value
format)
Opsional. Nilai default kolom. Sesuai dengan JSON Schema, kolom ini ditujukan untuk generator dokumentasi dan tidak memengaruhi validasi. Oleh karena itu, kolom ini disertakan di sini dan diabaikan agar developer yang mengirim skema dengan kolom default
tidak mendapatkan error kolom tidak dikenal.
items
object (Schema
)
Opsional. Skema elemen Type.ARRAY.
minimum
number
Opsional. KOLOM SKEMA UNTUK JENIS BILANGAN BULAT dan ANGKA Nilai minimum Jenis.BILANGAN BULAT dan Jenis.ANGKA
maximum
number
Opsional. Nilai maksimum Type.INTEGER dan Type.NUMBER
Representasi JSON |
---|
{ "type": enum ( |
Jenis
Type berisi daftar jenis data OpenAPI seperti yang ditentukan oleh https://spec.openapis.org/oas/v3.0.3#data-types
Enum | |
---|---|
TYPE_UNSPECIFIED |
Tidak ditentukan, tidak boleh digunakan. |
STRING |
Jenis string. |
NUMBER |
Jenis angka. |
INTEGER |
Jenis bilangan bulat. |
BOOLEAN |
Jenis Boolean. |
ARRAY |
Jenis array. |
OBJECT |
Jenis objek. |
NULL |
Jenis null. |
Perilaku
Menentukan perilaku fungsi. Default-nya adalah BLOCKING
.
Enum | |
---|---|
UNSPECIFIED |
Nilai ini tidak digunakan. |
BLOCKING |
Jika disetel, sistem akan menunggu untuk menerima respons fungsi sebelum melanjutkan percakapan. |
NON_BLOCKING |
Jika disetel, sistem tidak akan menunggu untuk menerima respons fungsi. Sebagai gantinya, fungsi ini akan mencoba menangani respons fungsi saat tersedia sambil mempertahankan percakapan antara pengguna dan model. |
GoogleSearchRetrieval
Alat untuk mengambil data web publik untuk grounding, yang didukung oleh Google.
dynamicRetrievalConfig
object (DynamicRetrievalConfig
)
Menentukan konfigurasi pengambilan dinamis untuk sumber tertentu.
Representasi JSON |
---|
{
"dynamicRetrievalConfig": {
object ( |
DynamicRetrievalConfig
Menjelaskan opsi untuk menyesuaikan pengambilan dinamis.
mode
enum (Mode
)
Mode prediksi yang akan digunakan dalam pengambilan dinamis.
dynamicThreshold
number
Nilai minimum yang akan digunakan dalam pengambilan dinamis. Jika tidak disetel, nilai default sistem akan digunakan.
Representasi JSON |
---|
{
"mode": enum ( |
Mode
Mode prediksi yang akan digunakan dalam pengambilan dinamis.
Enum | |
---|---|
MODE_UNSPECIFIED |
Selalu memicu pengambilan. |
MODE_DYNAMIC |
Jalankan pengambilan hanya jika sistem memutuskan bahwa hal itu diperlukan. |
CodeExecution
Jenis ini tidak memiliki kolom.
Alat yang menjalankan kode yang dihasilkan oleh model, dan otomatis menampilkan hasilnya ke model.
Lihat juga ExecutableCode
dan CodeExecutionResult
yang hanya dibuat saat menggunakan alat ini.
GoogleSearch
Jenis alat GoogleSearch. Alat untuk mendukung Google Penelusuran di Model. Didukung oleh Google.
timeRangeFilter
object (Interval
)
Opsional. Memfilter hasil penelusuran ke rentang waktu tertentu. Jika pelanggan menetapkan waktu mulai, mereka harus menetapkan waktu berakhir (dan sebaliknya).
Representasi JSON |
---|
{
"timeRangeFilter": {
object ( |
Interval
Mewakili interval waktu, dienkode sebagai awal Stempel waktu (inklusif) dan akhir Stempel waktu (eksklusif).
Awal harus kurang dari atau sama dengan akhir. Jika waktu mulai sama dengan waktu berakhir, intervalnya kosong (tidak cocok dengan waktu apa pun). Jika awal dan akhir tidak ditentukan, interval akan cocok dengan waktu apa pun.
startTime
string (Timestamp
format)
Opsional. Awal interval inklusif.
Jika ditentukan, Stempel Waktu yang cocok dengan interval ini harus sama dengan atau setelah awal.
Menggunakan RFC 3339, dengan output yang dihasilkan 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)
Opsional. Akhir interval eksklusif.
Jika ditentukan, Stempel Waktu yang cocok dengan interval ini harus sebelum akhir.
Menggunakan RFC 3339, dengan output yang dihasilkan 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"
.
Representasi JSON |
---|
{ "startTime": string, "endTime": string } |
UrlContext
Jenis ini tidak memiliki kolom.
Alat untuk mendukung pengambilan konteks URL.
ToolConfig
Konfigurasi Alat yang berisi parameter untuk menentukan penggunaan Tool
dalam permintaan.
functionCallingConfig
object (FunctionCallingConfig
)
Opsional. Konfigurasi pemanggilan fungsi.
Representasi JSON |
---|
{
"functionCallingConfig": {
object ( |
FunctionCallingConfig
Konfigurasi untuk menentukan perilaku panggilan fungsi.
mode
enum (Mode
)
Opsional. Menentukan mode saat panggilan fungsi harus dijalankan. Jika tidak ditentukan, nilai default akan disetel ke AUTO.
allowedFunctionNames[]
string
Opsional. Sekumpulan nama fungsi yang, jika diberikan, akan membatasi fungsi yang akan dipanggil model.
Kolom ini hanya boleh ditetapkan jika Mode adalah ANY. Nama fungsi harus cocok dengan [FunctionDeclaration.name]. Dengan mode yang ditetapkan ke ANY, model akan memprediksi panggilan fungsi dari kumpulan nama fungsi yang diberikan.
Representasi JSON |
---|
{
"mode": enum ( |
Mode
Menentukan perilaku eksekusi untuk panggilan fungsi dengan menentukan mode eksekusi.
Enum | |
---|---|
MODE_UNSPECIFIED |
Mode panggilan fungsi tidak ditentukan. Nilai ini tidak boleh digunakan. |
AUTO |
Perilaku model default, model memutuskan untuk memprediksi panggilan fungsi atau respons bahasa alami. |
ANY |
Model dibatasi untuk selalu memprediksi panggilan fungsi saja. Jika "allowedFunctionNames" ditetapkan, panggilan fungsi yang diprediksi akan dibatasi ke salah satu "allowedFunctionNames", jika tidak, panggilan fungsi yang diprediksi akan menjadi salah satu "functionDeclarations" yang diberikan. |
NONE |
Model tidak akan memprediksi panggilan fungsi apa pun. Perilaku model sama seperti saat tidak meneruskan deklarasi fungsi apa pun. |
VALIDATED |
Model memutuskan untuk memprediksi panggilan fungsi atau respons bahasa alami, tetapi akan memvalidasi panggilan fungsi dengan decoding yang dibatasi. |
UsageMetadata
Metadata tentang penggunaan konten yang di-cache.
totalTokenCount
integer
Jumlah total token yang digunakan oleh konten yang di-cache.
Representasi JSON |
---|
{ "totalTokenCount": integer } |