Skip to main content

Operator

Struct Operator 

Source
pub struct Operator<Q: TypedQuestion> { /* private fields */ }
Expand description

A reusable typed question, independent of any inference provider.

This explicitly scripted provider demonstrates typed output without network access or semantic inference.

use semantic_operators::{
    AnswerValue, Boolean, FunctionProvider, IndexMap, Operator,
    ProviderFuture, Request, State, make_answer,
};

fn scripted(request: &Request) -> ProviderFuture<'_> {
    Box::pin(async move {
        request.questions().iter().map(|(name, question)| {
            let probabilities = IndexMap::from([
                ("true".into(), 0.1), ("false".into(), 0.9),
            ]);
            Ok((name.clone(), make_answer(
                question, AnswerValue::Boolean(false), probabilities, None,
            )?))
        }).collect()
    })
}

let operator = Operator::new("urgent", Boolean::new("Is this urgent?")?)?;
let provider = FunctionProvider::new(scripted);
let answer = futures_executor::block_on(operator.ask(&provider, &State::text("Fixture")))?;
assert_eq!(answer.value(), Some(&false)); // False is a decided answer.

Implementations§

Source§

impl<Q: TypedQuestion> Operator<Q>

Source

pub fn new(name: impl Into<String>, question: Q) -> Result<Self>

Create an operator with a nonempty name.

§Errors

Returns InvalidArgument if the operator name is empty.

Source

pub fn name(&self) -> &str

Stable name used in batches and traces.

Source

pub fn question(&self) -> &Q

Typed question definition.

Source

pub fn erased(&self) -> NamedQuestion

Erase the type for a heterogeneous batch.

Source

pub async fn ask<P: Provider + ?Sized>( &self, provider: &P, state: &State, ) -> Result<Answer<Q::Output>>

Ask about a state and retain a typed answer, including uncertainty.

§Errors

Propagates request, provider, response-validation, and typed-conversion errors. An undecided answer is successful and retains its evidence.

Source

pub async fn ask_request<P: Provider + ?Sized>( &self, provider: &P, request: &Request, ) -> Result<Answer<Q::Output>>

Ask about a request’s state and assets, replacing its questions.

§Errors

Propagates request/image validation, provider, response-validation, and typed-conversion errors. The supplied request’s questions are replaced.

Source

pub fn answer(&self, answers: &Answers) -> Result<Answer<Q::Output>>

Read this operator’s checked typed result from a heterogeneous batch.

§Errors

Returns InvalidArgument if this operator is absent, or a normalization or conversion error if the retained answer does not match its question/type.

Trait Implementations§

Source§

impl<Q: Clone + TypedQuestion> Clone for Operator<Q>

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<Q: Debug + TypedQuestion> Debug for Operator<Q>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<Q> Freeze for Operator<Q>
where Q: Freeze,

§

impl<Q> RefUnwindSafe for Operator<Q>
where Q: RefUnwindSafe,

§

impl<Q> Send for Operator<Q>
where Q: Send,

§

impl<Q> Sync for Operator<Q>
where Q: Sync,

§

impl<Q> Unpin for Operator<Q>
where Q: Unpin,

§

impl<Q> UnsafeUnpin for Operator<Q>
where Q: UnsafeUnpin,

§

impl<Q> UnwindSafe for Operator<Q>
where Q: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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