Skip to main content

OpenAiConfig

Struct OpenAiConfig 

Source
pub struct OpenAiConfig {
    pub base_url: String,
    pub api_key: Option<String>,
    pub auth: AuthStyle,
    pub headers: Vec<(String, String)>,
    pub query: Vec<(String, String)>,
    pub include_usage: bool,
    pub use_max_completion_tokens: bool,
    pub connect_timeout: Duration,
    pub credentials: Option<Arc<dyn CredentialSource>>,
    pub credential_name: String,
}
Expand description

Configuration of an OpenAI-compatible endpoint.

Fields§

§base_url: String

Base URL without the /chat/completions suffix, e.g. https://api.openai.com/v1.

§api_key: Option<String>§auth: AuthStyle§headers: Vec<(String, String)>

Extra headers sent with every request.

§query: Vec<(String, String)>

Extra query parameters (e.g. api-version).

§include_usage: bool

Ask for a final usage chunk (stream_options.include_usage). Disable for endpoints that reject the field.

§use_max_completion_tokens: bool

Send max_completion_tokens instead of max_tokens (required by some newer models).

§connect_timeout: Duration§credentials: Option<Arc<dyn CredentialSource>>

Per-request credential source. When set it replaces api_key; its headers are appended and its base_url, if any, overrides base_url. A 401/403 response invalidates the credential and the request is retried once.

§credential_name: String

Provider name passed to the credential source (default openai).

Implementations§

Source§

impl OpenAiConfig

Source

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

Source

pub fn with_credentials(self, source: Arc<dyn CredentialSource>) -> Self

Ask source for a credential before every request (see crate::credentials).

Source

pub fn credential_name(self, name: impl Into<String>) -> Self

Provider name passed to the credential source.

Trait Implementations§

Source§

impl Clone for OpenAiConfig

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 OpenAiConfig

Source§

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

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

impl Default for OpenAiConfig

Source§

fn default() -> Self

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

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