Struct ClearToolOutputs 

pub struct ClearToolOutputs {
    pub keep_tokens: usize,
    pub keep_under: usize,
}

Frees context by clearing the outputs of older tool calls: walking back from the end, the outputs within the first keep_tokens stay, and every older one is replaced by a placeholder. The last message is never touched: it is what the model must answer. Error results stay, being short and telling the model what went wrong, and so do outputs under keep_under tokens, which free little. The calls themselves stay, so the conversation keeps its shape. Each size missing from its serde form is the default’s.

Fields

keep_tokens: usize

Tokens of the newest tool output kept.

keep_under: usize

Tokens under which an output is never cleared.

Implementations

impl ClearToolOutputs

pub const PLACEHOLDER: &'static str = "[output cleared to fit the context window; run the tool again if needed]"

What a cleared output says.

pub fn new(keep_tokens: usize) -> Self

Keep the newest keep_tokens of tool output, counted by the default HeuristicTokenCounter, and say Self::PLACEHOLDER instead of the rest but outputs under the default keep_under: the serde form that names only keep_tokens.

use rig_memory::ClearToolOutputs;

let config: ClearToolOutputs = serde_json::from_str(r#"{"keep_tokens": 8000}"#)?;
assert_eq!(ClearToolOutputs::new(8000), config);

pub fn clear(&self, messages: &mut [Arc<Message>]) -> Cleared

Clears older tool outputs of messages in place.

pub fn clear_conversation( &self, conversation: &mut Conversation, by: Author, ) -> Cleared

Clears older tool outputs of conversation, as Self::clear does, rewriting the entries that change in place by by (Conversation::edit_each), so they keep their ids.

pub fn plan(&self, conversation: &Conversation) -> ClearPlan

Which tool outputs of conversation Self::clear_conversation would clear, by message id, so the plan still applies once messages arrive or a copy of the conversation is edited.

Trait Implementations

impl Clone for ClearToolOutputs

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClearToolOutputs

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

Formats the value using the given formatter.

impl Default for ClearToolOutputs

fn default() -> Self

The newest 20k tokens of output kept, and every output under 500.

impl<'de> Deserialize<'de> for ClearToolOutputs

where ClearToolOutputs: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClearToolOutputs

impl PartialEq for ClearToolOutputs

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ClearToolOutputs

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 ClearToolOutputs