Struct CompletionRequest 

pub struct CompletionRequest {
    pub model: String,
    pub messages: Vec<Message>,
    pub tools: Vec<Tool>,
    pub tool_choice: ToolChoice,
    pub max_tokens: u32,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<u32>,
    pub stop_sequences: Vec<String>,
    pub thinking: ThinkingSetting,
    pub effort: Option<Effort>,
    pub metadata: RequestMetadata,
}

A provider-neutral request to generate a completion.

Fields

model: String

The model identifier.

messages: Vec<Message>

Ordered list of conversation messages.

tools: Vec<Tool>

Tools available to the model.

tool_choice: ToolChoice

How the model should select tools.

max_tokens: u32

Maximum number of tokens to generate.

temperature: Option<f32>

Sampling temperature.

top_p: Option<f32>

Nucleus sampling probability.

top_k: Option<u32>

Top-k sampling cutoff.

stop_sequences: Vec<String>

Sequences that stop generation when produced.

thinking: ThinkingSetting

Extended-thinking control, decoupled from effort (ticket #100). Defaults to ThinkingSetting::Auto, which derives thinking from effort (legacy behavior). Off/On force it independently.

effort: Option<Effort>

Reasoning-effort level. None (or Some(Effort::Auto)) means the provider’s default behavior; adapters skip writing the field.

metadata: RequestMetadata

Optional per-request metadata.

Implementations

impl CompletionRequest

pub fn builder(model: impl Into<String>) -> CompletionRequestBuilder

Create a builder for a new request targeting model.

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

Validate the request structure.

Errors

Returns Err(Error::InvalidRequest) if the model is empty, max_tokens is zero, a System message appears after a User/Assistant message, a System message contains a non-text block, or there are no User or Assistant messages.

Trait Implementations

impl Clone for CompletionRequest

fn clone(&self) -> CompletionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CompletionRequest

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 CompletionRequest