Mit dem Kontext-Caching können Sie vorab berechnete Eingabe-Tokens speichern und wiederverwenden, die Sie wiederholt verwenden möchten, z. B. wenn Sie verschiedene Fragen zur selben Media-Datei stellen. Je nach Nutzung können so Kosten und Zeit gespart werden. Eine detaillierte Einführung finden Sie im Leitfaden Kontext-Caching.
Methode: cachedContents.create
Erstellt eine CachedContent-Ressource.
Endpunkt
posthttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
Anfragetext
Der Anfragetext enthält eine Instanz von CachedContent.
contents[]
object (Content)
Optional. Nur Eingabe. Nicht veränderbar. Die Inhalte, die im Cache gespeichert werden sollen.
tools[]
object (Tool)
Optional. Nur Eingabe. Nicht veränderbar. Eine Liste der Tools, die das Modell zum Generieren der nächsten Antwort verwenden kann
expiration
Union type
expiration ist nur einer der folgenden Werte zulässig:expireTime
string (Timestamp format)
Der Zeitstempel in UTC, der angibt, wann diese Ressource als abgelaufen gilt. Dies wird immer bei der Ausgabe angegeben, ungeachtet dessen, was bei der Eingabe gesendet wurde.
Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Nur Eingabe. Neue TTL für diese Ressource, nur Eingabe.
Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
displayName
string
Optional. Nicht veränderbar. Der von Nutzern erstellte aussagekräftige Anzeigename der im Cache gespeicherten Inhalte. Maximal 128 Unicode-Zeichen.
model
string
Erforderlich. Nicht veränderbar. Der Name des Model, der für zwischengespeicherte Inhalte verwendet werden soll. Format: models/{model}
systemInstruction
object (Content)
Optional. Nur Eingabe. Nicht veränderbar. Vom Entwickler festgelegte Systemanweisung. Derzeit nur Text.
toolConfig
object (ToolConfig)
Optional. Nur Eingabe. Nicht veränderbar. Toolkonfiguration Diese Konfiguration wird für alle Tools freigegeben.
Beispielanfrage
Einfach
Python
Node.js
Ok
Muschel
Name des Absenders
Python
Node.js
Ok
Über einen Chat
Python
Node.js
Ok
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine neu erstellte Instanz von CachedContent.
Methode: cachedContents.list
Listet CachedContents auf.
Endpunkt
gethttps: / /generativelanguage.googleapis.com /v1beta /cachedContents
>
>
>
Suchparameter
pageSize
integer
Optional. Die maximale Anzahl der zurückzugebenden gecachten Inhalte. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Falls nicht angegeben, wird eine Standardanzahl von Elementen (unter dem Maximum) zurückgegeben. Der Höchstwert beträgt 1.000. Werte über 1.000 werden implizit auf 1.000 umgewandelt.
pageToken
string
Optional. Ein Seitentoken, das von einem vorherigen cachedContents.list-Aufruf empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.
Beim Paginieren müssen alle anderen für cachedContents.list bereitgestellten Parameter mit dem Aufruf übereinstimmen, der das Seitentoken bereitgestellt hat.
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Antwort mit der Liste „CachedContents“.
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
cachedContents[]
object (CachedContent)
Liste der im Cache gespeicherten Inhalte.
nextPageToken
string
Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.
| JSON-Darstellung |
|---|
{
"cachedContents": [
{
object ( |
Methode: cachedContents.get
Liest die CachedContent-Ressource.
Endpunkt
gethttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
>
>
>
Pfadparameter
name
string
Erforderlich. Der Ressourcenname, der auf den Inhaltscache-Eintrag verweist. Format: cachedContents/{id}. Sie nimmt die Form cachedContents/{cachedcontent} an.
Anfragetext
Der Anfragetext muss leer sein.
Beispielanfrage
Python
Node.js
Ok
Muschel
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von CachedContent.
Methode: cachedContents.patch
Aktualisiert die CachedContent-Ressource (nur das Ablaufdatum kann aktualisiert werden).
Endpunkt
patchhttps: / /generativelanguage.googleapis.com /v1beta /{cachedContent.name=cachedContents /*}
>
>
PATCH https://generativelanguage.googleapis.com/v1beta/{cachedContent.name=cachedContents/*}
Pfadparameter
cachedContent.name
string
Nur Ausgabe. ID. Der Ressourcenname, der sich auf die im Cache gespeicherten Inhalte bezieht. Format: cachedContents/{id}. Sie nimmt die Form cachedContents/{cachedcontent} an.
Suchparameter
updateMask
string (FieldMask format)
Die Liste der zu aktualisierenden Felder.
Dies ist eine kommagetrennte Liste vollständig qualifizierter Feldnamen. Beispiel: "user.displayName,photo".
Anfragetext
Der Anfragetext enthält eine Instanz von CachedContent.
expiration
Union type
expiration ist nur einer der folgenden Werte zulässig:expireTime
string (Timestamp format)
Der Zeitstempel in UTC, der angibt, wann diese Ressource als abgelaufen gilt. Dies wird immer bei der Ausgabe angegeben, ungeachtet dessen, was bei der Eingabe gesendet wurde.
Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Nur Eingabe. Neue TTL für diese Ressource, nur Eingabe.
Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
Beispielanfrage
Python
Node.js
Ok
Muschel
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von CachedContent.
Methode: cachedContents.delete
Löscht die CachedContent-Ressource.
Endpunkt
deletehttps: / /generativelanguage.googleapis.com /v1beta /{name=cachedContents /*}
Pfadparameter
name
string
Erforderlich. Der Ressourcenname, der auf den Inhaltscache-Eintrag verweist. Format: cachedContents/{id}. Er hat das Format cachedContents/{cachedcontent}.
Anfragetext
Der Anfragetext muss leer sein.
Beispielanfrage
Python
Node.js
Ok
Muschel
Antworttext
Wenn der Vorgang erfolgreich abgeschlossen wurde, ist der Antworttext ein leeres JSON-Objekt.
REST-Ressource: cachedContents
- Ressource: CachedContent
- ToolConfig
- FunctionCallingConfig
- Modus
- RetrievalConfig
- LatLng
- UsageMetadata
- Methoden
Ressource: CachedContent
Inhalte, die vorverarbeitet wurden und in nachfolgenden Anfragen an GenerativeService verwendet werden können.
Zwischengespeicherte Inhalte können nur mit dem Modell verwendet werden, für das sie erstellt wurden.
contents[]
object (Content)
Optional. Nur Eingabe. Nicht veränderbar. Die Inhalte, die im Cache gespeichert werden sollen.
tools[]
object (Tool)
Optional. Nur Eingabe. Nicht veränderbar. Eine Liste der Tools, die das Modell zum Generieren der nächsten Antwort verwenden kann
createTime
string (Timestamp format)
Nur Ausgabe. Erstellungszeitpunkt des Cache-Eintrags.
Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime
string (Timestamp format)
Nur Ausgabe. Wann der Cacheeintrag zuletzt in UTC aktualisiert wurde.
Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
usageMetadata
object (UsageMetadata)
Nur Ausgabe. Metadaten zur Nutzung der im Cache gespeicherten Inhalte.
expiration
Union type
expiration ist nur einer der folgenden Werte zulässig:expireTime
string (Timestamp format)
Der Zeitstempel in UTC, der angibt, wann diese Ressource als abgelaufen gilt. Dies wird immer bei der Ausgabe angegeben, ungeachtet dessen, was bei der Eingabe gesendet wurde.
Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
ttl
string (Duration format)
Nur Eingabe. Neue TTL für diese Ressource, nur Eingabe.
Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".
name
string
Nur Ausgabe. ID. Der Ressourcenname, der sich auf die im Cache gespeicherten Inhalte bezieht. Format: cachedContents/{id}
displayName
string
Optional. Nicht veränderbar. Der von Nutzern erstellte aussagekräftige Anzeigename der im Cache gespeicherten Inhalte. Maximal 128 Unicode-Zeichen.
model
string
Erforderlich. Nicht veränderbar. Der Name des Model, der für zwischengespeicherte Inhalte verwendet werden soll. Format: models/{model}
systemInstruction
object (Content)
Optional. Nur Eingabe. Nicht veränderbar. Vom Entwickler festgelegte Systemanweisung. Derzeit nur Text.
toolConfig
object (ToolConfig)
Optional. Nur Eingabe. Nicht veränderbar. Toolkonfiguration Diese Konfiguration wird für alle Tools freigegeben.
| JSON-Darstellung |
|---|
{ "contents": [ { object ( |
ToolConfig
Die Tool-Konfiguration mit Parametern zur Angabe der Tool-Verwendung in der Anfrage.
functionCallingConfig
object (FunctionCallingConfig)
Optional. Konfiguration für Funktionsaufrufe.
retrievalConfig
object (RetrievalConfig)
Optional. Konfiguration für den Abruf.
includeServerSideToolInvocations
boolean
Optional. Wenn „true“, enthält die API-Antwort die serverseitigen Tool-Aufrufe und ‑Antworten in der Content-Nachricht. So können Clients die Tool-Interaktionen des Servers beobachten.
| JSON-Darstellung |
|---|
{ "functionCallingConfig": { object ( |
FunctionCallingConfig
Konfiguration zum Angeben des Verhaltens von Funktionsaufrufen.
mode
enum (Mode)
Optional. Gibt den Modus an, in dem Funktionsaufrufe ausgeführt werden sollen. Wenn nicht angegeben, wird der Standardwert auf AUTO gesetzt.
allowedFunctionNames[]
string
Optional. Eine Reihe von Funktionsnamen, die die vom Modell aufgerufenen Funktionen einschränken.
Sollte nur festgelegt werden, wenn der Modus „ANY“ oder „VALIDATED“ ist. Funktionsnamen sollten mit [FunctionDeclaration.name] übereinstimmen. Wenn diese Option festgelegt ist, sagt das Modell nur Funktionsaufrufe mit zulässigen Funktionsnamen voraus.
| JSON-Darstellung |
|---|
{
"mode": enum ( |
Modus
Definiert das Ausführungsverhalten für Funktionsaufrufe, indem der Ausführungsmodus festgelegt wird.
| Enums | |
|---|---|
MODE_UNSPECIFIED |
Nicht angegebener Modus für Funktionsaufrufe. Dieser Wert sollte nicht verwendet werden. |
AUTO |
Standardmäßiges Modellverhalten: Das Modell entscheidet, ob ein Funktionsaufruf oder eine Antwort in natürlicher Sprache vorhergesagt werden soll. |
ANY |
Das Modell ist darauf beschränkt, immer nur einen Funktionsaufruf vorherzusagen. Wenn „allowedFunctionNames“ festgelegt ist, wird der vorhergesagte Funktionsaufruf auf einen der „allowedFunctionNames“ beschränkt. Andernfalls ist der vorhergesagte Funktionsaufruf einer der bereitgestellten „functionDeclarations“. |
NONE |
Das Modell sagt keinen Funktionsaufruf voraus. Das Modellverhalten ist dasselbe wie ohne Funktionsdeklarationen. |
VALIDATED |
Das Modell entscheidet, ob ein Funktionsaufruf oder eine Antwort in natürlicher Sprache vorhergesagt werden soll, validiert Funktionsaufrufe aber mit eingeschränkter Dekodierung. Wenn „allowedFunctionNames“ festgelegt ist, wird der vorhergesagte Funktionsaufruf auf einen der „allowedFunctionNames“ beschränkt. Andernfalls ist der vorhergesagte Funktionsaufruf einer der bereitgestellten „functionDeclarations“. |
RetrievalConfig
Konfiguration für den Abruf.
latLng
object (LatLng)
Optional. Der Standort des Nutzers.
languageCode
string
Optional. Der Sprachcode des Nutzers. Sprachcode für Inhalte. Verwenden Sie Sprachentags, wie von BCP47 definiert.
| JSON-Darstellung |
|---|
{
"latLng": {
object ( |
LatLng
Ein Objekt, das ein Paar aus Breiten- und Längengrad darstellt. Es wird als Paar aus Werten vom Typ „Double“ (Breiten- und Längengrad) ausgedrückt. Sofern nicht anders angegeben, muss dieses Objekt dem WGS84-Standard entsprechen. Die Werte müssen innerhalb normalisierter Bereiche liegen.
latitude
number
Der Breitengrad in Grad. Er muss im Bereich [-90,0, +90,0] liegen.
longitude
number
Der Längengrad in Grad. Er muss im Bereich [-180,0, +180,0] liegen.
| JSON-Darstellung |
|---|
{ "latitude": number, "longitude": number } |
UsageMetadata
Metadaten zur Nutzung der im Cache gespeicherten Inhalte.
totalTokenCount
integer
Gesamtzahl der Tokens, die durch die Inhalte im Cache verbraucht werden.
| JSON-Darstellung |
|---|
{ "totalTokenCount": integer } |