Struct ChatRequest 

pub struct ChatRequest {
    pub messages: Vec<ChatMessage>,
    pub model: Option<String>,
    pub temperature: Option<f32>,
    pub max_tokens: Option<u32>,
    pub stream: bool,
    pub tools: Option<Vec<ToolDefinition>>,
    pub tool_choice: Option<ToolChoice>,
    pub top_p: Option<f32>,
    pub stop: Option<Vec<String>>,
    pub response_format: Option<ResponseFormat>,
    pub turn_id: Option<ConversationTurnId>,
    pub mcp_servers: Vec<McpServerConfig>,
}

Configuration for a chat completion request

Fields

messages: Vec<ChatMessage>

Conversation messages

model: Option<String>

Model identifier (provider-specific)

temperature: Option<f32>

Temperature for response randomness (0.0 - 2.0).

Support depends on each provider’s LlmCapabilities::TEMPERATURE flag. Use validate_capabilities to check before dispatch.

max_tokens: Option<u32>

Maximum tokens to generate.

Support depends on each provider’s LlmCapabilities::MAX_TOKENS flag. Use validate_capabilities to check before dispatch.

stream: bool

Whether to stream the response

tools: Option<Vec<ToolDefinition>>

Tool definitions available for the model to call

tool_choice: Option<ToolChoice>

Controls which tools the model may call

top_p: Option<f32>

Nucleus sampling parameter (0.0 - 1.0)

stop: Option<Vec<String>>

Stop sequences that halt generation

response_format: Option<ResponseFormat>

Control over the response format (text, JSON, or schema-validated JSON)

turn_id: Option<ConversationTurnId>

Conversation-turn correlation identifier.

When present, decorators such as MetricsProvider can emit per-turn records in addition to their usual aggregation. The identifier must be propagated from the inbound boundary; LLM providers never generate it themselves.

mcp_servers: Vec<McpServerConfig>

MCP servers an ACP-managed provider should expose to the model for native tool calling.

Only the Copilot Headless converse() path forwards these into the ACP session/new request; providers without SDK tool calling ignore them.

Implementations

impl ChatRequest

pub const fn new(messages: Vec<ChatMessage>) -> Self

Create a new chat request with messages

pub fn with_mcp_servers(self, mcp_servers: Vec<McpServerConfig>) -> Self

Set the MCP servers an ACP-managed provider exposes to the model.

pub fn with_model(self, model: impl Into<String>) -> Self

Set the model to use

pub const fn with_temperature(self, temperature: f32) -> Self

Set the temperature

pub const fn with_max_tokens(self, max_tokens: u32) -> Self

Set the maximum tokens

pub const fn with_streaming(self) -> Self

Enable streaming

pub fn with_tools(self, tools: Vec<ToolDefinition>) -> Self

Set the tool definitions

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

Set the tool choice

pub const fn with_top_p(self, top_p: f32) -> Self

Set the top_p (nucleus sampling) parameter

pub fn with_stop(self, stop: Vec<String>) -> Self

Set stop sequences

pub fn with_response_format(self, response_format: ResponseFormat) -> Self

Set the response format

pub const fn with_turn_id(self, turn_id: ConversationTurnId) -> Self

Attach a conversation-turn correlation identifier.

The identifier is expected to have been generated at the inbound boundary. Calling this method on a downstream request propagates the same identifier — it must not be freshly generated here.

pub fn has_images(&self) -> bool

Check whether any message in this request contains images

Trait Implementations

impl Clone for ChatRequest

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 ChatRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChatRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChatRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.