Struct Model

Source

pub struct Model {
    pub id: String,
    pub name: Option<String>,
    pub description: Option<String>,
    pub type: Option<String>,
    pub created_at: Option<u64>,
    pub owned_by: Option<String>,
    pub context_length: Option<u32>,
}

Expand description

Represents a single model available from a provider.

This struct is designed to be flexible enough to accommodate the varying responses from different LLM providers while providing a common interface.

§Fields

id: The unique identifier for the model (required)
name: A human-readable name for the model
description: A detailed description of the model’s capabilities
r#type: The type of model (e.g., “chat”, “completion”, “embedding”)
created_at: Timestamp when the model was created
owned_by: The organization or entity that owns the model
context_length: The maximum context window size for the model

§Example

use rig::model::Model;

// Create a model with just an ID
let model = Model::from_id("gpt-4");

// Create a model with ID and name
let model = Model::new("gpt-4", "GPT-4");

// Create a model with all fields
let model = Model {
    id: "gpt-4".to_string(),
    name: Some("GPT-4".to_string()),
    description: Some("A large language model...".to_string()),
    r#type: Some("chat".to_string()),
    created_at: Some(1677610600),
    owned_by: Some("openai".to_string()),
    context_length: Some(8192),
};

Fields§

§id: String

The unique identifier for the model (required)

§name: Option<String>

A human-readable name for the model

§description: Option<String>

A detailed description of the model’s capabilities

§type: Option<String>

The type of model (e.g., “chat”, “completion”, “embedding”)

§created_at: Option<u64>

Timestamp when the model was created (Unix epoch)

§owned_by: Option<String>

The organization or entity that owns the model

§context_length: Option<u32>

The maximum context window size for the model

Implementations§

Source §

impl Model

Source

pub fn new(id: impl Into<String>, name: impl Into<String>) -> Model

Creates a new Model with the given ID and name.

§Arguments

id - The unique identifier for the model
name - A human-readable name for the model

§Example

use rig::model::Model;

let model = Model::new("gpt-4", "GPT-4");
assert_eq!(model.id, "gpt-4");
assert_eq!(model.name, Some("GPT-4".to_string()));

Source

pub fn from_id(id: impl Into<String>) -> Model

Creates a new Model with only the required ID field.

§Arguments

id - The unique identifier for the model

§Example

use rig::model::Model;

let model = Model::from_id("gpt-4");
assert_eq!(model.id, "gpt-4");
assert_eq!(model.name, None);

Source

pub fn display_name(&self) -> &str

Returns a reference to the model’s name, or the ID if no name is set.

This is useful for display purposes when you want to show the most human-readable identifier available.

§Example

use rig::model::Model;

let model_with_name = Model::new("gpt-4", "GPT-4");
assert_eq!(model_with_name.display_name(), "GPT-4");

let model_without_name = Model::from_id("gpt-4");
assert_eq!(model_without_name.display_name(), "gpt-4");