pub struct CompletionRequestBuilder { /* private fields */ }Expand description
Builder for CompletionRequest.
Implementations§
Source§impl CompletionRequestBuilder
impl CompletionRequestBuilder
Sourcepub fn model(self, model: impl Into<String>) -> CompletionRequestBuilder
pub fn model(self, model: impl Into<String>) -> CompletionRequestBuilder
Set the model.
Sourcepub fn message(self, message: Message) -> CompletionRequestBuilder
pub fn message(self, message: Message) -> CompletionRequestBuilder
Add a message.
Sourcepub fn messages(self, messages: Vec<Message>) -> CompletionRequestBuilder
pub fn messages(self, messages: Vec<Message>) -> CompletionRequestBuilder
Set all messages at once.
Sourcepub fn max_tokens(self, max_tokens: u32) -> CompletionRequestBuilder
pub fn max_tokens(self, max_tokens: u32) -> CompletionRequestBuilder
Set max_tokens.
Sourcepub fn temperature(self, temperature: f32) -> CompletionRequestBuilder
pub fn temperature(self, temperature: f32) -> CompletionRequestBuilder
Set temperature.
Sourcepub fn top_p(self, top_p: f32) -> CompletionRequestBuilder
pub fn top_p(self, top_p: f32) -> CompletionRequestBuilder
Set top_p.
Sourcepub fn stream(self, stream: bool) -> CompletionRequestBuilder
pub fn stream(self, stream: bool) -> CompletionRequestBuilder
Enable streaming.
Sourcepub fn n(self, n: u32) -> CompletionRequestBuilder
pub fn n(self, n: u32) -> CompletionRequestBuilder
Set number of completions.
Sourcepub fn stop(self, stop: Vec<String>) -> CompletionRequestBuilder
pub fn stop(self, stop: Vec<String>) -> CompletionRequestBuilder
Set stop sequences.
Sourcepub fn presence_penalty(self, penalty: f32) -> CompletionRequestBuilder
pub fn presence_penalty(self, penalty: f32) -> CompletionRequestBuilder
Set presence penalty.
Sourcepub fn frequency_penalty(self, penalty: f32) -> CompletionRequestBuilder
pub fn frequency_penalty(self, penalty: f32) -> CompletionRequestBuilder
Set frequency penalty.
Sourcepub fn user(self, user: impl Into<String>) -> CompletionRequestBuilder
pub fn user(self, user: impl Into<String>) -> CompletionRequestBuilder
Set user identifier.
Sourcepub fn response_format(self, format: ResponseFormat) -> CompletionRequestBuilder
pub fn response_format(self, format: ResponseFormat) -> CompletionRequestBuilder
Set response format.
Sourcepub fn tools(self, tools: Vec<ToolDefinition>) -> CompletionRequestBuilder
pub fn tools(self, tools: Vec<ToolDefinition>) -> CompletionRequestBuilder
Set tool definitions for tool calling.
Sourcepub fn tool_choice(self, tool_choice: ToolChoice) -> CompletionRequestBuilder
pub fn tool_choice(self, tool_choice: ToolChoice) -> CompletionRequestBuilder
Set tool choice configuration.
Sourcepub fn json_mode(self) -> CompletionRequestBuilder
pub fn json_mode(self) -> CompletionRequestBuilder
Enable JSON object mode (no schema validation).
Sourcepub fn json_schema(
self,
name: impl Into<String>,
schema: Value,
) -> CompletionRequestBuilder
pub fn json_schema( self, name: impl Into<String>, schema: Value, ) -> CompletionRequestBuilder
Enable structured output with JSON schema.
Sourcepub fn build(self) -> Result<CompletionRequest, SimpleAgentsError>
pub fn build(self) -> Result<CompletionRequest, SimpleAgentsError>
Build and validate the request.
Trait Implementations§
Source§impl Clone for CompletionRequestBuilder
impl Clone for CompletionRequestBuilder
Source§fn clone(&self) -> CompletionRequestBuilder
fn clone(&self) -> CompletionRequestBuilder
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for CompletionRequestBuilder
impl Debug for CompletionRequestBuilder
Source§impl Default for CompletionRequestBuilder
impl Default for CompletionRequestBuilder
Source§fn default() -> CompletionRequestBuilder
fn default() -> CompletionRequestBuilder
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for CompletionRequestBuilder
impl RefUnwindSafe for CompletionRequestBuilder
impl Send for CompletionRequestBuilder
impl Sync for CompletionRequestBuilder
impl Unpin for CompletionRequestBuilder
impl UnsafeUnpin for CompletionRequestBuilder
impl UnwindSafe for CompletionRequestBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more