La memorizzazione nella cache del contesto ti consente di salvare e riutilizzare i token di input precalcolati che vuoi utilizzare ripetutamente, ad esempio quando poni domande diverse sullo stesso file multimediale. Ciò può comportare un risparmio di costi e velocità, a seconda dell'utilizzo. Per un'introduzione dettagliata, consulta la guida alla memorizzazione nella cache del contesto.
Metodo: cachedContents.create
Crea una risorsa CachedContent.
Endpoint
posthttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di CachedContent.
contents[]
object (Content)
Facoltativo. Solo input. Immutabile. I contenuti da memorizzare nella cache.
tools[]
object (Tool)
Facoltativo. Solo input. Immutabile. Un elenco di Tools che il modello può utilizzare per generare la risposta successiva
expiration
Union type
expiration può essere solo uno dei seguenti tipi:expireTime
string (Timestamp format)
Timestamp in UTC di quando questa risorsa è considerata scaduta. Viene sempre fornito nell'output, anche se non inviato nell'input.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Solo input. Nuovo TTL per questa risorsa, solo input.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
displayName
string
Facoltativo. Immutabile. Il nome visualizzato significativo generato dall'utente dei contenuti memorizzati nella cache. Massimo 128 caratteri Unicode.
model
string
Obbligatorio. Immutabile. Il nome di Model da utilizzare per i contenuti memorizzati nella cache. Formato: models/{model}
systemInstruction
object (Content)
Facoltativo. Solo input. Immutabile. Istruzione di sistema impostata dallo sviluppatore. Al momento solo testo.
toolConfig
object (ToolConfig)
Facoltativo. Solo input. Immutabile. Configurazione dello strumento Questa configurazione è condivisa per tutti gli strumenti.
Esempio di richiesta
Base
Python
Node.js
Go
Conchiglia
Nome mittente
Python
Node.js
Go
Da una chat
Python
Node.js
Go
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di CachedContent appena creata.
Metodo: cachedContents.list
Elenca CachedContents.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Parametri di query
pageSize
integer
Facoltativo. Il numero massimo di contenuti memorizzati nella cache da restituire. Il servizio potrebbe restituire un numero inferiore a questo valore. Se non specificato, verrà restituito un numero predefinito (inferiore al massimo) di elementi. Il valore massimo è 1000; i valori superiori a 1000 verranno forzati a 1000.
pageToken
string
Facoltativo. Un token di pagina ricevuto da una precedente chiamata cachedContents.list. Forniscilo per recuperare la pagina successiva.
Durante la paginazione, tutti gli altri parametri forniti a cachedContents.list devono corrispondere alla chiamata che ha fornito il token di pagina.
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Corpo della risposta
Risposta con l'elenco CachedContents.
In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:
cachedContents[]
object (CachedContent)
Elenco dei contenuti memorizzati nella cache.
nextPageToken
string
Un token, che può essere inviato come pageToken per recuperare la pagina successiva. Se questo campo viene omesso, non verranno visualizzate altre pagine.
| Rappresentazione JSON |
|---|
{
"cachedContents": [
{
object ( |
Metodo: cachedContents.get
- Endpoint
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
Legge la risorsa CachedContent.
Endpoint
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Parametri del percorso
name
string
Obbligatorio. Il nome della risorsa che fa riferimento alla voce della cache dei contenuti. Formato: cachedContents/{id}. Assume la forma cachedContents/{cachedcontent}.
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Esempio di richiesta
Python
Node.js
Go
Conchiglia
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di CachedContent.
Metodo: cachedContents.patch
- Endpoint
- Parametri del percorso
- Parametri di query
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
Aggiorna la risorsa CachedContent (solo la scadenza è aggiornabile).
Endpoint
patchhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
Parametri del percorso
cachedContent.name
string
Solo output. Identificatore. Il nome della risorsa che fa riferimento ai contenuti memorizzati nella cache. Formato: cachedContents/{id}. Assume la forma cachedContents/{cachedcontent}.
Parametri di query
updateMask
string (FieldMask format)
L'elenco dei campi da aggiornare.
Si tratta di un elenco separato da virgole di nomi completi dei campi. Esempio: "user.displayName,photo".
Corpo della richiesta
Il corpo della richiesta contiene un'istanza di CachedContent.
expiration
Union type
expiration può essere solo uno dei seguenti tipi:expireTime
string (Timestamp format)
Timestamp in UTC di quando questa risorsa è considerata scaduta. Viene sempre fornito nell'output, anche se non inviato nell'input.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Solo input. Nuovo TTL per questa risorsa, solo input.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
Esempio di richiesta
Python
Node.js
Go
Conchiglia
Corpo della risposta
In caso di esito positivo, il corpo della risposta contiene un'istanza di CachedContent.
Metodo: cachedContents.delete
- Endpoint
- Parametri del percorso
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- Richiesta di esempio
Elimina la risorsa CachedContent.
Endpoint
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Parametri del percorso
name
string
Obbligatorio. Il nome della risorsa che fa riferimento alla voce della cache dei contenuti. Formato: cachedContents/{id}. Ha il formato cachedContents/{cachedcontent}.
Corpo della richiesta
Il corpo della richiesta deve essere vuoto.
Esempio di richiesta
Python
Node.js
Go
Conchiglia
Corpo della risposta
In caso di esito positivo, il corpo della risposta è un oggetto JSON vuoto.
Risorsa REST: cachedContents
- Risorsa: CachedContent
- ToolConfig
- FunctionCallingConfig
- Modalità
- RetrievalConfig
- LatLng
- UsageMetadata
- Metodi
Risorsa: CachedContent
Contenuti preelaborati che possono essere utilizzati nella richiesta successiva a GenerativeService.
I contenuti memorizzati nella cache possono essere utilizzati solo con il modello per cui sono stati creati.
contents[]
object (Content)
Facoltativo. Solo input. Immutabile. I contenuti da memorizzare nella cache.
tools[]
object (Tool)
Facoltativo. Solo input. Immutabile. Un elenco di Tools che il modello può utilizzare per generare la risposta successiva
createTime
string (Timestamp format)
Solo output. L'ora di creazione della voce della cache.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
updateTime
string (Timestamp format)
Solo output. Data e ora dell'ultimo aggiornamento della voce della cache in formato UTC.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
usageMetadata
object (UsageMetadata)
Solo output. Metadati sull'utilizzo dei contenuti memorizzati nella cache.
expiration
Union type
expiration può essere solo uno dei seguenti tipi:expireTime
string (Timestamp format)
Timestamp in UTC di quando questa risorsa è considerata scaduta. Viene sempre fornito nell'output, anche se non inviato nell'input.
Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Solo input. Nuovo TTL per questa risorsa, solo input.
Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
name
string
Solo output. Identificatore. Il nome della risorsa che fa riferimento ai contenuti memorizzati nella cache. Formato: cachedContents/{id}
displayName
string
Facoltativo. Immutabile. Il nome visualizzato significativo generato dall'utente dei contenuti memorizzati nella cache. Massimo 128 caratteri Unicode.
model
string
Obbligatorio. Immutabile. Il nome di Model da utilizzare per i contenuti memorizzati nella cache. Formato: models/{model}
systemInstruction
object (Content)
Facoltativo. Solo input. Immutabile. Istruzione di sistema impostata dallo sviluppatore. Al momento solo testo.
toolConfig
object (ToolConfig)
Facoltativo. Solo input. Immutabile. Configurazione dello strumento Questa configurazione è condivisa per tutti gli strumenti.
| Rappresentazione JSON |
|---|
{ "contents": [ { object ( |
ToolConfig
La configurazione dello strumento contenente i parametri per specificare l'utilizzo di Tool nella richiesta.
functionCallingConfig
object (FunctionCallingConfig)
Facoltativo. Configurazione della chiamata di funzione.
retrievalConfig
object (RetrievalConfig)
Facoltativo. Configurazione del recupero.
includeServerSideToolInvocations
boolean
Facoltativo. Se è true, la risposta dell'API includerà le chiamate e le risposte agli strumenti lato server all'interno del messaggio Content. In questo modo i client possono osservare le interazioni con gli strumenti del server.
| Rappresentazione JSON |
|---|
{ "functionCallingConfig": { object ( |
FunctionCallingConfig
Configurazione per specificare il comportamento della chiamata di funzione.
mode
enum (Mode)
Facoltativo. Specifica la modalità di esecuzione della chiamata di funzione. Se non è specificato, il valore predefinito sarà AUTO.
allowedFunctionNames[]
string
Facoltativo. Un insieme di nomi di funzioni che, se forniti, limitano le funzioni che il modello chiamerà.
Questa impostazione deve essere configurata solo quando la modalità è ANY o VALIDATED. I nomi delle funzioni devono corrispondere a [FunctionDeclaration.name]. Se impostato, il modello prevede una chiamata di funzione solo dai nomi di funzione consentiti.
| Rappresentazione JSON |
|---|
{
"mode": enum ( |
Modalità
Definisce il comportamento di esecuzione per la chiamata di funzioni definendo la modalità di esecuzione.
| Enum | |
|---|---|
MODE_UNSPECIFIED |
Modalità chiamata di funzione non specificata. Questo valore non deve essere utilizzato. |
AUTO |
Comportamento predefinito del modello: il modello decide di prevedere una chiamata di funzione o una risposta in linguaggio naturale. |
ANY |
Il modello è vincolato a prevedere sempre solo una chiamata di funzione. Se sono impostati "allowedFunctionNames", la chiamata di funzione prevista sarà limitata a uno qualsiasi degli "allowedFunctionNames", altrimenti la chiamata di funzione prevista sarà una qualsiasi delle "functionDeclarations" fornite. |
NONE |
Il modello non prevede alcuna chiamata di funzione. Il comportamento del modello è lo stesso di quando non vengono passate dichiarazioni di funzioni. |
VALIDATED |
Il modello decide di prevedere una chiamata di funzione o una risposta in linguaggio naturale, ma convalida le chiamate di funzione con la decodifica vincolata. Se sono impostati "allowedFunctionNames", la chiamata di funzione prevista sarà limitata a uno qualsiasi degli "allowedFunctionNames", altrimenti la chiamata di funzione prevista sarà una qualsiasi delle "functionDeclarations" fornite. |
RetrievalConfig
Configurazione del recupero.
latLng
object (LatLng)
Facoltativo. La posizione dell'utente.
languageCode
string
Facoltativo. Il codice lingua dell'utente. Codice lingua per i contenuti. Utilizza i tag di lingua definiti da BCP47.
| Rappresentazione JSON |
|---|
{
"latLng": {
object ( |
LatLng
Un oggetto che rappresenta una coppia latitudine/longitudine. Questi valori sono espressi come una coppia di numeri double per rappresentare i gradi di latitudine e longitudine. Se non diversamente specificato, questo oggetto deve essere conforme allo standard WGS84. I valori devono rientrare negli intervalli normalizzati.
latitude
number
La latitudine in gradi. Deve essere compreso nell'intervallo [-90,0, +90,0].
longitude
number
La longitudine in gradi. Deve essere compreso nell'intervallo [-180.0, +180.0].
| Rappresentazione JSON |
|---|
{ "latitude": number, "longitude": number } |
UsageMetadata
Metadati sull'utilizzo dei contenuti memorizzati nella cache.
totalTokenCount
integer
Numero totale di token utilizzati dai contenuti memorizzati nella cache.
| Rappresentazione JSON |
|---|
{ "totalTokenCount": integer } |