Struct Choice 

pub struct Choice {
    pub instructions: Option<Value>,
    pub criteria: Map<String, Value>,
}

A question that selects one option from choices the caller defines.

Options serialize in the order supplied, each mapped to a description that is a string, object, array — or null for an option interpreted by its name alone.

let tone = Choice::new("What is the tone of this message?")
    .option("calm", "A neutral or polite message")
    .option("angry", "An upset or hostile message");

Fields

instructions: Option<Value>

What the model should decide when choosing an option.

criteria: Map<String, Value>

Options in the order the caller supplied them, mapped to descriptions (a JSON null description means “interpret the name alone”).

Implementations

impl Choice

pub fn new(instructions: impl Into<Value>) -> Self

Creates a choice question with instructions and no options yet.

pub fn without_instructions() -> Self

Creates a choice question with no instructions.

pub fn from_options<I, S>(instructions: impl Into<Value>, options: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Creates a choice question whose options all have null descriptions.

Options serialize in iteration order of options.

pub fn from_pairs<I, S>(instructions: impl Into<Value>, pairs: I) -> Self

where I: IntoIterator<Item = (S, Value)>, S: Into<String>,

Creates a choice question from an ordered list of (option, description) pairs.

Each description may be any JSON value; use Value::Null for an undescribed option.

pub fn instructions(self, instructions: impl Into<Value>) -> Self

Replaces the instructions.

pub fn option( self, option: impl Into<String>, description: impl Into<Value>, ) -> Self

Appends an option with a description.

The description may be a string, object, or array; pass Value::Null for an undescribed option.

pub fn bare_option(self, option: impl Into<String>) -> Self

Appends an option whose description is null (interpreted by name alone).

Trait Implementations

impl Clone for Choice

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Choice

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

Formats the value using the given formatter.

impl Default for Choice

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Choice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Choice> for Question

fn from(q: Choice) -> Self

Converts to this type from the input type.

impl PartialEq for Choice

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Choice

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Choice