Struct RequestBuilder

pub struct RequestBuilder { /* private fields */ }

A way to add messages with finer control given.

This includes control over:

• Logits processors
• Constraints
• Logprobs
• Tools
• Sampling

Implementations

impl RequestBuilder

pub fn new() -> Self

pub fn with_web_search_options( self, web_search_options: WebSearchOptions, ) -> Self

pub fn add_message(self, role: TextMessageRole, text: impl ToString) -> Self

Add a message to the request.

For messages with tool calls, use Self::add_message_with_tool_call. For messages with tool outputs, use Self::add_tool_message.

pub fn add_tool_message( self, tool_content: impl ToString, tool_id: impl ToString, ) -> Self

Add a message with the output of a tool call.

pub fn add_message_with_tool_call( self, role: TextMessageRole, text: impl ToString, tool_calls: Vec<ToolCallResponse>, ) -> Self

pub fn add_image_message( self, role: TextMessageRole, text: impl ToString, image: DynamicImage, ) -> Self

pub fn add_logits_processor( self, processor: Arc<dyn CustomLogitsProcessor>, ) -> Self

pub fn set_adapters(self, adapters: Vec<String>) -> Self

pub fn set_tools(self, tools: Vec<Tool>) -> Self

The default tool choice is auto.

pub fn set_tool_choice(self, tool_choice: ToolChoice) -> Self

pub fn return_logprobs(self, return_logprobs: bool) -> Self

pub fn set_constraint(self, constraint: Constraint) -> Self

pub fn set_sampling(self, params: SamplingParams) -> Self

Set the sampling parameters as given.

pub fn set_deterministic_sampler(self) -> Self

Set the sampling parameters for deterministic generation. This sets up the parameters so that there is:

• No temperature, topk, topp, minp
• No penalties, stop tokens, or logit bias
• No maximum length

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

pub fn set_sampler_topk(self, topk: usize) -> Self

pub fn set_sampler_topp(self, topp: f64) -> Self

pub fn set_sampler_minp(self, minp: f64) -> Self

pub fn set_sampler_topn_logprobs(self, top_n_logprobs: usize) -> Self

pub fn set_sampler_frequency_penalty(self, frequency_penalty: f32) -> Self

pub fn set_sampler_presence_penalty(self, presence_penalty: f32) -> Self

pub fn set_sampler_stop_toks(self, stop_toks: StopTokens) -> Self

pub fn set_sampler_max_len(self, max_len: usize) -> Self

pub fn set_sampler_logits_bias(self, logits_bias: HashMap<u32, f32>) -> Self

pub fn set_sampler_n_choices(self, n_choices: usize) -> Self

pub fn set_sampler_dry_params(self, dry_params: DrySamplingParams) -> Self

Trait Implementations

impl Clone for RequestBuilder

fn clone(&self) -> RequestBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for RequestBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<TextMessages> for RequestBuilder

fn from(value: TextMessages) -> Self

Converts to this type from the input type.

impl From<VisionMessages> for RequestBuilder

fn from(value: VisionMessages) -> Self

Converts to this type from the input type.

impl RequestLike for RequestBuilder

fn messages_ref(&self) -> &[IndexMap<String, MessageContent>]

fn take_messages(&mut self) -> RequestMessage

fn take_logits_processors( &mut self, ) -> Option<Vec<Arc<dyn CustomLogitsProcessor>>>

fn take_adapters(&mut self) -> Option<Vec<String>>

fn return_logprobs(&self) -> bool

fn take_constraint(&mut self) -> Constraint

fn take_tools(&mut self) -> Option<(Vec<Tool>, ToolChoice)>

fn take_sampling_params(&mut self) -> SamplingParams

fn take_web_search_options(&mut self) -> Option<WebSearchOptions>