Struct rig::model::ModelBuilder

source ·
pub struct ModelBuilder<M: CompletionModel> { /* private fields */ }
Expand description

A builder for creating a model

§Example

use rig::{providers::openai, model::ModelBuilder};

let openai_client = openai::Client::from_env();

let gpt4 = openai_client.completion_model("gpt-4");

// Configure the model
let model = ModelBuilder::new(model)
    .temperature(0.8)
    .build();

Implementations§

source§

impl<M: CompletionModel> ModelBuilder<M>

source

pub fn new(model: M) -> Self

Create a new model builder

source

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

Set the temperature of the model

source

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

Set the temperature of the model (set to None to use the default temperature of the model)

source

pub fn build(self) -> Model<M>

Build the model

Auto Trait Implementations§

§

impl<M> Freeze for ModelBuilder<M>
where M: Freeze,

§

impl<M> RefUnwindSafe for ModelBuilder<M>
where M: RefUnwindSafe,

§

impl<M> Send for ModelBuilder<M>

§

impl<M> Sync for ModelBuilder<M>

§

impl<M> Unpin for ModelBuilder<M>
where M: Unpin,

§

impl<M> UnwindSafe for ModelBuilder<M>
where M: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more