REST Resource: cachedContents

{
  "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)
  }
}

object (Content)

Optional. Input only. Immutable. The content to cache.

object (Tool)

Optional. Input only. Immutable. A list of Tools the model may use to generate the next response

string (Timestamp format)

Output only. Creation time of the cache entry.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Timestamp format)

Output only. When the cache entry was last updated in UTC time.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

object (UsageMetadata)

Output only. Metadata on the usage of the cached content.

string (Timestamp format)

Timestamp in UTC of when this resource is considered expired. This is always provided on output, regardless of what was sent on input.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

string (Duration format)

Input only. New TTL for this resource, input only.

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

string

Optional. Identifier. The resource name referring to the cached content. Format: cachedContents/{id}

string

Optional. Immutable. The user-generated meaningful display name of the cached content. Maximum 128 Unicode characters.

string

Required. Immutable. The name of the Model to use for cached content Format: models/{model}

object (Content)

Optional. Input only. Immutable. Developer set system instruction. Currently text only.

object (ToolConfig)

Optional. Input only. Immutable. Tool config. This config is shared for all tools.

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

object (Part)

Ordered Parts that constitute a single message. Parts may have different MIME types.

string

Optional. The producer of the content. Must be either 'user' or 'model'.

Useful to set for multi-turn conversations, otherwise can be left blank or unset.

{

  // 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.
}

string

Inline text.

object (Blob)

Inline media bytes.

object (FunctionCall)

A predicted FunctionCall returned from the model that contains a string representing the FunctionDeclaration.name with the arguments and their values.

object (FunctionResponse)

The result output of a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model.

object (FileData)

URI based data.

{
  "mimeType": string,
  "data": string
}

string

The IANA standard MIME type of the source data. Examples: - image/png - image/jpeg If an unsupported MIME type is provided, an error will be returned. For a complete list of supported types, see Supported file formats.

string (bytes format)

Raw bytes for media formats.

A base64-encoded string.

{
  "name": string,
  "args": {
    object
  }
}

string

Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 63.

object (Struct format)

Optional. The function parameters and values in JSON object format.

{
  "name": string,
  "response": {
    object
  }
}

string

Required. The name of the function to call. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 63.

object (Struct format)

Required. The function response in JSON object format.

{
  "mimeType": string,
  "fileUri": string
}

string

Optional. The IANA standard MIME type of the source data.

string

Required. URI.

{
  "functionDeclarations": [
    {
      object (FunctionDeclaration)
    }
  ]
}

object (FunctionDeclaration)

Optional. A list of FunctionDeclarations available to the model that can be used for function calling.

The model or system does not execute the function. Instead the defined function may be returned as a [FunctionCall][content.part.function_call] with arguments to the client side for execution. The model may decide to call a subset of these functions by populating [FunctionCall][content.part.function_call] in the response. The next conversation turn may contain a [FunctionResponse][content.part.function_response] with the [content.role] "function" generation context for the next model turn.

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

string

Required. The name of the function. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 63.

string

Required. A brief description of the function.

object (Schema)

Optional. Describes the parameters to this function. Reflects the Open API 3.03 Parameter Object string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter.

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

enum (Type)

Required. Data type.

string

Optional. The format of the data. This is used only for primitive datatypes. Supported formats: for NUMBER type: float, double for INTEGER type: int32, int64

string

Optional. A brief description of the parameter. This could contain examples of use. Parameter description may be formatted as Markdown.

boolean

Optional. Indicates if the value may be null.

string

Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

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

Optional. Properties of Type.OBJECT.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

string

Optional. Required properties of Type.OBJECT.

object (Schema)

Optional. Schema of the elements of Type.ARRAY.

{
  "functionCallingConfig": {
    object (FunctionCallingConfig)
  }
}

object (FunctionCallingConfig)

Optional. Function calling config.

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

enum (Mode)

Optional. Specifies the mode in which function calling should execute. If unspecified, the default value will be set to AUTO.

string

Optional. A set of function names that, when provided, limits the functions the model will call.

This should only be set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

{
  "totalTokenCount": integer
}

integer

Total number of tokens that the cached content consumes.