Skip to main content

OpenAiModelConfig

Struct OpenAiModelConfig 

Source
pub struct OpenAiModelConfig {
    pub model: String,
    pub base_url: String,
    pub backend: OpenAiBackend,
    pub bearer: String,
    pub max_tokens_cap: u32,
    pub reasoning_summary: Option<String>,
    pub prompt_cache_key: Option<String>,
    pub custom_tools_supported: bool,
    pub system_placement: SystemPlacement,
    pub extra_headers: Vec<(String, String)>,
    pub provider_prefs: Option<Value>,
}
Expand description

The per-model config record for the OpenAI wire family (plan §3.2 + §A.5).

Fields§

§model: String

The model id (gpt-… native; openai/…/x-ai/… via OpenRouter).

§base_url: String

The endpoint base URL (the wire appends its request path).

§backend: OpenAiBackend

The endpoint family — quirks only (auth is always Bearer).

§bearer: String

The bearer credential.

§max_tokens_cap: u32

Clamp for max_output_tokens (which includes reasoning tokens).

§reasoning_summary: Option<String>

reasoning.summary request value. Default Some("auto") (plan §A.5 Q2: trace readability); None omits the field for score-only runs.

§prompt_cache_key: Option<String>

prompt_cache_key — the facade passes the session id (plan §A.5 Q4; codex’s behavior; probe P6 confirmed harmless for xAI models).

§custom_tools_supported: bool

Whether the target model/provider accepts type:"custom" tools. Manual flag (plan §A.5 Q5 — no model-id sniffing): xAI 422s them (probe P3); false degrades freeform specs to the {"input": string} function framing on both the tools array and the call/replay items.

§system_placement: SystemPlacement

Where Role::System goes: codex’s top-level instructions (default) or grok’s in-stream role:"system" message.

§extra_headers: Vec<(String, String)>

Extra headers appended to every request.

§provider_prefs: Option<Value>

OpenRouter routing preferences; None → the default pair (allow_fallbacks:false, require_parameters:true) on OpenRouter.

Implementations§

Source§

impl OpenAiModelConfig

Source

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

Build a config, detecting the backend from base_url.

Source

pub fn from_env() -> Result<Self, ProviderError>

Resolve from the environment: LOCODE_API_KEY (required), LOCODE_BASE_URL (default native). The model defaults to DEFAULT_OPENAI_MODEL (namespaced openai/… on OpenRouter) — select it via --model/settings (ADR-0024 §1.4), not env.

§Errors

ProviderError::Auth when LOCODE_API_KEY is unset or empty.

Source

pub fn effective_provider_prefs(&self) -> Option<Value>

The OpenRouter provider preferences to inject, if any: the configured value, or {allow_fallbacks:false} on the OpenRouter backend.

require_parameters is deliberately absent (live finding, 2026-07-19): on the beta /v1/responses endpoint, require_parameters: true combined with a tools array 404s with “No endpoints found that can handle the requested parameters” — OpenRouter’s parameter registry does not count tools as supported there. The silent-param-drop protection it provided on the Messages endpoint is covered here by the live smokes instead.

Trait Implementations§

Source§

impl Clone for OpenAiModelConfig

Source§

fn clone(&self) -> OpenAiModelConfig

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 OpenAiModelConfig

Source§

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

Formats the value using the given formatter. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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