Struct llm_chain::options::Options

pub struct Options { /* private fields */ }

A collection of options that can be used to configure a model. Options is the struct that represents a set of options for a large language model. It provides methods for creating, adding, and retrieving options.

The ‘Options’ struct is mainly created using the OptionsBuilder to allow for flexibility in setting options.

Implementations

impl Options

pub fn builder() -> OptionsBuilder

Constructs a new OptionsBuilder for creating an Options instance.

This function serves as an entry point for using the builder pattern to create Options.

Returns

An OptionsBuilder instance.

Example

let builder = Options::builder();

pub fn empty() -> &'static Self

Returns a reference to an empty set of options.

This function provides a static reference to an empty Options instance, which can be useful as a default value.

Returns

A reference to an empty Options.

Example

let empty_options = Options::empty();

pub fn get(&self, opt_discriminant: OptDiscriminants) -> Option<&Opt>

Gets the value of an option from this set of options.

This function finds the first option in opts that matches the provided OptDiscriminants.

Arguments

• opt_discriminant - An OptDiscriminants value representing the discriminant of the desired Opt.

Returns

An Option that contains a reference to the Opt if found, or None if not found.

Example

let mut builder = Options::builder();
builder.add_option(Opt::Model(ModelRef::from_path("path_to_model")));
let options = builder.build();
let model_option = options.get(OptDiscriminants::Model);

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Options

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Options

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.