pub struct Choice<T> { /* private fields */ }Expand description
A choice question whose successful answer contains T.
Implementations§
Source§impl<T: Serialize + DeserializeOwned + Ord> Choice<T>
impl<T: Serialize + DeserializeOwned + Ord> Choice<T>
Sourcepub fn new<const N: usize, D: Serialize>(
instructions: impl Serialize,
alternatives: [(T, D); N],
) -> Result<Self, ProviderError>
pub fn new<const N: usize, D: Serialize>( instructions: impl Serialize, alternatives: [(T, D); N], ) -> Result<Self, ProviderError>
Define a fixed set of alternatives, with its count checked at compile time.
Serde string names become labels; descriptions accept strings, objects,
arrays, or None when the label needs no explanation.
ⓘ
use rig_typesafeai::Choice;
let _ = Choice::new("Choose a route", [("only".to_owned(), "One option")]);Sourcepub fn try_from_iter<I, D>(
instructions: impl Serialize,
alternatives: I,
) -> Result<Self, ProviderError>
pub fn try_from_iter<I, D>( instructions: impl Serialize, alternatives: I, ) -> Result<Self, ProviderError>
Define runtime-supplied alternatives, validating their count at construction.
Trait Implementations§
Source§impl<T: DeserializeOwned + Ord> Query for Choice<T>
impl<T: DeserializeOwned + Ord> Query for Choice<T>
Source§type Output = ChoiceAnswer<T>
type Output = ChoiceAnswer<T>
The validated application answer shape.
Source§fn decode(&self, response: Answer) -> Result<Self::Output, ProviderError>
fn decode(&self, response: Answer) -> Result<Self::Output, ProviderError>
Validate and convert a deserialized response. Composite queries delegate
to their fields, keeping validation inside the evaluation error boundary.
Source§fn named(self, id: impl Into<String>) -> Result<NamedQuery<Self>, ProviderError>where
Self: Sized,
fn named(self, id: impl Into<String>) -> Result<NamedQuery<Self>, ProviderError>where
Self: Sized,
Give a standalone question a runtime ID. Named struct fields do not need this.
Source§fn join<Q: Query>(self, other: Q) -> JoinedQuery<Self, Q>where
Self: Sized,
fn join<Q: Query>(self, other: Q) -> JoinedQuery<Self, Q>where
Self: Sized,
Flatten two object-shaped queries into one evaluation request.
Duplicate IDs are rejected before sending the request. Child queries must
serialize with stable field names: decoding uses those names to partition
the response before delegating to each child.
Source§fn map<A, F>(self, map: F) -> MappedQuery<Self, F>
fn map<A, F>(self, map: F) -> MappedQuery<Self, F>
Project validated answers into an application value.
Auto Trait Implementations§
impl<T> Freeze for Choice<T>
impl<T> RefUnwindSafe for Choice<T>
impl<T> Send for Choice<T>
impl<T> Sync for Choice<T>
impl<T> Unpin for Choice<T>
impl<T> UnsafeUnpin for Choice<T>
impl<T> UnwindSafe for Choice<T>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoToolOutput for Twhere
T: Serialize + 'static,
impl<T> IntoToolOutput for Twhere
T: Serialize + 'static,
Source§fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>
fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>
Convert this value without routing structured data through a string.