Struct FunctionModel 

pub struct FunctionModel { /* private fields */ }

Deterministic model backed by a caller-provided function.

Implementations

impl FunctionModel

pub fn new<F>(function: F) -> Self

where F: Send + Sync + 'static + Fn(Vec<ModelMessage>, Option<ModelSettings>, FunctionModelInfo) -> Result<ModelResponse, ModelError>,

Create a function-backed model.

pub fn streaming<F>(function: F) -> Self

where F: Send + Sync + 'static + Fn(Vec<ModelMessage>, Option<ModelSettings>, FunctionModelInfo) -> Result<Vec<ModelResponseStreamEvent>, ModelError>,

Create a function-backed streaming model.

pub fn with_model_name(self, model_name: impl Into<String>) -> Self

Set model name.

pub fn with_profile(self, profile: ModelProfile) -> Self

Set model profile.

pub fn with_default_settings(self, settings: ModelSettings) -> Self

Set model default settings.

pub fn captured_messages(&self) -> Vec<Vec<ModelMessage>>

Return captured request histories.

pub fn captured_params(&self) -> Vec<ModelRequestParameters>

Return captured request parameters.

Trait Implementations

impl Clone for FunctionModel

fn clone(&self) -> FunctionModel

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ModelAdapter for FunctionModel

fn model_name(&self) -> &str

Provider model name.

fn provider_name(&self) -> Option<&str>

Provider name.

fn profile(&self) -> &ModelProfile

Model capability profile.

fn default_settings(&self) -> Option<&ModelSettings>

Default generation settings.

fn request<'life0, 'async_trait>( &'life0 self, messages: Vec<ModelMessage>, settings: Option<ModelSettings>, params: ModelRequestParameters, context: ModelRequestContext, ) -> Pin<Box<dyn Future<Output = Result<ModelResponse, ModelError>> + Send + 'async_trait>>

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

Perform a complete model request.

fn request_stream<'life0, 'async_trait>( &'life0 self, messages: Vec<ModelMessage>, settings: Option<ModelSettings>, params: ModelRequestParameters, context: ModelRequestContext, ) -> Pin<Box<dyn Future<Output = Result<Vec<ModelResponseStreamEvent>, ModelError>> + Send + 'async_trait>>

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

Stream a model request as canonical response part deltas.

fn request_stream_incremental<'life0, 'async_trait>( &'life0 self, messages: Vec<ModelMessage>, settings: Option<ModelSettings>, params: ModelRequestParameters, context: ModelRequestContext, ) -> Pin<Box<dyn Future<Output = Result<ModelResponseEventStream, ModelError>> + Send + 'async_trait>>

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

Stream a model request and yield canonical events as they arrive.

fn start_run_session(&self) -> Box<dyn ModelRunSession + '_>

Create a run-scoped session for agent loops that may issue multiple model requests.

fn request_stream_final<'life0, 'async_trait>( &'life0 self, messages: Vec<ModelMessage>, settings: Option<ModelSettings>, params: ModelRequestParameters, context: ModelRequestContext, ) -> Pin<Box<dyn Future<Output = Result<ModelResponse, ModelError>> + Send + 'async_trait>>

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

Stream a model request and return the assembled final response.

fn count_tokens<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, _messages: &'life1 [ModelMessage], _settings: Option<&'life2 ModelSettings>, _params: &'life3 ModelRequestParameters, ) -> Pin<Box<dyn Future<Output = Result<Usage, ModelError>> + Send + 'async_trait>>

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

Count tokens for a request where provider support exists.