Struct CompletionOptions 

pub struct CompletionOptions {
    pub model: Option<String>,
    pub temperature: Option<f32>,
    pub max_tokens: Option<u32>,
    pub top_p: Option<f32>,
    pub frequency_penalty: Option<f32>,
    pub presence_penalty: Option<f32>,
    pub stop_sequences: Vec<String>,
    pub tools: Option<Vec<Tool>>,
    pub tool_choice: Option<ToolChoice>,
    pub response_format: Option<ResponseFormat>,
}

Configuration options for chat completions.

Used to configure requests with model selection, sampling parameters, and tool calling settings. This type can be reused across multiple requests.

Examples

use xai_grpc_client::CompletionOptions;

let options = CompletionOptions::new()
    .with_model("grok-2-1212")
    .with_temperature(0.7)
    .with_max_tokens(500);

Fields

model: Option<String>

Model to use for completion.

temperature: Option<f32>

Sampling temperature (0.0-2.0).

max_tokens: Option<u32>

Maximum tokens to generate.

top_p: Option<f32>

Nucleus sampling probability.

frequency_penalty: Option<f32>

presence_penalty: Option<f32>

stop_sequences: Vec<String>

tools: Option<Vec<Tool>>

tool_choice: Option<ToolChoice>

response_format: Option<ResponseFormat>

Implementations

impl CompletionOptions

pub fn new() -> Self

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

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

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

Trait Implementations

impl Clone for CompletionOptions

fn clone(&self) -> CompletionOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionOptions

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

Formats the value using the given formatter.

impl Default for CompletionOptions

fn default() -> CompletionOptions

Returns the “default value” for a type.