Struct CompletionArgument

pub struct CompletionArgument {
    pub messages: Vec<SamplingMessage>,
    pub model_preferences: Option<ModelPreferences>,
    pub system_prompt: Option<String>,
    pub include_context: Option<String>,
    pub temperature: Option<f64>,
    pub max_tokens: Option<i32>,
    pub stop_sequences: Option<Vec<String>>,
    pub metadata: HashMap<String, Value>,
}

Arguments for a completion request.

Fields

messages: Vec<SamplingMessage>

Messages for the completion

model_preferences: Option<ModelPreferences>

Optional model selection

system_prompt: Option<String>

System prompt for the completion

include_context: Option<String>

Include context about tools available to the model

temperature: Option<f64>

Temperature for sampling (0.0 to 1.0)

max_tokens: Option<i32>

Maximum number of tokens to generate

stop_sequences: Option<Vec<String>>

Stop sequences for completion

metadata: HashMap<String, Value>

Additional metadata for the request

Implementations

impl CompletionArgument

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

Create a new completion argument with messages.

pub fn with_model_preferences(self, preferences: ModelPreferences) -> Self

Set model preferences.

pub fn with_system_prompt(self, prompt: impl Into<String>) -> Self

Set system prompt.

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

Set temperature.

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

Set maximum tokens.

pub fn with_stop_sequences(self, sequences: Vec<String>) -> Self

Add stop sequences.

pub fn with_metadata(self, key: impl Into<String>, value: Value) -> Self

Add metadata.

Trait Implementations

impl Clone for CompletionArgument

fn clone(&self) -> CompletionArgument

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionArgument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CompletionArgument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CompletionArgument

fn eq(&self, other: &CompletionArgument) -> 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 CompletionArgument

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 CompletionArgument