Struct OpenAIModelProviderConfig
pub struct OpenAIModelProviderConfig {
pub base: ModelProviderConfig,
}Expand description
OpenAI model model_provider config. The OpenAI-family extras (wire_api,
requires_openai_auth) live on the shared ModelProviderConfig base
because they’re consumed by validation and runtime helpers that operate
on the base struct without family awareness; this wrapper is a thin
typed slot, no extra fields.
New OpenAI provider entries persisted via create_map_key / ensure
(quickstart, gateway/config UI, programmatic slot creation) default to
wire_api = "responses" because OpenAI has moved recent GPT models onto
POST /v1/responses as the primary wire. OpenAI-compatible families
(custom, llamacpp, branded vendors, …) keep the shared
ModelProviderConfig default of unset / chat-completions.
This default governs persisted slot creation only. Two paths keep the legacy chat-completions wire for backward compatibility:
- Existing persisted configs that omit
wire_apideserialize asNone, and the factory falls back to chat-completions. - Implicit dispatch with no config entry at all — a bare
model_provider = "openai"reference or a dotted ref to a nonexistent alias — is built from a chat-anchored fallback config (seeopenai_missing_entry_fallback_configinzeroclaw-providers), not thisDefault, and stays on the chat wire so existing bare-ref installs don’t flip wire + tool-calling mode on upgrade.
Fields§
§base: ModelProviderConfigImplementations§
Source§impl OpenAIModelProviderConfig
impl OpenAIModelProviderConfig
Sourcepub fn configurable_prefix() -> &'static str
pub fn configurable_prefix() -> &'static str
Returns the #[prefix] value for this Configurable struct.
Sourcepub fn secret_fields(&self) -> Vec<SecretFieldInfo>
pub fn secret_fields(&self) -> Vec<SecretFieldInfo>
Returns metadata about all #[secret] fields on this struct and nested children.
pub fn secret_field_terminals() -> Vec<&'static str>
Sourcepub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
pub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
Encrypt all secret fields in place using the provided store.
Sourcepub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
pub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
Decrypt all secret fields in place using the provided store.
Sourcepub fn set_secret(&mut self, name: &str, value: String) -> Result<()>
pub fn set_secret(&mut self, name: &str, value: String) -> Result<()>
Set a secret field by its full dotted name, dispatching to nested children.
Sourcepub fn prop_fields(&self) -> Vec<PropFieldInfo>
pub fn prop_fields(&self) -> Vec<PropFieldInfo>
Returns metadata about all property fields on this struct and nested children.
Sourcepub fn get_prop(&self, name: &str) -> Result<String>
pub fn get_prop(&self, name: &str) -> Result<String>
Get a property value by its full dotted name, returning it as a display string.
Sourcepub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<()>
pub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<()>
Set a property value by its full dotted name, parsing from string.
Sourcepub fn prop_is_secret(name: &str) -> bool
pub fn prop_is_secret(name: &str) -> bool
Check if a property name refers to a secret field (static, no instance needed).
Sourcepub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>
pub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>
Instantiate None nested sections whose prefix matches.
Returns the prefixes that were initialized.
Sourcepub fn map_key_sections() -> Vec<MapKeySection>
pub fn map_key_sections() -> Vec<MapKeySection>
Enumerate every map-keyed (HashMap<String, T>) and list-shaped
(Vec<T>) section discoverable from this Configurable’s tree.
The dashboard / CLI consume this to surface “+ Add” affordances
without hardcoding the section list.
Sourcepub fn nested_section_help(name: &str) -> Option<&'static str>
pub fn nested_section_help(name: &str) -> Option<&'static str>
Help blurb for a #[nested] field on this struct, sourced from
the field-level /// docstring. Returns None for unknown
names so callers can fall through to a different lookup.
pub fn nested_section_group(name: &str) -> Option<&'static str>
Sourcepub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>
pub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>
Return the current alias keys at section_path, or None if
the path doesn’t resolve to a map-keyed section in this tree.
pub fn nested_option_entries(&self) -> Vec<NestedOptionEntry>
pub fn create_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>
pub fn delete_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>
pub fn rename_map_key( &mut self, section_path: &str, map_key: &str, new_key: &str, ) -> Result<bool, String>
Trait Implementations§
Source§impl Clone for OpenAIModelProviderConfig
impl Clone for OpenAIModelProviderConfig
Source§fn clone(&self) -> OpenAIModelProviderConfig
fn clone(&self) -> OpenAIModelProviderConfig
1.0.0 (const: unstable) · §fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for OpenAIModelProviderConfig
impl Debug for OpenAIModelProviderConfig
Source§impl Default for OpenAIModelProviderConfig
impl Default for OpenAIModelProviderConfig
Source§impl<'de> Deserialize<'de> for OpenAIModelProviderConfig
impl<'de> Deserialize<'de> for OpenAIModelProviderConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl FamilyEndpoint for OpenAIModelProviderConfig
impl FamilyEndpoint for OpenAIModelProviderConfig
fn endpoint_uri(&self) -> Option<&'static str>
Source§impl JsonSchema for OpenAIModelProviderConfig
impl JsonSchema for OpenAIModelProviderConfig
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl MaskSecrets for OpenAIModelProviderConfig
impl MaskSecrets for OpenAIModelProviderConfig
fn mask_secrets(&mut self)
fn restore_secrets_from(&mut self, current: &Self)
Auto Trait Implementations§
impl Freeze for OpenAIModelProviderConfig
impl RefUnwindSafe for OpenAIModelProviderConfig
impl Send for OpenAIModelProviderConfig
impl Sync for OpenAIModelProviderConfig
impl Unpin for OpenAIModelProviderConfig
impl UnsafeUnpin for OpenAIModelProviderConfig
impl UnwindSafe for OpenAIModelProviderConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more