ooai_llm.model_suites

Reusable model suites for comparisons and multi-model workflows.

Purpose:

Build configurable shortlists of models that can be iterated, serialized, converted to profiles, or materialized as LangChain chat models/runtimes.

Attributes

ModelSuiteStyle
ModelSuiteName
ModelSuiteRoleName
DEFAULT_MODEL_SUITE_PRESETS
COMPARISON_MODEL_SUITE_PRESETS
TESTING_MODEL_SUITE_PRESETS
ALL_MODEL_SUITE_PRESETS

Classes

ModelSuiteEntry	One named model option inside a reusable suite.
ModelSuite	A named, iterable set of model options.

Functions

list_model_suite_names(→ list[str])	Return built-in suite names.
get_model_suite(→ ModelSuite)	Build a named suite from configured provider presets.
model_suite_from_presets(→ ModelSuite)	Build a suite from AppSettings provider presets.
model_suite_from_catalog(→ ModelSuite)	Build a suite from filtered catalog rows.

Module Contents

ooai_llm.model_suites.ModelSuiteStyle

ooai_llm.model_suites.ModelSuiteName

ooai_llm.model_suites.ModelSuiteRoleName

ooai_llm.model_suites.DEFAULT_MODEL_SUITE_PRESETS: tuple[ooai_llm.settings.ModelPresetName, Ellipsis] = ('cheap', 'balanced', 'reasoning')

ooai_llm.model_suites.COMPARISON_MODEL_SUITE_PRESETS: tuple[ooai_llm.settings.ModelPresetName, Ellipsis] = ('cheap', 'fast', 'balanced', 'reasoning', 'coding')

ooai_llm.model_suites.TESTING_MODEL_SUITE_PRESETS: tuple[ooai_llm.settings.ModelPresetName, Ellipsis] = ('testing',)

ooai_llm.model_suites.ALL_MODEL_SUITE_PRESETS: tuple[ooai_llm.settings.ModelPresetName, Ellipsis] = ('default', 'latest', 'cheap', 'testing', 'fast', 'balanced', 'reasoning', 'coding', 'vision')

class ooai_llm.model_suites.ModelSuiteEntry(/, **data: Any)

Bases: pydantic.BaseModel

One named model option inside a reusable suite.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

key: str

model: ooai_llm.types.ModelString

role: ModelSuiteRoleName = 'custom'

label: str | None = None

description: str | None = None

capabilities: list[str] = None

reasoning: ooai_llm.reasoning.ReasoningInput = None

profile_kwargs: dict[str, Any] = None

tags: list[str] = None

metadata: dict[str, Any] = None

cost_labels: dict[str, str] = None

cache: ooai_llm.profiles.CacheKeyPolicy | bool | None = None

property provider: ooai_llm.providers.Provider | None

Return the model provider when known.

model_name(*, style: ModelSuiteStyle = 'langchain') → str

Return the model string in the requested style.

to_profile(**overrides: Any) → ooai_llm.profiles.ChatModelProfile

Convert this suite entry into a serializable chat-model profile.

create_llm(*, settings: ooai_llm.settings.AppSettings | None = None, **overrides: Any) → Any

Create a LangChain chat model for this entry.

create_runtime(*, settings: ooai_llm.settings.AppSettings | None = None, id: str | None = None, **overrides: Any) → ooai_llm.profiles.LLM

Create an LLM runtime for this entry.

class ooai_llm.model_suites.ModelSuite(/, **data: Any)

Bases: pydantic.BaseModel

A named, iterable set of model options.

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str

description: str | None = None

entries: list[ModelSuiteEntry] = None

notes: list[str] = None

__iter__() → collections.abc.Iterator[ModelSuiteEntry]

Iterate over suite entries.

__len__() → int

Return the number of entries.

__getitem__(key: int | str) → ModelSuiteEntry

Get an entry by index or key.

property providers: list[str]

Return providers represented in the suite.

model_list(*, style: ModelSuiteStyle = 'langchain') → list[str]

Return suite models as an ordered list of strings.

model_dict(*, style: ModelSuiteStyle = 'langchain') → dict[str, str]

Return suite models keyed by entry key.

entry_dict() → dict[str, ModelSuiteEntry]

Return full suite entries keyed by entry key.

by_provider() → dict[str, list[ModelSuiteEntry]]

Group entries by provider.

filter(*, providers: collections.abc.Iterable[ooai_llm.providers.Provider | str] | None = None, roles: collections.abc.Iterable[ModelSuiteRoleName | str] | None = None, capabilities: collections.abc.Iterable[str] | None = None, keys: collections.abc.Iterable[str] | None = None) → ModelSuite

Return a filtered copy of this suite.

to_profiles(**overrides: Any) → dict[str, ooai_llm.profiles.ChatModelProfile]

Convert every entry into a chat-model profile.

create_llms(*, settings: ooai_llm.settings.AppSettings | None = None, **overrides: Any) → dict[str, Any]

Create LangChain chat models for every suite entry.

create_runtimes(*, settings: ooai_llm.settings.AppSettings | None = None, **overrides: Any) → dict[str, ooai_llm.profiles.LLM]

Create LLM runtimes for every suite entry.

ooai_llm.model_suites.list_model_suite_names() → list[str]

Return built-in suite names.

ooai_llm.model_suites.get_model_suite(name: ModelSuiteName | str = 'practical', *, settings: ooai_llm.settings.AppSettings | None = None, providers: collections.abc.Iterable[ooai_llm.providers.Provider | str] | None = None, presets: collections.abc.Iterable[ooai_llm.settings.ModelPresetName] | None = None, temperature: float | None = None, parallel_tool_calls: bool | None = None) → ModelSuite

Build a named suite from configured provider presets.

ooai_llm.model_suites.model_suite_from_presets(*, settings: ooai_llm.settings.AppSettings | None = None, providers: collections.abc.Iterable[ooai_llm.providers.Provider | str] | None = None, presets: collections.abc.Iterable[ooai_llm.settings.ModelPresetName] = DEFAULT_MODEL_SUITE_PRESETS, name: str = 'provider-presets', temperature: float | None = None, parallel_tool_calls: bool | None = None) → ModelSuite

Build a suite from AppSettings provider presets.

ooai_llm.model_suites.model_suite_from_catalog(*, settings: ooai_llm.settings.AppSettings | None = None, providers: collections.abc.Iterable[ooai_llm.providers.Provider | str] | None = None, source: ooai_llm.model_defaults.ModelDefaultSource = 'auto', config: ooai_llm.catalog.ListModelsConfig | None = None, include_non_chat: bool = False, capabilities: collections.abc.Iterable[ooai_llm.model_defaults.ModelCapabilityName] | None = None, min_context_tokens: int | None = None, min_output_tokens: int | None = None, max_input_cost_per_1m: decimal.Decimal | None = None, max_output_cost_per_1m: decimal.Decimal | None = None, released_after: str | None = None, released_before: str | None = None, sort_by: ooai_llm.model_defaults.ModelCatalogSortName = 'recency', limit: int | None = None, name: str = 'catalog', temperature: float | None = None, parallel_tool_calls: bool | None = None, strict: bool = False) → ModelSuite

Build a suite from filtered catalog rows.