Skip to main content

SessionContext

Struct SessionContext 

Source
pub struct SessionContext {
    pub session_id: Option<String>,
    pub service_session_id: Option<String>,
    pub session: Option<AgentSession>,
    pub agent: Option<AgentInfo>,
    pub input_messages: Vec<Message>,
    pub instructions: Option<String>,
    pub messages: Vec<Message>,
    pub tools: Vec<ToolDefinition>,
}
Expand description

Per-invocation context a provider contributes to a run. Providers mutate this in place in before_run. Rust equivalent of upstream SessionContext.

Fields§

§session_id: Option<String>

Local session identifier (from the thread), for provider scoping.

§service_session_id: Option<String>

Service-managed session/conversation id, when applicable.

§session: Option<AgentSession>

The session the run belongs to, when the caller of before_run has one (an Agent run always does). Clones share the session’s state bag, so a provider can read and persist per-session state through it. Mirrors the session argument of upstream’s before_run.

§agent: Option<AgentInfo>

The agent running, when the caller of before_run is one (an Agent run always sets it). Mirrors the agent argument of upstream’s before_run, as the identity a provider may scope by rather than the agent object itself.

§input_messages: Vec<Message>

The run’s input messages. A provider may rewrite them (for example to strip an attachment it has analyzed); the model receives the rewritten input, while after_run still sees the caller’s original.

§instructions: Option<String>

Extra system instructions to inject (providers append via add_instructions).

§messages: Vec<Message>

Extra context messages to inject ahead of history.

§tools: Vec<ToolDefinition>

Extra tools to make available for this run.

Implementations§

Source§

impl SessionContext

Source

pub fn new(input_messages: Vec<Message>) -> SessionContext

Source

pub fn extend_messages(&mut self, source_id: &str, messages: Vec<Message>)

Add context messages from source_id, each tagged with its source (see ATTRIBUTION_KEY). Mirrors upstream’s extend_messages.

Source

pub fn extend_messages_from( &mut self, source_id: &str, source_type: Option<&str>, messages: Vec<Message>, origin_session_ids: &[String], )

As extend_messages, also recording the provider’s type and the sessions the messages came from when that is not the current one (cross-session memory), for audit and governance.

Source

pub fn get_messages( &self, sources: Option<&[&str]>, exclude_sources: Option<&[&str]>, ) -> Vec<Message>

The context messages, optionally only those from sources and not from exclude_sources; unattributed messages count as from no source.

Source

pub fn add_instructions(&mut self, s: impl Into<String>)

Append instructions, newline-concatenating with any already present.

Trait Implementations§

Source§

impl Clone for SessionContext

Source§

fn clone(&self) -> SessionContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SessionContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SessionContext

Source§

fn default() -> SessionContext

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more