Struct CachedContent

#[non_exhaustive]
pub struct CachedContent {
    pub name: String,
    pub display_name: String,
    pub model: String,
    pub system_instruction: Option<Content>,
    pub contents: Vec<Content>,
    pub tools: Vec<Tool>,
    pub tool_config: Option<ToolConfig>,
    pub create_time: Option<Timestamp>,
    pub update_time: Option<Timestamp>,
    pub usage_metadata: Option<UsageMetadata>,
    pub encryption_spec: Option<EncryptionSpec>,
    pub expiration: Option<Expiration>,
    /* private fields */
}

A resource used in LLM queries for users to explicitly specify what to cache and how to cache.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Immutable. Identifier. The server-generated resource name of the cached content Format: projects/{project}/locations/{location}/cachedContents/{cached_content}

display_name: String

Optional. Immutable. The user-generated meaningful display name of the cached content.

model: String

Immutable. The name of the Model to use for cached content. Currently, only the published Gemini base models are supported, in form of projects/{PROJECT}/locations/{LOCATION}/publishers/google/models/{MODEL}

system_instruction: Option<Content>

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

contents: Vec<Content>

Optional. Input only. Immutable. The content to cache

tools: Vec<Tool>

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

tool_config: Option<ToolConfig>

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

create_time: Option<Timestamp>

Output only. Creation time of the cache entry.

update_time: Option<Timestamp>

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

usage_metadata: Option<UsageMetadata>

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

encryption_spec: Option<EncryptionSpec>

Input only. Immutable. Customer-managed encryption key spec for a CachedContent. If set, this CachedContent and all its sub-resources will be secured by this key.

expiration: Option<Expiration>

Expiration time of the cached content.

Implementations

impl CachedContent

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_display_name<T: Into<String>>(self, v: T) -> Self

Sets the value of display_name.

pub fn set_model<T: Into<String>>(self, v: T) -> Self

Sets the value of model.

pub fn set_system_instruction<T: Into<Option<Content>>>(self, v: T) -> Self

Sets the value of system_instruction.

pub fn set_contents<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Content>,

Sets the value of contents.

pub fn set_tools<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Tool>,

Sets the value of tools.

pub fn set_tool_config<T: Into<Option<ToolConfig>>>(self, v: T) -> Self

Sets the value of tool_config.

pub fn set_create_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of create_time.

pub fn set_update_time<T: Into<Option<Timestamp>>>(self, v: T) -> Self

Sets the value of update_time.

pub fn set_usage_metadata<T: Into<Option<UsageMetadata>>>(self, v: T) -> Self

Sets the value of usage_metadata.

pub fn set_encryption_spec<T: Into<Option<EncryptionSpec>>>(self, v: T) -> Self

Sets the value of encryption_spec.

pub fn set_expiration<T: Into<Option<Expiration>>>(self, v: T) -> Self

Sets the value of expiration.

Note that all the setters affecting expiration are mutually exclusive.

pub fn expire_time(&self) -> Option<&Box<Timestamp>>

The value of expiration if it holds a ExpireTime, None if the field is not set or holds a different branch.

pub fn set_expire_time<T: Into<Box<Timestamp>>>(self, v: T) -> Self

Sets the value of expiration to hold a ExpireTime.

Note that all the setters affecting expiration are mutually exclusive.

pub fn ttl(&self) -> Option<&Box<Duration>>

The value of expiration if it holds a Ttl, None if the field is not set or holds a different branch.

pub fn set_ttl<T: Into<Box<Duration>>>(self, v: T) -> Self

Sets the value of expiration to hold a Ttl.

Note that all the setters affecting expiration are mutually exclusive.

Trait Implementations

impl Clone for CachedContent

fn clone(&self) -> CachedContent

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CachedContent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CachedContent

fn default() -> CachedContent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CachedContent

where CachedContent: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for CachedContent

fn typename() -> &'static str

The typename of this message.

impl PartialEq for CachedContent

fn eq(&self, other: &CachedContent) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CachedContent

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CachedContent