Struct AddToolInputExamplesMiddleware 

pub struct AddToolInputExamplesMiddleware { /* private fields */ }

Middleware that serializes tool.input_examples (if any) and appends them to the tool’s description field.

Default layout mirrors @ai-sdk/ai/src/middleware/add-tool-input-examples-middleware.ts: "{description}\n\n{prefix}\n{example_1}\n{example_2}..." where prefix defaults to "Input Examples:" and each example is JSON.stringify(example.input) (no enumeration prefix). Override with Self::with_prefix to customise the header line or Self::with_formatter to take full control.

Implementations

impl AddToolInputExamplesMiddleware

pub fn new() -> Self

Build with the upstream-aligned defaults.

The default prefix is "Input Examples:" and the default remove is true, matching upstream add-tool-input-examples-middleware.ts so the rewritten tool no longer carries the now-redundant input_examples field on the wire.

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Override the header line prepended before the serialized examples. Mirrors upstream prefix option (default "Input Examples:").

pub fn with_formatter<F>(self, formatter: F) -> Self

where F: Fn(&ToolInputExample, usize) -> String + Send + Sync + 'static,

Override how each example is rendered. The formatter receives the example and its zero-based index, mirroring upstream (example, index) => string (@ai-sdk/ai/src/middleware/add-tool-input-examples-middleware.ts:46).

pub fn with_remove(self, remove: bool) -> Self

Toggle whether input_examples is cleared after being appended.

Mirrors upstream remove?: boolean option (default true). When true, the rewritten function tool drops its input_examples so the downstream provider does not re-serialize them on the wire after they have already been folded into description. Set to false to keep the structured field alongside the textual description.

Trait Implementations

impl Debug for AddToolInputExamplesMiddleware

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

Formats the value using the given formatter.

impl Default for AddToolInputExamplesMiddleware

fn default() -> Self

Returns the “default value” for a type.

impl LanguageModelMiddleware for AddToolInputExamplesMiddleware

fn transform_params<'life0, 'life1, 'async_trait>( &'life0 self, _kind: CallKind, params: CallOptions, _inner: &'life1 dyn LanguageModel, ) -> Pin<Box<dyn Future<Output = Result<CallOptions>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Transform the call options before they reach the inner model.

fn override_provider(&self, _inner: &dyn LanguageModel) -> Option<String>

Override the provider id exposed by the wrapped model.

fn override_model_id(&self, _inner: &dyn LanguageModel) -> Option<String>

Override the model id exposed by the wrapped model.

fn override_supported_urls<'life0, 'life1, 'async_trait>( &'life0 self, _inner: &'life1 dyn LanguageModel, ) -> Pin<Box<dyn Future<Output = Option<SupportedUrls>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Override the supported-URL map exposed by the wrapped model.

fn wrap_generate<'life0, 'life1, 'async_trait>( &'life0 self, next: &'life1 dyn LanguageModel, params: CallOptions, ) -> Pin<Box<dyn Future<Output = Result<GenerateResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Wrap a non-streaming generation.

fn wrap_stream<'life0, 'life1, 'async_trait>( &'life0 self, next: &'life1 dyn LanguageModel, params: CallOptions, ) -> Pin<Box<dyn Future<Output = Result<StreamResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Wrap a streaming generation.