Struct Profile 

#[non_exhaustive]
pub struct Profile {
    pub name: String,
    pub author: String,
    pub slug: String,
    pub description: String,
    pub abilities: Vec<Ability>,
    pub context_length: u32,
    pub pricing: Option<Pricing>,
    pub default_reasoning_effort: Option<ReasoningEffort>,
}

Represents a language model’s profile, including its name, description, abilities, context length, and optional pricing.

A model profile provides comprehensive information about a language model’s capabilities, limitations, and pricing structure. This allows applications to make informed decisions about which model to use for specific tasks.

Examples

use aither::llm::model::{Profile, Ability, Pricing};

let profile = Profile::new("gpt-4", "GPT-4 Turbo", 128000)
    .with_ability(Ability::ToolUse)
    .with_ability(Ability::Vision);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The name of the model.

author: String

The author of the model.

slug: String

The slug of the model.

description: String

A description of the model.

abilities: Vec<Ability>

The abilities supported by the model.

context_length: u32

The maximum context length supported by the model.

pricing: Option<Pricing>

Optional pricing information for the model.

default_reasoning_effort: Option<ReasoningEffort>

The reasoning effort the model runs at when a request sets none, as its vendor documents it; None when no default is recorded.

Implementations

impl Profile

pub fn new( name: impl Into<String>, author: impl Into<String>, slug: impl Into<String>, description: impl Into<String>, context_length: u32, ) -> Self

Creates a new Profile with the given name, description, and context length.

Arguments

• name - The name of the model (e.g., “gpt-4”, “claude-3-opus”)
• description - A human-readable description of the model
• context_length - Maximum number of tokens the model can process

Examples

use aither::llm::model::Profile;

let profile = Profile::new("gpt-4", "GPT-4 Turbo", 128000);

pub const fn with_default_reasoning_effort( self, effort: ReasoningEffort, ) -> Self

Records the reasoning effort the model runs at when a request sets none.

pub fn with_ability(self, ability: Ability) -> Self

Adds a single ability to the profile.

Arguments

• ability - The ability to add to this profile

Examples

use aither::llm::model::{Profile, Ability};

let profile = Profile::new("vision-model", "A vision-capable model", 8192)
    .with_ability(Ability::Vision);

pub fn with_abilities( self, abilities: impl IntoIterator<Item = Ability>, ) -> Self

Adds multiple abilities to the profile.

Arguments

• abilities - An iterable collection of abilities to add

Examples

use aither::llm::model::{Profile, Ability};

let abilities = [Ability::ToolUse, Ability::Vision, Ability::Audio];
let profile = Profile::new("multimodal", "A multimodal model", 32768)
    .with_abilities(abilities);

pub const fn with_pricing(self, pricing: Pricing) -> Self

Sets the pricing information for the profile.

Arguments

• pricing - The pricing structure for this model

Examples

use aither::llm::model::{Profile, Pricing};

let mut pricing = Pricing::default();

pricing.prompt = 0.01;
pricing.completion = 0.03;

let profile = Profile::new("paid-model", "A paid model", 4096)
    .with_pricing(pricing);

Trait Implementations

impl Clone for Profile

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Profile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Profile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Profile

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Profile

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Profile

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 Profile