Struct CompletionRequest 

pub struct CompletionRequest {
    pub model: Option<String>,
    pub preamble: Option<String>,
    pub chat_history: OneOrMany<Message>,
    pub documents: Vec<Document>,
    pub tools: Vec<ToolDefinition>,
    pub temperature: Option<f64>,
    pub max_tokens: Option<u64>,
    pub tool_choice: Option<ToolChoice>,
    pub additional_params: Option<Value>,
    pub output_schema: Option<Schema>,
}

Struct representing a general completion request that can be sent to a completion model provider.

Fields

model: Option<String>

Optional model override for this request.

preamble: Option<String>

Legacy preamble field preserved for backwards compatibility.

New code should prefer a leading Message::System in chat_history as the canonical representation of system instructions.

chat_history: OneOrMany<Message>

The chat history to be sent to the completion model provider. The very last message will always be the prompt (hence why there is always one)

documents: Vec<Document>

The documents to be sent to the completion model provider

tools: Vec<ToolDefinition>

The tools to be sent to the completion model provider

temperature: Option<f64>

The temperature to be sent to the completion model provider

max_tokens: Option<u64>

The max tokens to be sent to the completion model provider

tool_choice: Option<ToolChoice>

Whether tools are required to be used by the model provider or not before providing a response.

additional_params: Option<Value>

Additional provider-specific parameters to be sent to the completion model provider

output_schema: Option<Schema>

Optional JSON Schema for structured output. When set, providers that support native structured outputs will constrain the model’s response to match this schema.

Implementations

impl CompletionRequest

pub fn output_schema_name(&self) -> Option<String>

Extracts a name from the output schema’s "title" field, falling back to "response_schema". Useful for providers that require a name alongside the JSON Schema (e.g., OpenAI).

pub fn normalized_documents(&self) -> Option<Message>

Returns documents normalized into a message (if any). Most providers do not accept documents directly as input, so it needs to convert into a Message so that it can be incorporated into chat_history as a

pub fn with_provider_tool( self, tool: ProviderToolDefinition, ) -> CompletionRequest

Adds a provider-hosted tool by storing it in additional_params.tools.

pub fn with_provider_tools( self, tools: Vec<ProviderToolDefinition>, ) -> CompletionRequest

Adds provider-hosted tools by storing them in additional_params.tools.

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<CompletionRequest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CompletionRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.