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 waktu, bergantung pada penggunaannya. Untuk pengantar mendetail, lihat panduan Penyimpanan dalam 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 dikirimkan pada input.
Menggunakan RFC 3339 yang outputnya 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 akan 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, yang diterima dari panggilan cachedContents.list sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.
Saat melakukan penomoran halaman, semua parameter lain yang disediakan untuk cachedContents.list harus sesuai dengan panggilan yang memberikan 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 dikirimkan pada input.
Menggunakan RFC 3339 yang outputnya 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} Berbentuk 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
- ToolConfig
- FunctionCallingConfig
- Mode
- RetrievalConfig
- LatLng
- 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 yang outputnya 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 diperbarui dalam waktu UTC.
Menggunakan RFC 3339 yang outputnya 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 dikirimkan pada input.
Menggunakan RFC 3339 yang outputnya 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 ( |
ToolConfig
Konfigurasi Alat yang berisi parameter untuk menentukan penggunaan Tool dalam permintaan.
functionCallingConfig
object (FunctionCallingConfig)
Opsional. Konfigurasi panggilan fungsi.
retrievalConfig
object (RetrievalConfig)
Opsional. Konfigurasi pengambilan.
includeServerSideToolInvocations
boolean
Opsional. Jika benar (true), respons API akan menyertakan panggilan dan respons alat sisi server dalam pesan Content. Hal ini memungkinkan klien mengamati interaksi alat server.
| Representasi JSON |
|---|
{ "functionCallingConfig": { object ( |
FunctionCallingConfig
Konfigurasi untuk menentukan perilaku panggilan fungsi.
mode
enum (Mode)
Opsional. Menentukan mode saat panggilan fungsi harus dieksekusi. Jika tidak ditentukan, nilai default akan disetel ke AUTO.
allowedFunctionNames[]
string
Opsional. Kumpulan nama fungsi yang, jika diberikan, akan membatasi fungsi yang akan dipanggil model.
Kolom ini hanya boleh ditetapkan jika Mode adalah ANY atau VALIDATED. Nama fungsi harus cocok dengan [FunctionDeclaration.name]. Jika disetel, model akan memprediksi panggilan fungsi hanya dari nama fungsi yang diizinkan.
| 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 dari "allowedFunctionNames", jika tidak, panggilan fungsi yang diprediksi akan menjadi salah satu dari "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 terbatas. 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. |
RetrievalConfig
LatLng
Objek yang merepresentasikan pasangan garis lintang/bujur. Objek ini dinyatakan sebagai pasangan nilai ganda untuk mewakili derajat lintang dan derajat bujur. Kecuali jika ditentukan lain, objek ini harus sesuai dengan standar WGS84. Nilai harus berada dalam rentang yang dinormalisasi.
latitude
number
Lintang dalam derajat. Harus dalam rentang [-90.0, +90.0].
longitude
number
Bujur dalam derajat. Harus dalam rentang [-180.0, +180.0].
| Representasi JSON |
|---|
{ "latitude": number, "longitude": number } |
UsageMetadata
Metadata tentang penggunaan konten yang di-cache.
totalTokenCount
integer
Jumlah total token yang digunakan konten yang di-cache.
| Representasi JSON |
|---|
{ "totalTokenCount": integer } |