Struct RequestPatch 

#[non_exhaustive]
pub struct RequestPatch {
    pub preamble: Option<String>,
    pub temperature: Option<f64>,
    pub max_tokens: Option<u64>,
    pub tool_choice: Option<ToolChoice>,
    pub active_tools: Option<Vec<String>>,
    pub additional_params: Option<Value>,
    pub extra_context: Vec<Document>,
    pub history: Option<Vec<Message>>,
}

A non-sticky patch applied only to the current turn’s completion request.

A HookStack merges patches in hook registration order according to these rules:

• extra_context documents are appended in order.
• JSON-object additional_params values are shallow-merged, with later top-level keys winning; a later non-object value replaces an earlier value.
• active_tools allow-lists are intersected.
• Scalar fields and history use last-writer-wins semantics, with a warning when multiple hooks set the same field.

The merged patch does not mutate the agent’s configured baseline and is not carried into subsequent turns.

Fields (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.

preamble: Option<String>

Preamble to use instead of the agent’s configured preamble for this turn.

temperature: Option<f64>

Sampling temperature to use for this turn.

max_tokens: Option<u64>

Maximum output-token count to use for this turn.

tool_choice: Option<ToolChoice>

Tool-choice policy to use for this turn.

active_tools: Option<Vec<String>>

Allow-list used to narrow the tools advertised for this turn.

additional_params: Option<Value>

Provider-specific request parameters to apply for this turn.

extra_context: Vec<Document>

Context documents appended to the request for this turn.

history: Option<Vec<Message>>

Conversation history to use instead of the current history for this turn.

Implementations

impl RequestPatch

pub fn new() -> Self

Creates an empty request patch.

pub fn preamble(self, value: impl Into<String>) -> Self

Replaces the agent’s configured preamble for this turn.

pub fn temperature(self, value: f64) -> Self

Sets the sampling temperature for this turn.

pub fn max_tokens(self, value: u64) -> Self

Sets the maximum output-token count for this turn.

pub fn tool_choice(self, value: ToolChoice) -> Self

Sets the tool-choice policy for this turn.

pub fn active_tools<I, S>(self, values: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Sets the allow-list used to narrow the tools advertised for this turn.

pub fn additional_params(self, value: Value) -> Self

Sets provider-specific request parameters for this turn.

When multiple patches provide JSON objects, their top-level keys are shallow-merged and values from later hooks win.

pub fn extra_context<I>(self, values: I) -> Self

where I: IntoIterator<Item = Document>,

Appends context documents to the request for this turn.

pub fn context(self, value: Document) -> Self

Appends one context document to the request for this turn.

pub fn history<I>(self, values: I) -> Self

where I: IntoIterator<Item = Message>,

Replaces the conversation history for this turn.

Trait Implementations

impl Clone for RequestPatch

fn clone(&self) -> RequestPatch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestPatch

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

Formats the value using the given formatter.

impl Default for RequestPatch

fn default() -> RequestPatch

Returns the “default value” for a type.

impl PartialEq for RequestPatch

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RequestPatch