Skip to main content

TypedPromptRequest

Struct TypedPromptRequest 

Source
pub struct TypedPromptRequest<'a, T, M, P>{ /* private fields */ }
Expand description

A builder for creating typed prompt requests that return deserialized structured output.

This struct wraps a standard PromptRequest and adds:

  • Automatic JSON schema generation from the target type T
  • Automatic deserialization of the response into T

§Example

let forecast: WeatherForecast = agent
    .prompt_typed("What's the weather in NYC?")
    .max_turns(3)
    .await?;

Implementations§

Source§

impl<'a, T, M, P> TypedPromptRequest<'a, T, M, P>

Source

pub fn from_agent(agent: &Agent<M, P>, prompt: impl Into<Message>) -> Self

Create a new TypedPromptRequest from an agent.

This automatically sets the output schema based on the type parameter T.

Source

pub fn max_turns(self, depth: usize) -> Self

Set the maximum number of turns for multi-turn conversations.

A given agent may require multiple turns for tool-calling before giving an answer. If the maximum turn number is exceeded, it will return a StructuredOutputError::PromptError wrapping a MaxTurnsError.

Source

pub fn with_tool_concurrency(self, concurrency: usize) -> Self

Add concurrency to the prompt request.

This will cause the agent to execute tools concurrently.

Source

pub fn with_history(self, history: &'a mut Vec<Message>) -> Self

Add chat history to the prompt request.

Source

pub fn with_hook<P2>(self, hook: P2) -> TypedPromptRequest<'a, T, M, P2>
where P2: PromptHook<M>,

Attach a per-request hook for tool call events.

This overrides any default hook set on the agent.

Trait Implementations§

Source§

impl<'a, T, M, P> IntoFuture for TypedPromptRequest<'a, T, M, P>
where T: JsonSchema + DeserializeOwned + WasmCompatSend + 'a, M: CompletionModel + 'a, P: PromptHook<M> + 'static,

Source§

type Output = Result<T, StructuredOutputError>

The output that the future will produce on completion.
Source§

type IntoFuture = Pin<Box<dyn Future<Output = <TypedPromptRequest<'a, T, M, P> as IntoFuture>::Output> + Send + 'a>>

Which kind of future are we turning this into?
Source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<'a, T, M, P> Freeze for TypedPromptRequest<'a, T, M, P>
where P: Freeze,

§

impl<'a, T, M, P> !RefUnwindSafe for TypedPromptRequest<'a, T, M, P>

§

impl<'a, T, M, P> Send for TypedPromptRequest<'a, T, M, P>

§

impl<'a, T, M, P> Sync for TypedPromptRequest<'a, T, M, P>
where T: Sync,

§

impl<'a, T, M, P> Unpin for TypedPromptRequest<'a, T, M, P>
where T: Unpin, P: Unpin,

§

impl<'a, T, M, P> UnsafeUnpin for TypedPromptRequest<'a, T, M, P>
where P: UnsafeUnpin,

§

impl<'a, T, M, P> !UnwindSafe for TypedPromptRequest<'a, T, M, P>

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
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
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,