artificial_core/
model.rs

1//! Model identifiers used throughout the **artificial** workspace.
2//!
3//! The enum hierarchy keeps the *public* API blissfully simple while allowing
4//! each provider crate to map the variants onto its own naming scheme.  As a
5//! consequence you never have to type literal strings such as `"gpt-4o-mini"`
6//! in your application code—pick an enum variant instead and let the adapter
7//! translate it.
8//!
9//! # Adding more models
10//!
11//! 1. **Provider–specific enum**
12//!    Add the variant to the sub-enum (`OpenAiModel`, `AnthropicModel`, …).
13//! 2. **Mapping layer**
14//!    Update the mapping function in the provider crate
15//!    (`artificial-openai::model_map::map_model`, etc.).
16//! 3. **Compile-time safety**
17//!    The compiler will tell you if you forgot to handle the new variant in
18//!    `From<T> for Model` or in provider match statements.
19//!
20//! # Example
21//!
22//! ```rust
23//! use artificial_core::model::{Model, OpenAiModel};
24//! assert_eq!(Model::from(OpenAiModel::Gpt4oMini),
25//!            Model::OpenAi(OpenAiModel::Gpt4oMini));
26//! ```
27
28/// Universal identifier for an LLM model.
29///
30/// * `OpenAi` – Enumerated list of officially supported OpenAI models.
31/// * `Custom` – Any provider / model name not yet covered by a dedicated enum. Use this if you run a self-hosted or beta model.
32#[derive(Debug, Clone, PartialEq, Eq, Hash)]
33pub enum Model {
34    /// Built-in OpenAI models (chat completion API).
35    OpenAi(OpenAiModel),
36    /// Fully qualified provider/model ID (`"provider:model-name"` or similar).
37    Custom(&'static str),
38}
39
40/// Exhaustive list of models **officially** supported by the OpenAI back-end.
41///
42/// Keeping the list small avoids accidental typos while still allowing
43/// arbitrary model names through [`Model::Custom`].
44#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
45pub enum OpenAiModel {
46    Gpt5,
47    Gpt5Nano,
48    Gpt5Mini,
49    Gpt5_1,
50    Gpt5_2,
51    Gpt4o,
52    Gpt4oMini,
53    O3,
54    O3Mini,
55    O4Mini,
56}
57
58impl From<OpenAiModel> for Model {
59    fn from(val: OpenAiModel) -> Self {
60        Model::OpenAi(val)
61    }
62}
artificial_core/model.rs

artificial_core/
model.rs
