Skip to main content

OpenAiProvider

Struct OpenAiProvider 

Source
pub struct OpenAiProvider { /* private fields */ }
Expand description

Client for the OpenAI Chat Completions API (POST {base_url}/chat/completions).

The same wire format is served by many other providers; use the presets (groq, mistral, deepseek, xai, openrouter, together, fireworks, perplexity, azure, ollama, lm_studio) or with_base_url for anything else (vLLM, LiteLLM, …).

Implementations§

Source§

impl OpenAiProvider

Source

pub fn new(api_key: impl Into<String>) -> Self

Source

pub fn groq(api_key: impl Into<String>) -> Self

Groq: https://api.groq.com/openai/v1.

Source

pub fn mistral(api_key: impl Into<String>) -> Self

Mistral AI: https://api.mistral.ai/v1.

Source

pub fn deepseek(api_key: impl Into<String>) -> Self

DeepSeek: https://api.deepseek.com/v1.

Source

pub fn xai(api_key: impl Into<String>) -> Self

xAI (Grok): https://api.x.ai/v1.

Source

pub fn openrouter(api_key: impl Into<String>) -> Self

OpenRouter: https://openrouter.ai/api/v1.

Source

pub fn together(api_key: impl Into<String>) -> Self

Together AI: https://api.together.xyz/v1.

Source

pub fn fireworks(api_key: impl Into<String>) -> Self

Fireworks AI: https://api.fireworks.ai/inference/v1.

Source

pub fn perplexity(api_key: impl Into<String>) -> Self

Perplexity: https://api.perplexity.ai.

Source

pub fn azure(resource: &str, api_key: impl Into<String>) -> Self

Azure OpenAI v1 API: https://{resource}.openai.azure.com/openai/v1, key in the api-key header. Pass the deployment name as the model.

Source

pub fn ollama() -> Self

Ollama on this machine: http://localhost:11434/v1, no key.

Source

pub fn lm_studio() -> Self

LM Studio on this machine: http://localhost:1234/v1, no key.

Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Points the client at another server. The key may be empty if the server does not need one.

Source

pub fn with_client(self, client: Client) -> Self

Uses your own reqwest::Client, for example to share a connection pool or set a proxy.

Trait Implementations§

Source§

impl Clone for OpenAiProvider

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 OpenAiProvider

Source§

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

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

impl LlmProvider for OpenAiProvider

Source§

fn chat<'life0, 'life1, 'async_trait>( &'life0 self, req: &'life1 ChatRequest, ) -> Pin<Box<dyn Future<Output = Result<ChatResponse>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

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> 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, 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> PolicyExt for T
where T: ?Sized,

Source§

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
Source§

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
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> 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