Struct OpenAiProvider 

pub struct OpenAiProvider { /* private fields */ }

Implementations

impl OpenAiProvider

pub fn new( base_url: impl Into<String>, api_key: impl Into<String>, model: impl Into<String>, ) -> Result<Self>

pub fn with_search_engine(self, engine: Arc<dyn ToolSearchEngine>) -> Self

Replace the search engine used to resolve ToolSearchTool queries.

pub fn with_max_search_rounds(self, n: usize) -> Self

Set the maximum number of ToolSearchTool round-trips per complete_with_search / stream_with_search call.

pub fn with_stream_tx(self, tx: StreamSender) -> Self

Enable streaming by providing a channel sender for partial tokens.

pub fn with_temperature(self, t: f64) -> Self

pub fn with_max_tokens(self, n: u32) -> Self

pub fn with_retry_policy(self, policy: RetryPolicy) -> Self

Trait Implementations

impl ChatProvider for OpenAiProvider

fn complete<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, messages: &'life1 [Message], tools: &'life2 [ToolSpec], ) -> Pin<Box<dyn Future<Output = Result<Completion>> + Send + 'async_trait>>

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

fn complete_structured<'life0, 'async_trait>( &'life0 self, req: StructuredRequest, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

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

Request a JSON response conforming to a caller-supplied schema. Default impl returns an error. Providers that support structured output (e.g. OpenAI-compatible) override this.

fn complete_with_search<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [Message], eager_tools: &'life2 [SpecWithHint], deferred_tools: &'life3 [SpecWithHint], ) -> Pin<Box<dyn Future<Output = Result<Completion>> + Send + 'async_trait>>

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

Variant that accepts a partition between eager and deferred tools. Providers that support native deferred loading (e.g. Anthropic via defer_loading: true + tool_reference content blocks) override this. The default implementation concatenates the two lists (dropping the hints) and calls complete() — i.e., it ignores the partition and behaves identically to the legacy interface.

fn stream_with_search<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, messages: &'life1 [Message], eager_tools: &'life2 [SpecWithHint], deferred_tools: &'life3 [SpecWithHint], stream_tx: Option<StreamSender>, cancel_token: Option<CancellationToken>, ) -> Pin<Box<dyn Future<Output = Result<Completion>> + Send + 'async_trait>>

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

Search-aware streaming: model sees eager tools + ToolSearchTool; deferred tools become available only after the model requests them.

fn stream<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, messages: &'life1 [Message], tools: &'life2 [ToolSpec], stream_tx: Option<StreamSender>, cancel_token: Option<CancellationToken>, ) -> Pin<Box<dyn Future<Output = Result<Completion>> + Send + 'async_trait>>

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

Stream a completion token-by-token.

fn supports_deferred_tools(&self) -> bool

Whether this provider supports deferred tool loading via tool_reference content blocks (Anthropic API feature).

fn complete_simple<'life0, 'life1, 'async_trait>( &'life0 self, prompt: &'life1 str, _temperature: f32, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

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

Simple completion with a single user prompt.

impl Clone for OpenAiProvider

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OpenAiProvider

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

Formats the value using the given formatter.