REST Resource: cachedContents

Zasób: CachedContent

Treści, które zostały wstępnie przetworzone i można ich użyć w kolejnych żądaniach kierowanych do GenerativeService.

Treści z pamięci podręcznej można używać tylko z modelem, dla którego została utworzona.

Zapis JSON
{
  "contents": [
    {
      object (Content)
    }
  ],
  "tools": [
    {
      object (Tool)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "usageMetadata": {
    object (UsageMetadata)
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
  "name": string,
  "displayName": string,
  "model": string,
  "systemInstruction": {
    object (Content)
  },
  "toolConfig": {
    object (ToolConfig)
  }
}
Pola
contents[]

object (Content)

Opcjonalnie. Tylko dane wejściowe. Stała. Zawartość do pamięci podręcznej.

tools[]

object (Tool)

Opcjonalnie. Tylko dane wejściowe. Stała. Lista właściwości Tools, których model może używać do wygenerowania następnej odpowiedzi

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia wpisu w pamięci podręcznej.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji wpisu pamięci podręcznej według czasu UTC.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

usageMetadata

object (UsageMetadata)

Tylko dane wyjściowe. Metadane dotyczące wykorzystania treści zapisanych w pamięci podręcznej.

Pole sumy expiration. Określa, kiedy zasób wygaśnie. expiration może mieć tylko jedną z tych wartości:
expireTime

string (Timestamp format)

Sygnatura czasowa UTC wskazująca, kiedy zasób jest uznawany za nieaktualny. Wartość ta jest zawsze podawana na danych wyjściowych, niezależnie od tego, co zostało przesłane na dane wejściowe.

Sygnatura czasowa w formacie RFC3339 UTC „Zulu” z rozdzielczością nanosekundy i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

ttl

string (Duration format)

Tylko dane wejściowe. Nowa wartość TTL dla tego zasobu, tylko dane wejściowe.

Czas trwania w sekundach składający się z maksymalnie dziewięciu cyfr po przecinku i kończący się „s”. Przykład: "3.5s".

name

string

Opcjonalnie. Identyfikator. Nazwa zasobu odnosząca się do treści przechowywanej w pamięci podręcznej. Format: cachedContents/{id}

displayName

string

Opcjonalnie. Stała. Wygenerowana przez użytkownika rozpoznawalna wyświetlana nazwa treści z pamięci podręcznej. Maksymalnie 128 znaków Unicode.

model

string

Wymagane. Stała. Nazwa elementu (Model), który ma być używany w przypadku treści w pamięci podręcznej. Format: models/{model}

systemInstruction

object (Content)

Opcjonalnie. Tylko dane wejściowe. Stała. Instrukcja systemowa ustawiona przez dewelopera. Obecnie tylko tekstowe.

toolConfig

object (ToolConfig)

Opcjonalnie. Tylko dane wejściowe. Stała. Konfiguracja narzędzia. Ta konfiguracja jest współdzielona dla wszystkich narzędzi.

treści

Podstawowy uporządkowany typ danych zawierający wieloczęściową treść wiadomości.

Pole Content zawiera pole role określające producenta elementu Content oraz pole parts zawierające dane wieloczęściowe, które zawierają treść kolejki wiadomości.

Zapis JSON
{
  "parts": [
    {
      object (Part)
    }
  ],
  "role": string
}
Pola
parts[]

object (Part)

Zamówiono Parts, które tworzą jedną wiadomość. Części mogą mieć różne typy MIME.

role

string

Opcjonalnie. Producent treści. Musi mieć wartość „user” lub „model”.

Ta opcja jest przydatna w przypadku rozmów wieloetapowych. W przeciwnym razie pole może pozostać puste lub nieskonfigurowane.

Część

Typ danych zawierający multimedia, które są częścią wieloczęściowej wiadomości Content.

Element Part składa się z danych, które mają powiązany typ danych. Element Part może zawierać tylko 1 z akceptowanych typów w polu Part.data.

Jeśli pole inlineData jest wypełnione nieprzetworzonymi bajtami, Part musi mieć stały typ MIME IANA identyfikujący typ i podtyp mediów.

Zapis JSON
{

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "functionCall": {
    object (FunctionCall)
  },
  "functionResponse": {
    object (FunctionResponse)
  },
  "fileData": {
    object (FileData)
  }
  // End of list of possible types for union field data.
}
Pola

Pole sumy data.

data może mieć tylko jedną z tych wartości:

text

string

Tekst wbudowany.

inlineData

object (Blob)

Wbudowane bajty multimediów.

functionCall

object (FunctionCall)

Prognozowana wartość FunctionCall zwrócona z modelu, która zawiera ciąg reprezentujący element FunctionDeclaration.name z argumentami i ich wartościami.

functionResponse

object (FunctionResponse)

Wynikowe dane wyjściowe funkcji FunctionCall, które zawierają ciąg znaków reprezentujący obiekt FunctionDeclaration.name, i uporządkowany obiekt JSON zawierający dowolne dane wyjściowe funkcji, są używane jako kontekst dla modelu.

fileData

object (FileData)

Dane oparte na identyfikatorze URI.

Blob

Nieprzetworzone bajty multimediów.

Tekstu nie należy wysyłać w postaci nieprzetworzonych bajtów – użyj pola „tekst”.

Zapis JSON
{
  "mimeType": string,
  "data": string
}
Pola
mimeType

string

Standardowy typ MIME danych źródłowych wg IANA. Przykłady: – obraz/png – obraz/jpeg. Jeśli zostanie podany nieobsługiwany typ MIME, zostanie zwrócony błąd. Pełną listę obsługiwanych formatów znajdziesz w artykule o obsługiwanych formatach plików.

data

string (bytes format)

Nieprzetworzone bajty formatów multimediów.

Ciąg zakodowany w formacie base64.

FunctionCall

Prognozowana wartość FunctionCall zwrócona z modelu, która zawiera ciąg reprezentujący element FunctionDeclaration.name z argumentami i ich wartościami.

Zapis JSON
{
  "name": string,
  "args": {
    object
  }
}
Pola
name

string

Wymagane. Nazwa funkcji do wywołania. Nazwa musi mieć format a–z, A–Z lub 0–9, albo zawierać podkreślenia i myślniki o maksymalnej długości 63 znaki.

args

object (Struct format)

Opcjonalnie. Parametry i wartości funkcji w formacie obiektu JSON.

FunctionResponse

Wynikowe dane wyjściowe z funkcji FunctionCall, które zawierają ciąg znaków reprezentujący obiekt FunctionDeclaration.name, oraz uporządkowany obiekt JSON zawierający dowolne dane wyjściowe funkcji, są używane jako kontekst dla modelu. Powinien on zawierać wynik funkcji FunctionCall utworzonej na podstawie prognozy modelu.

Zapis JSON
{
  "name": string,
  "response": {
    object
  }
}
Pola
name

string

Wymagane. Nazwa funkcji do wywołania. Nazwa musi mieć format a–z, A–Z lub 0–9, albo zawierać podkreślenia i myślniki o maksymalnej długości 63 znaki.

response

object (Struct format)

Wymagane. Odpowiedź funkcji w formacie obiektu JSON.

FileData

Dane oparte na identyfikatorze URI.

Zapis JSON
{
  "mimeType": string,
  "fileUri": string
}
Pola
mimeType

string

Opcjonalnie. Standardowy typ MIME danych źródłowych wg IANA.

fileUri

string

Wymagane. Identyfikator URI.

Narzędzie

Szczegóły narzędzia, których model może używać do generowania odpowiedzi.

Tool to fragment kodu, który umożliwia systemowi wchodzenie w interakcję z zewnętrznymi systemami w celu wykonania działania lub zestawu działań poza zakresem wiedzy i zakresu modelu.

Zapis JSON
{
  "functionDeclarations": [
    {
      object (FunctionDeclaration)
    }
  ]
}
Pola
functionDeclarations[]

object (FunctionDeclaration)

Opcjonalnie. Lista elementów FunctionDeclarations dostępnych dla modelu, które mogą być używane do wywoływania funkcji.

Model lub system nie wykonuje tej funkcji. Zamiast tego zdefiniowana funkcja może zostać zwrócona jako [wywołanie funkcji][content.part.function_call] z argumentami po stronie klienta do wykonania. Model może zdecydować o wywołaniu podzbioru tych funkcji, wypełniając w odpowiedzi [wywołanie funkcji][content.part.function_call]. Następny skręt wątku może zawierać odpowiedź [FunctionResponse][content.part.function_response] z kontekstem generowania „funkcji” [content.role] dla następnej kolejki modelu.

FunctionDeclaration

Uporządkowane przedstawienie deklaracji funkcji zgodnie ze specyfikacją OpenAPI 3.03. Ta deklaracja zawiera nazwę funkcji i jej parametry. Ta deklaracja funkcji to reprezentacja bloku kodu, który może być używany przez model jako Tool i wykonywany przez klienta.

Zapis JSON
{
  "name": string,
  "description": string,
  "parameters": {
    object (Schema)
  }
}
Pola
name

string

Wymagane. Nazwa funkcji. Nazwa musi mieć format a–z, A–Z lub 0–9, albo zawierać podkreślenia i myślniki o maksymalnej długości 63 znaki.

description

string

Wymagane. Krótki opis funkcji.

parameters

object (Schema)

Opcjonalnie. Opisuje parametry tej funkcji. Odzwierciedla klucz ciągu znaków obiektu parametru Open API 3.03: nazwę parametru. W nazwach parametrów rozróżniana jest wielkość liter. Wartość schematu: schemat określający typ parametru.

Schemat

Obiekt Schema umożliwia definiowanie typów danych wejściowych i wyjściowych. Mogą to być obiekty, ale też obiekty podstawowe i tablice. Reprezentuje wybrany podzbiór obiektu schematu OpenAPI 3.0.

Zapis JSON
{
  "type": enum (Type),
  "format": string,
  "description": string,
  "nullable": boolean,
  "enum": [
    string
  ],
  "properties": {
    string: {
      object (Schema)
    },
    ...
  },
  "required": [
    string
  ],
  "items": {
    object (Schema)
  }
}
Pola
type

enum (Type)

Wymagane. Typ danych.

format

string

Opcjonalnie. Format danych. Jest używana tylko w przypadku podstawowych typów danych. Obsługiwane formaty: dla typu NUMBER: liczba zmiennoprzecinkowa, podwójna (liczba całkowita): int32, int64.

description

string

Opcjonalnie. Krótki opis parametru. Może zawierać przykłady użycia. Opis parametru może mieć format Markdown.

nullable

boolean

Opcjonalnie. Wskazuje, czy wartość może być pusta.

enum[]

string

Opcjonalnie. Możliwe wartości elementu Type.STRING w formacie wyliczenia. Kierunek listy można na przykład zdefiniować jako : {type:STRING, format:enum, enum:["WSCHÓD", PÓŁNOC", "SOUTH", "WEST"]}

properties

map (key: string, value: object (Schema))

Opcjonalnie. Właściwości obiektu Type.OBJECT.

Obiekt zawierający listę par "key": value. Przykład: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

required[]

string

Opcjonalnie. Wymagane właściwości obiektu Type.OBJECT.

items

object (Schema)

Opcjonalnie. Schemat elementów typu Type.ARRAY.

Typ

Typ zawiera listę typów danych OpenAPI zgodnie z definicją zawartą w https://spec.openapis.org/oas/v3.0.3#data-types.

Wartości w polu enum
TYPE_UNSPECIFIED Nie określono i nie należy go używać.
STRING Typ ciągu znaków.
NUMBER Typ numeru.
INTEGER Typ liczby całkowitej.
BOOLEAN Typ wartości logicznej.
ARRAY Typ tablicy.
OBJECT Typ obiektu.

ToolConfig

Konfiguracja narzędzia zawierająca parametry służące do określania użycia funkcji Tool w żądaniu.

Zapis JSON
{
  "functionCallingConfig": {
    object (FunctionCallingConfig)
  }
}
Pola
functionCallingConfig

object (FunctionCallingConfig)

Opcjonalnie. Funkcja wywołująca konfigurację.

FunctionCallingConfig

Konfiguracja do określania zachowania wywoływania funkcji.

Zapis JSON
{
  "mode": enum (Mode),
  "allowedFunctionNames": [
    string
  ]
}
Pola
mode

enum (Mode)

Opcjonalnie. Określa tryb, w którym mają być wykonywane wywołania funkcji. Jeśli nie określono inaczej, domyślną wartością będzie AUTO.

allowedFunctionNames[]

string

Opcjonalnie. Zbiór nazw funkcji, które po podaniu ograniczają funkcje wywoływane przez model.

Tę wartość należy ustawiać tylko wtedy, gdy tryb ma wartość DOWOLNY. Nazwy funkcji powinny być takie same jak [FunctionDeklaracja.nazwa]. Gdy tryb jest ustawiony na DOWOLNY, model przewiduje wywołanie funkcji na podstawie podanego zestawu nazw funkcji.

Tryb

Definiuje sposób wykonania wywoływania funkcji przez zdefiniowanie trybu wykonania.

Wartości w polu enum
MODE_UNSPECIFIED Tryb wywoływania nieokreślonej funkcji. Nie należy używać tej wartości.
AUTO Domyślny model działania decyduje o prognozowaniu wywołania funkcji lub odpowiedzi w języku naturalnym.
ANY Model jest ograniczony do prognozowania tylko wywołania funkcji. Jeśli parametr „allowedFunctionNames” jest ustawiony, prognozowane wywołanie funkcji będzie ograniczone do dowolnej z tych funkcji, w przeciwnym razie prognozowanym wywołaniem funkcji będzie dowolna z podanych „functionDetectations”.
NONE Model nie będzie przewidywać żadnego wywołania funkcji. Zachowanie modelu jest takie samo jak w przypadku braku deklaracji funkcji.

UsageMetadata

Metadane dotyczące wykorzystania treści zapisanych w pamięci podręcznej.

Zapis JSON
{
  "totalTokenCount": integer
}
Pola
totalTokenCount

integer

Łączna liczba tokenów wykorzystanych przez pamięć podręczną.

Metody

create

Tworzy zasób CachedContent.

delete

Usuwa zasób CachedContent.

get

Odczytuje zasób CachedContent.

list

Wyświetla zawartość CachedContent.

patch

Aktualizuje zasób CachedContent (tylko datę wygaśnięcia można zaktualizować).