- Ressource: CachedContent
- Inhalt
- Teil
- Blob
- FunctionCall
- FunctionResponse
- FileData
- Tool
- FunctionDeclaration (Funktionsdeklaration)
- Schema
- Typ
- ToolConfig
- FunctionCallingConfig
- Mode
- UsageMetadata
- Methoden
Ressource: CachedContent
Inhalte, die bereits vorverarbeitet wurden und in nachfolgenden Anfragen an GenerativeService verwendet werden können.
Im Cache gespeicherte Inhalte können nur mit dem Modell verwendet werden, für das sie erstellt wurden.
JSON-Darstellung |
---|
{ "contents": [ { object ( |
Felder | |
---|---|
contents[] |
Optional. Nur Eingabe Nicht veränderbar. Der im Cache zu speichernde Inhalt. |
tools[] |
Optional. Nur Eingabe Nicht veränderbar. Eine Liste von |
createTime |
Nur Ausgabe. Erstellungszeit des Cache-Eintrags. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
updateTime |
Nur Ausgabe. Zeitpunkt der letzten Aktualisierung des Cache-Eintrags in UTC. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
usageMetadata |
Nur Ausgabe. Metadaten zur Nutzung der im Cache gespeicherten Inhalte. |
Union-Feld expiration . Gibt an, wann diese Ressource abläuft. Für expiration ist nur einer der folgenden Werte zulässig: |
|
expireTime |
Der Zeitstempel in UTC, der angibt, wann diese Ressource als abgelaufen gilt. Dies wird immer bei der Ausgabe angegeben, unabhängig davon, was bei der Eingabe gesendet wurde. Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: |
ttl |
Nur Eingabe Neue TTL für diese Ressource, nur Eingabe. Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit " |
name |
Optional. Kennung. Der Ressourcenname, der sich auf den im Cache gespeicherten Inhalt bezieht. Format: |
displayName |
Optional. Nicht veränderbar. Der vom Nutzer generierte aussagekräftige Anzeigename des im Cache gespeicherten Inhalts. Maximal 128 Unicode-Zeichen. |
model |
Erforderlich. Nicht veränderbar. Der Name der |
systemInstruction |
Optional. Nur Eingabe Nicht veränderbar. Systemanweisung für Entwicklersatz. Derzeit nur Text. |
toolConfig |
Optional. Nur Eingabe Nicht veränderbar. Toolkonfiguration. Diese Konfiguration wird für alle Tools freigegeben. |
Inhalte
Der grundlegende strukturierte Datentyp, der den mehrteiligen Inhalt einer Nachricht enthält.
Ein Content
enthält ein role
-Feld, das den Ersteller der Content
angibt, und ein parts
-Feld mit mehrteiligen Daten, die den Inhalt der Nachrichtensendung enthalten.
JSON-Darstellung |
---|
{
"parts": [
{
object ( |
Felder | |
---|---|
parts[] |
|
role |
Optional. Der Produzent des Contents. Muss entweder „user“ oder „model“ sein. Nützlich zum Festlegen für Unterhaltungen mit mehreren Schritten. Andernfalls können Sie das Feld leer lassen oder die Festlegung aufheben. |
Teil
Datentyp mit Medien, der Teil einer mehrteiligen Content
-Nachricht ist.
Eine Part
besteht aus Daten, denen ein Datentyp zugeordnet ist. Ein Part
kann nur einen der akzeptierten Typen in Part.data
enthalten.
Ein Part
muss einen festen IANA-MIME-Typ haben, der den Typ und Untertyp des Mediums identifiziert, wenn das Feld inlineData
mit Rohbyte gefüllt ist.
JSON-Darstellung |
---|
{ // Union field |
Felder | |
---|---|
Union-Feld Für |
|
text |
Inline-Text |
inlineData |
Inline-Mediabyte. |
functionCall |
Eine vorhergesagte |
functionResponse |
Die Ergebnisausgabe einer |
fileData |
URI-basierte Daten. |
Blob
Roh-Mediabyte.
Text sollte nicht als Rohbyte gesendet werden. Verwenden Sie stattdessen das Feld "Text".
JSON-Darstellung |
---|
{ "mimeType": string, "data": string } |
Felder | |
---|---|
mimeType |
Der IANA-Standard-MIME-Typ der Quelldaten. Beispiele: - image/png - image/jpeg Wenn ein nicht unterstützter MIME-Typ angegeben wird, wird ein Fehler zurückgegeben. Eine vollständige Liste der unterstützten Dateiformate finden Sie unter Unterstützte Dateiformate. |
data |
Rohbyte für Medienformate. Ein base64-codierter String. |
FunctionCall
Eine vorhergesagte FunctionCall
, die vom Modell zurückgegeben wird und einen String enthält, der die FunctionDeclaration.name
mit den Argumenten und ihren Werten darstellt.
JSON-Darstellung |
---|
{ "name": string, "args": { object } } |
Felder | |
---|---|
name |
Erforderlich. Der Name der aufzurufenden Funktion. Muss a–z, A–Z, 0–9 sein oder Unterstriche und Bindestriche enthalten. Die maximale Länge beträgt 63. |
args |
Optional. Die Funktionsparameter und -werte im JSON-Objektformat. |
FunctionResponse
Die Ergebnisausgabe von einer FunctionCall
, die einen String enthält, der die FunctionDeclaration.name
und ein strukturiertes JSON-Objekt mit einer Ausgabe der Funktion enthält, wird als Kontext für das Modell verwendet. Hier sollte das Ergebnis eines FunctionCall
enthalten sein, der auf der Grundlage der Modellvorhersage erstellt wurde.
JSON-Darstellung |
---|
{ "name": string, "response": { object } } |
Felder | |
---|---|
name |
Erforderlich. Der Name der aufzurufenden Funktion. Muss a–z, A–Z, 0–9 sein oder Unterstriche und Bindestriche enthalten. Die maximale Länge beträgt 63. |
response |
Erforderlich. Die Funktionsantwort im JSON-Objektformat. |
FileData
URI-basierte Daten.
JSON-Darstellung |
---|
{ "mimeType": string, "fileUri": string } |
Felder | |
---|---|
mimeType |
Optional. Der IANA-Standard-MIME-Typ der Quelldaten. |
fileUri |
Erforderlich. URI. |
Tool
Tooldetails, die das Modell zum Generieren einer Antwort verwenden kann.
Eine Tool
ist ein Code-Snippet, das es dem System ermöglicht, mit externen Systemen zu interagieren, um eine Aktion oder eine Reihe von Aktionen auszuführen, ohne das Wissen und den Umfang des Modells zu kennen.
JSON-Darstellung |
---|
{
"functionDeclarations": [
{
object ( |
Felder | |
---|---|
functionDeclarations[] |
Optional. Eine Liste der für das Modell verfügbaren Das Modell oder System führt die Funktion nicht aus. Stattdessen kann die definierte Funktion als [FunctionCall][content.part.function_call] mit Argumenten auf der Clientseite zur Ausführung zurückgegeben werden. Das Modell kann entscheiden, eine Teilmenge dieser Funktionen aufzurufen, indem es [FunctionCall][content.part.function_call] in die Antwort einfügt. Die nächste Unterhaltungsrunde kann [FunctionResponse][content.part.function_response] mit dem Kontext zur Generierung von [content.role]-Funktion für die nächste Modellrunde enthalten. |
FunctionDeclaration
Strukturierte Darstellung einer Funktionsdeklaration gemäß der Definition in der OpenAPI 3.03-Spezifikation. Diese Deklaration enthält den Funktionsnamen und die Parameter. Diese FunctionDeclaration-Darstellung ist eine Darstellung eines Codeblocks, der vom Modell als Tool
verwendet und vom Client ausgeführt werden kann.
JSON-Darstellung |
---|
{
"name": string,
"description": string,
"parameters": {
object ( |
Felder | |
---|---|
name |
Erforderlich. Der Name der Funktion. Muss a–z, A–Z, 0–9 sein oder Unterstriche und Bindestriche enthalten. Die maximale Länge beträgt 63. |
description |
Erforderlich. Eine kurze Beschreibung der Funktion. |
parameters |
Optional. Beschreibt die Parameter dieser Funktion. Entspricht dem Stringschlüssel des OpenAPI 3.03-Parameterobjekts: der Name des Parameters. Bei Parameternamen wird zwischen Groß- und Kleinschreibung unterschieden. Schemawert: das Schema, das den für den Parameter verwendeten Typ definiert. |
Schema
Mit dem Objekt Schema
können Eingabe- und Ausgabedatentypen definiert werden. Diese Typen können Objekte, aber auch Primitive und Arrays sein. Stellt eine ausgewählte Teilmenge eines OpenAPI 3.0-Schemaobjekts dar.
JSON-Darstellung |
---|
{ "type": enum ( |
Felder | |
---|---|
type |
Erforderlich. Datentyp. |
format |
Optional. Das Format der Daten. Dies wird nur für primitive Datentypen verwendet. Unterstützte Formate: für den Typ NUMBER: float, double für den INTEGER-Typ: int32, int64 |
description |
Optional. Eine kurze Beschreibung des Parameters. Diese können Anwendungsbeispiele enthalten. Die Parameterbeschreibung kann als Markdown formatiert sein. |
nullable |
Optional. Gibt an, ob der Wert null sein kann. |
enum[] |
Optional. Mögliche Werte des Elements vom Typ.STRING im enum-Format. Beispielsweise können wir eine Enum-Richtung so definieren : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}. |
properties |
Optional. Eigenschaften des Typs OBJECT. Ein Objekt, das eine Liste von |
required[] |
Optional. Erforderliche Eigenschaften vom Typ.OBJECT. |
items |
Optional. Schema der Elemente von Type.ARRAY. |
Typ
„Type“ (Typ) enthält die Liste der OpenAPI-Datentypen gemäß https://spec.openapis.org/oas/v3.0.3#data-types.
Enums | |
---|---|
TYPE_UNSPECIFIED |
Nicht angegeben, sollte nicht verwendet werden. |
STRING |
Stringtyp. |
NUMBER |
Zahlentyp. |
INTEGER |
Ganzzahltyp. |
BOOLEAN |
Boolescher Typ. |
ARRAY |
Arraytyp. |
OBJECT |
Objekttyp. |
ToolConfig
Die Toolkonfiguration mit den Parametern zur Angabe der Tool
-Verwendung in der Anfrage.
JSON-Darstellung |
---|
{
"functionCallingConfig": {
object ( |
Felder | |
---|---|
functionCallingConfig |
Optional. Konfiguration für Funktionsaufruf. |
FunctionCallingConfig
Konfiguration zum Festlegen des Verhaltens bei Funktionsaufrufen.
JSON-Darstellung |
---|
{
"mode": enum ( |
Felder | |
---|---|
mode |
Optional. Gibt den Modus an, in dem Funktionsaufrufe ausgeführt werden sollen. Wenn keine Vorgabe erfolgt, wird der Standardwert AUTOMATISCH festgelegt. |
allowedFunctionNames[] |
Optional. Eine Reihe von Funktionsnamen, die, sofern angegeben, die vom Modell aufrufenden Funktionen einschränkt. Sollte nur festgelegt werden, wenn für den Modus ANY festgelegt ist. Funktionsnamen müssen mit [FunctionDeclaration.name] übereinstimmen. Wenn der Modus auf ANY gesetzt ist, sagt das Modell einen Funktionsaufruf aus dem Satz von Funktionsnamen vorher. |
Modus
Definiert das Ausführungsverhalten für Funktionsaufrufe, indem der Ausführungsmodus definiert wird.
Enums | |
---|---|
MODE_UNSPECIFIED |
Nicht spezifizierter Funktionsaufrufmodus. Dieser Wert sollte nicht verwendet werden. |
AUTO |
Das Standardverhalten des Modells. Das Modell entscheidet, ob ein Funktionsaufruf oder eine Antwort in natürlicher Sprache vorhergesagt wird. |
ANY |
Das Modell ist darauf beschränkt, immer nur einen Funktionsaufruf vorherzusagen. Wenn „allowedFunctionNames“ festgelegt ist, ist der vorhergesagte Funktionsaufruf auf einen der „allowedFunctionNames“ beschränkt. Andernfalls ist der vorhergesagte Funktionsaufruf ein beliebiger der angegebenen „functionDeclarations“. |
NONE |
Das Modell sagt keinen Funktionsaufruf vorher. Das Modellverhalten entspricht dem, wenn keine Funktionsdeklarationen übergeben werden. |
UsageMetadata
Metadaten zur Nutzung der im Cache gespeicherten Inhalte.
JSON-Darstellung |
---|
{ "totalTokenCount": integer } |
Felder | |
---|---|
totalTokenCount |
Gesamtzahl der Tokens, die der im Cache gespeicherte Inhalt verbraucht. |
Methoden |
|
---|---|
|
Erstellt eine CachedContent-Ressource. |
|
Löscht die CachedContent-Ressource. |
|
Liest Ressource vom Typ „CachedContent“. |
|
Listet CachedContents auf. |
|
Aktualisiert die CachedContent-Ressource (nur die Ablaufzeit kann aktualisiert werden). |