Struct Parameters

pub struct Parameters { /* private fields */ }

Parameters define the parameters sent into each step. The parameters are used to fill in the prompt template, and are also filled in by the output of the previous step. Parameters have a special key, text, which is used as a default key for simple use cases.

Parameters also implement a few convenience conversion traits to make it easier to work with them.

Examples

Creating a default parameter from a string

use llm_chain::Parameters;
let p: Parameters = "Hello world!".into();
assert_eq!(p.get("text").unwrap().as_str(), "Hello world!");

Creating a list of parameters from a list of pairs

use llm_chain::Parameters;
let p: Parameters = vec![("text", "Hello world!"), ("name", "John Doe")].into();
assert_eq!(p.get("text").unwrap().as_str(), "Hello world!");
assert_eq!(p.get("name").unwrap().as_str(), "John Doe");

Implementations

impl Parameters

pub fn new() -> Parameters

Creates a new empty set of parameters.

pub fn new_with_text<T: Into<String>>(text: T) -> Parameters

Creates a new set of parameters with a single key, text, set to the given value.

pub fn with<K: Into<String>, V: Into<String>>( &self, key: K, value: V, ) -> Parameters

Copies the parameters and adds a new key-value pair.

pub fn with_dynamic<K: Into<String>, V: ParamFull>( &self, key: K, value: V, ) -> Parameters

Copies the parameters and adds a new key-value pair pair, where the value is a dynamic parameter.

pub fn with_text<K: Into<String>>(&self, text: K) -> Parameters

Copies the parameters and adds a new key-value pair with the key text, which is the default key.

pub fn combine(&self, other: &Parameters) -> Parameters

Combines two sets of parameters, returning a new set of parameters with all the keys from both sets.

pub fn get(&self, key: &str) -> Option<String>

Returns the value of the given key, or None if the key does not exist.

pub fn get_text(&self) -> Option<String>

Trait Implementations

impl Clone for Parameters

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parameters

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

Formats the value using the given formatter.

impl Default for Parameters

fn default() -> Parameters

Returns the “default value” for a type.

impl From<&str> for Parameters

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<BTreeMap<String, String>> for Parameters

fn from(map: BTreeMap<String, String>) -> Self

Converts to this type from the input type.

impl From<HashMap<String, String>> for Parameters

fn from(map: HashMap<String, String>) -> Self

Converts to this type from the input type.

impl From<String> for Parameters

fn from(text: String) -> Self

Converts to this type from the input type.

impl From<Vec<(&str, &str)>> for Parameters

fn from(data: Vec<(&str, &str)>) -> Self

Converts to this type from the input type.

impl From<Vec<(String, String)>> for Parameters

fn from(data: Vec<(String, String)>) -> Self

Converts to this type from the input type.

impl PartialEq for Parameters

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.