Struct SamplingRequest 

#[non_exhaustive]
pub struct SamplingRequest {
    pub system: Option<String>,
    pub prompt: String,
    pub max_tokens: Option<u32>,
    pub temperature: Option<f32>,
}

A request to the LLM for a text completion.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

system: Option<String>

Optional system message.

prompt: String

User message content.

max_tokens: Option<u32>

Maximum tokens to generate.

temperature: Option<f32>

Temperature (0.0–1.0).

Implementations

impl SamplingRequest

pub fn new(prompt: impl Into<String>) -> Self

Create a simple prompt-only request.

Examples

use synwire_core::agents::sampling::SamplingRequest;

let req = SamplingRequest::new("Summarise this code.");
assert_eq!(req.prompt, "Summarise this code.");
assert!(req.system.is_none());

pub fn with_system(self, system: impl Into<String>) -> Self

Set the system message.

Examples

use synwire_core::agents::sampling::SamplingRequest;

let req = SamplingRequest::new("Hello").with_system("You are a helpful assistant.");
assert!(req.system.is_some());

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

Set the maximum number of tokens to generate.

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

Set the sampling temperature.

Trait Implementations

impl Clone for SamplingRequest

fn clone(&self) -> SamplingRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamplingRequest

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

Formats the value using the given formatter.