Skip to main content

RunSpec

Struct RunSpec 

Source
pub struct RunSpec {
Show 19 fields pub preamble: Option<String>, pub static_context: Vec<Document>, pub additional_params: Option<Value>, pub provider_tools: Vec<ProviderToolDefinition>, pub options: GenerationOptions, pub provider_options: ProviderOptions, pub max_tokens: Option<u64>, pub temperature: Option<f64>, pub tool_choice: Option<ToolChoice>, pub max_turns: Option<usize>, pub max_invalid_tool_call_retries: usize, pub max_consecutive_malformed_tool_calls: Option<usize>, pub output_schema: Option<Schema>, pub output_mode: OutputMode, pub output_tool_name: Option<String>, pub output_tool_description: Option<String>, pub augment_output_preamble: bool, pub unhandled_invalid_tool_call: UnhandledInvalidToolCall, pub accept_unknown_finish_reasons: bool,
}
Expand description

Protocol-facing run configuration. See the module docs. Default equals RunSpec::new, and a field missing from serialized input takes its value from there.

Fields§

§preamble: Option<String>

System prompt.

§static_context: Vec<Document>

Documents always attached to the request.

§additional_params: Option<Value>

Provider-specific request parameters, merged into every request.

§provider_tools: Vec<ProviderToolDefinition>

Provider-hosted tools every request carries, appended to additional_params.tools after the patch is merged. Omitted from the serialized spec while empty.

§options: GenerationOptions

Portable generation options every request carries. Omitted from the serialized spec while they hold their defaults.

§provider_options: ProviderOptions

Typed per-provider options every request carries. Omitted from the serialized spec while empty.

§max_tokens: Option<u64>

Maximum tokens the model may generate per call.

§temperature: Option<f64>

Sampling temperature.

§tool_choice: Option<ToolChoice>

Tool choice applied to every model call.

§max_turns: Option<usize>

Total model-call budget for the run. None means the protocol default of one call.

§max_invalid_tool_call_retries: usize

How many times an invalid model tool call may be retried with feedback.

§max_consecutive_malformed_tool_calls: Option<usize>

How many consecutive turns may call a tool with arguments that are not a JSON object. Each such call is answered with feedback; a turn whose calls all parse resets the count. Past Some(n) such turns in a row, the run fails. None, the default, sets no limit.

§output_schema: Option<Schema>

JSON schema the final answer must satisfy, when structured output is requested.

§output_mode: OutputMode

How structured output is obtained.

§output_tool_name: Option<String>

Name of the synthetic output tool when output is collected through a tool call; None lets the driver pick.

§output_tool_description: Option<String>

Description of that synthetic tool.

§augment_output_preamble: bool

Whether the driver may augment the preamble with structured-output instructions.

§unhandled_invalid_tool_call: UnhandledInvalidToolCall

What the run does with a model tool call that cannot be dispatched as written when no hook resolves it.

§accept_unknown_finish_reasons: bool

Whether a finish reason outside the normalized vocabulary ends a turn as a normal stop. Carried into every prepared request. Defaults to false.

Implementations§

Source§

impl RunSpec

Source

pub fn new() -> Self

Create a spec with a one-call budget, no preamble, tool choice, or schema, and output-preamble augmentation enabled.

Source

pub fn effective_max_turns(&self) -> usize

The turn budget the protocol will use.

Source§

impl RunSpec

Source

pub const DEFAULT_OUTPUT_RETRIES: usize = 1

How many times a run re-prompts for structured output that failed validation before giving up. The default a run built from a spec carries; drivers that construct runs by hand pass it explicitly.

Trait Implementations§

Source§

impl Clone for RunSpec

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 Debug for RunSpec

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RunSpec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RunSpec

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for RunSpec

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for RunSpec

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RunSpec

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> 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> WasmCompatSend for T
where T: Send,

Source§

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

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