Struct ModelPreset 

pub struct ModelPreset {

    pub id: String,
    pub model: String,
    pub display_name: String,
    pub description: String,
    pub default_reasoning_effort: ReasoningEffort,
    pub supported_reasoning_efforts: Vec<ReasoningEffortPreset>,
    pub supports_personality: bool,
    pub additional_speed_tiers: Vec<String>,
    pub service_tiers: Vec<ModelServiceTier>,
    pub default_service_tier: Option<String>,
    pub is_default: bool,
    pub upgrade: Option<ModelUpgrade>,
    pub show_in_picker: bool,
    pub multi_agent_version: Option<MultiAgentVersion>,
    pub availability_nux: Option<ModelAvailabilityNux>,
    pub supported_in_api: bool,
    pub input_modalities: Vec<InputModality>,
}

Metadata describing a Codex-supported model.

Fields

id: String

Stable identifier for the preset.

model: String

Model slug (e.g., “gpt-5”).

display_name: String

Display name shown in UIs.

description: String

Short human description shown in UIs.

default_reasoning_effort: ReasoningEffort

Reasoning effort applied when none is explicitly chosen.

supported_reasoning_efforts: Vec<ReasoningEffortPreset>

Supported reasoning effort options.

supports_personality: bool

Whether this model supports personality-specific instructions.

additional_speed_tiers: Vec<String>

Deprecated: use service_tiers instead.

service_tiers: Vec<ModelServiceTier>

Service tiers this model can run with.

default_service_tier: Option<String>

Catalog default service tier id for this model.

is_default: bool

Whether this is the default model for new users.

upgrade: Option<ModelUpgrade>

recommended upgrade model

show_in_picker: bool

Whether this preset should appear in the picker UI.

multi_agent_version: Option<MultiAgentVersion>

Multi-agent backend selected when this model starts a new thread.

availability_nux: Option<ModelAvailabilityNux>

Availability NUX shown when this preset becomes accessible to the user.

supported_in_api: bool

whether this model is supported in the api

input_modalities: Vec<InputModality>

Input modalities accepted when composing user turns for this preset.

Implementations

impl ModelPreset

pub fn supports_fast_mode(&self) -> bool

impl ModelPreset

pub fn filter_by_auth( models: Vec<ModelPreset>, chatgpt_mode: bool, ) -> Vec<ModelPreset>

Filter models based on authentication mode.

In ChatGPT mode, all models are visible. Otherwise, only API-supported models are shown.

pub fn mark_default_by_picker_visibility(models: &mut [ModelPreset])

Recompute the single default preset using picker visibility.

The first picker-visible model wins; if none are picker-visible, the first model wins.

Trait Implementations

impl Clone for ModelPreset

fn clone(&self) -> ModelPreset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelPreset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelPreset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ModelInfo> for ModelPreset

fn from(info: ModelInfo) -> Self

Converts to this type from the input type.

impl JsonSchema for ModelPreset

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for ModelPreset

fn eq(&self, other: &ModelPreset) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ModelPreset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ModelPreset

impl TS for ModelPreset

type WithoutGenerics = ModelPreset

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or (). The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = ModelPreset

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident() -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name() -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete() -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl() -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline() -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened() -> String

Flatten a type declaration.
This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.
The returned path does not include the base directory from TS_RS_EXPORT_DIR.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies() -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all() -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_all_to(out_dir: impl AsRef<Path>) -> Result<(), ExportError>

where Self: 'static,

Manually export this type into the given directory, together with all of its dependencies.
To export only this type, without its dependencies, use TS::export.

fn export_to_string() -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String.
This function does not format the output, even if the format feature is enabled.

fn default_output_path() -> Option<PathBuf>

Returns the output path to where T should be exported.