Skip to main content

TurnOptionsBuilder

Struct TurnOptionsBuilder 

Source
pub struct TurnOptionsBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> TurnOptionsBuilder<S>

Source

pub fn build(self) -> TurnOptions
where S: IsComplete,

Finish building and return the requested object

Source

pub fn output_schema( self, value: Value, ) -> TurnOptionsBuilder<SetOutputSchema<S>>
where S::OutputSchema: IsUnset,

Optional (Some / Option setters).

Source

pub fn maybe_output_schema( self, value: Option<Value>, ) -> TurnOptionsBuilder<SetOutputSchema<S>>
where S::OutputSchema: IsUnset,

Optional (Some / Option setters).

Source

pub fn timeout(self, value: Duration) -> TurnOptionsBuilder<SetTimeout<S>>
where S::Timeout: IsUnset,

Optional (Some / Option setters). Maximum duration for this turn. If exceeded, the subprocess is killed and AgentError::Timeout is returned.

Source

pub fn maybe_timeout( self, value: Option<Duration>, ) -> TurnOptionsBuilder<SetTimeout<S>>
where S::Timeout: IsUnset,

Optional (Some / Option setters). Maximum duration for this turn. If exceeded, the subprocess is killed and AgentError::Timeout is returned.

Source

pub fn tools( self, value: Vec<ToolDefinition>, ) -> TurnOptionsBuilder<SetTools<S>>
where S::Tools: IsUnset,

Optional (Some / Option setters). Default: <Vec<ToolDefinition> as Default>::default().

Tools available to the model for this turn.

Source

pub fn maybe_tools( self, value: Option<Vec<ToolDefinition>>, ) -> TurnOptionsBuilder<SetTools<S>>
where S::Tools: IsUnset,

Optional (Some / Option setters). Default: <Vec<ToolDefinition> as Default>::default().

Tools available to the model for this turn.

Source

pub fn tool_choice( self, value: ToolChoice, ) -> TurnOptionsBuilder<SetToolChoice<S>>
where S::ToolChoice: IsUnset,

Optional (Some / Option setters). Tool selection policy. None lets the backend decide.

Source

pub fn maybe_tool_choice( self, value: Option<ToolChoice>, ) -> TurnOptionsBuilder<SetToolChoice<S>>
where S::ToolChoice: IsUnset,

Optional (Some / Option setters). Tool selection policy. None lets the backend decide.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.