Struct rig::completion::CompletionRequestBuilder

pub struct CompletionRequestBuilder<M: CompletionModel> { /* private fields */ }

Builder struct for constructing a completion request.

Implementations

impl<M: CompletionModel> CompletionRequestBuilder<M>

pub fn new(model: M, prompt: String) -> Self

pub fn preamble(self, preamble: String) -> Self

Sets the preamble for the completion request.

pub fn message(self, message: Message) -> Self

Adds a message to the chat history for the completion request.

pub fn messages(self, messages: Vec<Message>) -> Self

Adds a list of messages to the chat history for the completion request.

pub fn document(self, document: Document) -> Self

Adds a document to the completion request.

pub fn documents(self, documents: Vec<Document>) -> Self

Adds a list of documents to the completion request.

pub fn tool(self, tool: ToolDefinition) -> Self

Adds a tool to the completion request.

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

Adds a list of tools to the completion request.

pub fn additional_params(self, additional_params: Value) -> Self

Adds additional parameters to the completion request.

pub fn additional_params_opt(self, additional_params: Option<Value>) -> Self

Sets the additional parameters for the completion request.

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

Sets the temperature for the completion request.

pub fn temperature_opt(self, temperature: Option<f64>) -> Self

Sets the temperature for the completion request.

pub fn build(self) -> CompletionRequest

Builds the completion request.

pub async fn send( self, ) -> Result<CompletionResponse<M::Response>, CompletionError>

Sends the completion request to the completion model provider and returns the completion response.