Struct GenOptions 

pub struct GenOptions {
    pub max_tokens: Option<u32>,
    pub temperature: Option<f32>,
    pub top_p: Option<f32>,
    pub top_k: Option<u32>,
    pub stop: Option<Vec<String>>,
    pub presence_penalty: Option<f32>,
    pub frequency_penalty: Option<f32>,
    pub seed: Option<u64>,
    pub n: usize,
    pub system: Option<String>,
}

Generation options that the caller supplies per request. Kept provider-agnostic; adapters map these onto their own APIs and ignore fields they don’t support (all adapters MUST tolerate a None on every optional field without erroring).

Fields

max_tokens: Option<u32>

Maximum tokens in the completion. None means adapter default.

temperature: Option<f32>

Sampling temperature. None means adapter default.

top_p: Option<f32>

Nucleus-sampling probability cutoff. None means adapter default. OpenAI and most providers accept top_p; Ollama maps it to its options.top_p.

top_k: Option<u32>

Top-K sampling. None means adapter default. Not supported by every provider (OpenAI v1 chat does NOT accept top_k; Ollama does via options.top_k). Adapters that can’t honour it silently drop the field.

stop: Option<Vec<String>>

Stop sequences. Completion halts when any of these strings appears. Most providers accept 1-4 stop strings. None or empty vec means no stop.

presence_penalty: Option<f32>

Presence-penalty (discourage repeating tokens). OpenAI-family.

frequency_penalty: Option<f32>

Frequency-penalty (discourage high-frequency tokens). OpenAI-family.

seed: Option<u64>

Deterministic-sampling seed. OpenAI accepts a seed on the chat-completions endpoint; Ollama accepts options.seed. Useful for reproducing HyDE runs in benchmarks.

n: usize

Number of completions to sample. For multi-query this is the number of paraphrases; for HyDE this is usually 1 (or small-N averaged, per the paper).

system: Option<String>

Optional system prompt / role preamble.

Implementations

impl GenOptions

pub fn single() -> Self

Construct options with n = 1 and everything else None. Equivalent to GenOptions::default(); provided for self-documentation at call sites (“I only want 1 completion”).

Trait Implementations

impl Clone for GenOptions

fn clone(&self) -> GenOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GenOptions

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

Formats the value using the given formatter.

impl Default for GenOptions

fn default() -> Self

Returns the “default value” for a type.