Enum Question 

pub enum Question {
    Noul {
        instructions: Content,
        criteria: Option<NoulCriteria>,
    },
    Choice {
        instructions: Content,
        criteria: BTreeMap<String, Option<Content>>,
    },
    Score {
        instructions: Content,
        criteria: Vec<Content>,
    },
}

A typed question, serialized with the API’s type discriminator.

Variants

Noul

A yes/no question returning the probability of yes.

Fields

instructions: Content

The question and optional structured context.

criteria: Option<NoulCriteria>

Optional descriptions of yes and no.

Choice

Choose one of at most 255 named options.

Fields

instructions: Content

What the model should decide.

criteria: BTreeMap<String, Option<Content>>

Options and optional descriptions. None is serialized as JSON null.

Score

Score against two to ten ordered levels.

Fields

instructions: Content

What the model should rate.

criteria: Vec<Content>

Level descriptions, in increasing score order.

Implementations

impl Question

pub fn noul(instructions: impl Into<Content>) -> Self

Construct a yes/no question without a rubric.

pub fn noul_with_criteria( instructions: impl Into<Content>, criteria: NoulCriteria, ) -> Self

Construct a yes/no question with descriptions of yes and/or no.

pub fn choice<K: Into<String>>( instructions: impl Into<Content>, criteria: impl IntoIterator<Item = (K, Option<Content>)>, ) -> Self

Construct a choice question. Use None for an option without a description. Repeated option names replace earlier entries, as with a map.

pub fn score<C: Into<Content>>( instructions: impl Into<Content>, criteria: impl IntoIterator<Item = C>, ) -> Self

Construct a score question from ordered level descriptions.

pub fn validate(&self) -> Result<(), ValidationError>

Check rubric sizes. This also runs automatically before sending a request.

Trait Implementations

impl Clone for Question

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 Question

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Question

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Question

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Question

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 Question