Struct SessionConfig 

pub struct SessionConfig {
    pub session_id: SessionId,
    pub metadata: BTreeMap<String, Value>,
    pub cache: Option<PromptCacheRequest>,
}

Configuration required to start a new model session.

Pass this to Agent::start to initialise the underlying ModelSession and obtain a LoopDriver.

Example

use agentkit_loop::{PromptCacheRequest, PromptCacheRetention, SessionConfig};

let config = SessionConfig::new("my-session").with_cache(
    PromptCacheRequest::automatic().with_retention(PromptCacheRetention::Short),
);

Fields

session_id: SessionId

Unique identifier for the session.

metadata: BTreeMap<String, Value>

Arbitrary key-value metadata forwarded to the model adapter.

cache: Option<PromptCacheRequest>

Default provider-side prompt caching policy for turns in this session.

Implementations

impl SessionConfig

pub fn new(session_id: impl Into<SessionId>) -> SessionConfig

Builds a session config with empty metadata and no cache policy.

pub fn with_metadata(self, metadata: BTreeMap<String, Value>) -> SessionConfig

Replaces the session metadata map.

pub fn with_cache(self, cache: PromptCacheRequest) -> SessionConfig

Sets the default prompt cache request for the session.

pub fn without_cache(self) -> SessionConfig

Clears any default prompt cache request for the session.

Trait Implementations

impl Clone for SessionConfig

fn clone(&self) -> SessionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SessionConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<SessionConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SessionConfig

impl PartialEq for SessionConfig

fn eq(&self, other: &SessionConfig) -> 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 SessionConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SessionConfig