Struct ChoiceAnswer 

#[non_exhaustive]
pub struct ChoiceAnswer {
    pub choice: String,
    pub confidence: f64,
    pub probabilities: IndexMap<String, f64>,
}

The answer to a ChoiceQuestion.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

choice: String

The option with the highest probability.

confidence: f64

How concentrated the distribution is, from 0 to 1.

probabilities: IndexMap<String, f64>

Probability of every option; values sum to approximately 1.

Implementations

impl ChoiceAnswer

pub fn new( choice: impl Into<String>, confidence: f64, probabilities: impl IntoIterator<Item = (impl Into<String>, f64)>, ) -> Self

An answer choosing choice, for fixtures and tests.

pub fn probability(&self, option: &str) -> Option<f64>

The probability of option, if the answer includes it.

pub fn ranked(&self) -> Vec<(&str, f64)>

Options from most to least probable.

pub fn top(&self, n: usize) -> Vec<(&str, f64)>

The n most probable options, most probable first.

Trait Implementations

impl Clone for ChoiceAnswer

fn clone(&self) -> ChoiceAnswer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChoiceAnswer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChoiceAnswer

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ChoiceAnswer> for Answer

fn from(answer: ChoiceAnswer) -> Self

Converts to this type from the input type.

impl PartialEq for ChoiceAnswer

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

Equality operator ==.

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

Inequality operator !=.

impl ReadAnswer for ChoiceAnswer

type Output<'a> = &'a ChoiceAnswer

What SystemOneResponse::answer returns for this key.

fn read<'a>( id: &str, answer: &'a Answer, ) -> Result<&'a ChoiceAnswer, AnswerError>

Reads the answer to question id, failing when it has the wrong kind or content.

impl Serialize for ChoiceAnswer

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 ChoiceAnswer