Struct CanonicalRequest 

pub struct CanonicalRequest {

    pub model: String,
    pub system: Option<String>,
    pub messages: Vec<CanonicalMessage>,
    pub max_tokens: u32,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<i32>,
    pub stop_sequences: Vec<String>,
    pub tools: Vec<CanonicalTool>,
    pub tool_choice: Option<CanonicalToolChoice>,
    pub stream: bool,
    pub thinking: Option<ThinkingConfig>,
    pub metadata: Option<Value>,
    pub response_format: Option<ResponseFormat>,
    pub reasoning_effort: Option<ReasoningEffort>,
    pub search: Option<SearchConfig>,
    pub code_execution: bool,
    pub presence_penalty: Option<f32>,
    pub frequency_penalty: Option<f32>,
    pub forwarded_surface: ForwardedSurface,
}

Fields

model: String

system: Option<String>

messages: Vec<CanonicalMessage>

max_tokens: u32

temperature: Option<f32>

top_p: Option<f32>

top_k: Option<i32>

stop_sequences: Vec<String>

tools: Vec<CanonicalTool>

tool_choice: Option<CanonicalToolChoice>

stream: bool

thinking: Option<ThinkingConfig>

metadata: Option<Value>

response_format: Option<ResponseFormat>

reasoning_effort: Option<ReasoningEffort>

search: Option<SearchConfig>

code_execution: bool

presence_penalty: Option<f32>

frequency_penalty: Option<f32>

forwarded_surface: ForwardedSurface

Every string in the bytes the gateway is about to forward upstream.

The canonical form is lossy, so content the gateway relays can be invisible to a scanner reading only that form. The gateway fills this from the prepared outbound body before any scan runs, which is what makes the scan surface a superset of the forwarded surface. Callers that never send through the gateway leave it empty.

Implementations

impl CanonicalRequest

pub fn flatten_text(&self) -> String

The broadest inspection surface a scanner can ask for, and the one a blocking scanner should use: it covers content the canonical model cannot represent but the provider will still receive.

pub fn derived_gateway_conversation_id(&self) -> Option<GatewayConversationId>

pub fn flatten_message_text(&self, role: Role) -> Option<String>

pub fn latest_message_text(&self, role: Role) -> Option<String>

Flattens the newest message of role, ignoring every earlier one.

Distinct from Self::flatten_message_text, which concatenates every message of the role: a safety scanner that judges the latter re-reads what the caller already sent on previous turns.

pub fn message_units(&self) -> Vec<String>

Detectors that slide a window over their input need this rather than Self::flatten_text, whose concatenation lets two unrelated messages splice into a match neither one contains. Each surface leaf is its own unit for the same reason.

Trait Implementations

impl Clone for CanonicalRequest

fn clone(&self) -> CanonicalRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CanonicalRequest

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

Formats the value using the given formatter.

impl Default for CanonicalRequest

fn default() -> CanonicalRequest

Returns the “default value” for a type.