Skip to main content

Answer

Struct Answer 

Source
#[non_exhaustive]
pub struct Answer { pub value: AnswerValue, pub probabilities: BTreeMap<String, f32>, pub confidence: f32, pub model: Option<String>, }
Expand description

One answer: the value decided, the probability mass per label, and the probability of the value that came back.

#[non_exhaustive], so an adapter builds one with Answer::new or the three conveniences rather than a struct literal, and a field added later is not a breaking change for every adapter.

Answer::confidence is not comparable across adapters — see Calibration.

Fields (Non-exhaustive)§

This struct is marked as 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.
§value: AnswerValue

The value decided, matching the shape of the Question asked.

§probabilities: BTreeMap<String, f32>

Probability mass per label, keyed as Question::labels names them. The port does not require the masses to sum to one: some providers report only a top-1.

§confidence: f32

Probability of the label in value. See Calibration — not comparable across adapters.

§model: Option<String>

The vendor-reported model version that produced this answer, when the adapter knows it. An alias (jev-latest) can move under an unchanged request, and a threshold was tuned against a specific version’s numbers — the version that actually answered is how a drifted answer is traced back to its cause. None when the adapter does not know (or its port has no such report); set with Answer::with_model.

Implementations§

Source§

impl Answer

Source

pub fn new( value: AnswerValue, probabilities: BTreeMap<String, f32>, confidence: f32, ) -> Self

An answer with the value, probabilities and confidence given. The conveniences below are the usual way in: they pick confidence out of probabilities themselves.

Source

pub fn with_model(self, model: impl Into<String>) -> Self

Records the vendor-reported model version that produced this answer, for the adapters whose vendor reports one. Chainable on any constructor: Answer::noul(..).with_model("jev-1.13.0").

Source

pub fn choice( label: impl Into<String>, probabilities: BTreeMap<String, f32>, ) -> Self

An answer to a Question::Choice: label is one of its criteria, and confidence is looked up in probabilities under it — 0.0 when the label is absent.

Source

pub fn score(value: f32, probabilities: BTreeMap<String, f32>) -> Self

An answer to a Question::Score: value is on the scale, and confidence is looked up in probabilities under the score’s own name — the convention when a scale’s levels are named for their scores ("1".."5"). A provider that reports confidence another way builds the answer with Answer::new instead. 0.0 when the label is absent.

Source

pub fn noul(value: bool, probabilities: BTreeMap<String, f32>) -> Self

An answer to a Question::Noul: confidence is looked up in probabilities under "true" or "false" — 0.0 when the label is absent.

Trait Implementations§

Source§

impl Clone for Answer

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Answer

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for Answer

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Answer

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more