Skip to main content

SessionContextOptions

Struct SessionContextOptions 

Source
#[non_exhaustive]
pub struct SessionContextOptions { pub summary: bool, pub limit_to_session: bool, pub tokens: Option<u32>, pub peer_target: Option<String>, pub peer_perspective: Option<String>, pub search_query: Option<String>, pub search_top_k: Option<u32>, pub search_max_distance: Option<f64>, pub include_most_frequent: Option<bool>, pub max_conclusions: Option<u32>, }
Expand description

Options for Session::context_with_options.

Fields (Non-exhaustive)§

This struct is marked as 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.
§summary: bool

Whether to include the session summary.

§limit_to_session: bool

Whether to limit representation context to this session only.

§tokens: Option<u32>

Maximum number of tokens to include in the context.

§peer_target: Option<String>

A peer ID to get context for.

§peer_perspective: Option<String>

A peer ID to get context from the perspective of.

§search_query: Option<String>

A query string used to fetch semantically relevant conclusions.

§search_top_k: Option<u32>

Number of semantically relevant facts to return when searching.

§search_max_distance: Option<f64>

Maximum semantic distance for search results (0.0–1.0).

§include_most_frequent: Option<bool>

Whether to include the most frequent conclusions.

§max_conclusions: Option<u32>

Maximum number of conclusions to include.

Implementations§

Source§

impl SessionContextOptions

Source

pub fn builder() -> SessionContextOptionsBuilder

Create an instance of SessionContextOptions using the builder syntax

Source§

impl SessionContextOptions

Source

pub fn validate(&self) -> Result<()>

Validate cross-field constraints.

Enforces that peer_perspective and search_query each require peer_target, that range-bounded numeric fields are in range, and that tokens (when set) is non-zero.

Note: search_top_k and search_max_distance only take effect together with search_query, and max_conclusions together with include_most_frequent. They are intentionally NOT hard-rejected when their companion is absent: the server ignores them in that case, and rejecting locally would couple this client to server-side semantics that may relax over time. Setting them without their companion is therefore a no-op rather than an error.

Trait Implementations§

Source§

impl Clone for SessionContextOptions

Source§

fn clone(&self) -> SessionContextOptions

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 SessionContextOptions

Source§

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

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

impl<'de> Deserialize<'de> for SessionContextOptions

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for SessionContextOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for SessionContextOptions

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for SessionContextOptions

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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