Skip to main content

PreparedCall

ferrin_core::agent

Struct PreparedCall

pub struct PreparedCall {Show 16 fields
    pub input: AgentInput,
    pub instructions: Option<Instructions>,
    pub allow_system_in_messages: bool,
    pub model: LanguageModelRef,
    pub tools: ToolSet,
    pub tool_choice: Option<ToolChoice>,
    pub active_tools: Option<Vec<ToolName>>,
    pub tool_order: Vec<ToolName>,
    pub tools_context: Option<JsonValue>,
    pub settings: CallSettings,
    pub stop_conditions: Vec<Arc<dyn StopCondition>>,
    pub timeout: Timeout,
    pub retry_policy: RetryPolicy,
    pub include: Include,
    pub max_tool_concurrency: Option<usize>,
    pub telemetry: TelemetryOptions,
}

Expand description

The effective settings of one call, as seen by PrepareCall.

Every field starts with the agent’s configuration (with the call’s input and timeout applied); the prepare function may rewrite any of them. None means “not set”.

Fields§

§input: AgentInput

The prompt or conversation.

§instructions: Option<Instructions>

System instructions.

§allow_system_in_messages: bool

Whether system messages are allowed inside the conversation.

§model: LanguageModelRef

The model.

§tools: ToolSet

The tools.

§tool_choice: Option<ToolChoice>

Tool choice.

§active_tools: Option<Vec<ToolName>>

Tools sent to the model (all when None).

§tool_order: Vec<ToolName>

Tool order sent to the model.

§tools_context: Option<JsonValue>

Shared tool context.

§settings: CallSettings

Sampling settings, headers and provider options.

§stop_conditions: Vec<Arc<dyn StopCondition>>

Stop conditions (default: twenty steps).

§timeout: Timeout

Timeouts.

§retry_policy: RetryPolicy

Retry policy.

§include: Include

Payloads copied into step results.

§max_tool_concurrency: Option<usize>

Tool concurrency limit.

§telemetry: TelemetryOptions

Telemetry options.

Trait Implementations§

impl Clone for PreparedCall

fn clone(&self) -> PreparedCall

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

impl Debug for PreparedCall

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl !RefUnwindSafe for PreparedCall

impl !UnwindSafe for PreparedCall

impl Freeze for PreparedCall

impl Send for PreparedCall

impl Sync for PreparedCall

impl Unpin for PreparedCall

impl UnsafeUnpin for PreparedCall

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

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

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

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

fn into(self) -> U

Calls U::from(self).

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

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

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

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

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

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