Struct HistoryCompactRequest 

pub struct HistoryCompactRequest {
    pub custom_instructions: Option<String>,
    pub token_limit: Option<i64>,
    pub trigger: Option<HistoryCompactRequestTrigger>,
}

Optional compaction parameters.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

custom_instructions: Option<String>

Optional user-provided instructions to focus the compaction summary

token_limit: Option<i64>

Context window token limit this compaction is targeting, recorded as the tokenLimit on the persisted session.compaction_start / session.compaction_complete events. Set it when the compaction targets a window other than the compacting model’s own, e.g. switching to a model with a smaller context window: the compaction still runs on the current model, so the limit that motivated it would otherwise be lost. When absent, the events record the compacting model’s own resolved limit. Attribution metadata only - it does not change how much the compaction removes.

trigger: Option<HistoryCompactRequestTrigger>

What initiated this compaction request, recorded as the trigger on the persisted session.compaction_start / session.compaction_complete events. When absent, the compaction is persisted without trigger attribution (initiator unknown).

Trait Implementations

impl Clone for HistoryCompactRequest

fn clone(&self) -> HistoryCompactRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryCompactRequest

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

Formats the value using the given formatter.

impl Default for HistoryCompactRequest

fn default() -> HistoryCompactRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HistoryCompactRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HistoryCompactRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.