Struct ModelInfo 

pub struct ModelInfo { /* private fields */ }

Describes one selectable model returned by agent inventory.

use agents_kit::model::{ModelInfo, ModelSelector};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None, vec![], true)?;
assert!(info.is_default());
assert_eq!(info.selector().as_str(), "model-id");

Implementations

impl ModelInfo

pub fn new( selector: ModelSelector, display_name: Option<String>, reasoning_efforts: Vec<ReasoningEffort>, is_default: bool, ) -> Result<Self, KitError>

Constructs validated model inventory information.

Errors

Returns crate::error::ErrorKind::InvalidInput for a present empty or padded display name. It performs no model discovery or network request.

use agents_kit::model::{ModelInfo, ModelSelector, ReasoningEffort};
let info = ModelInfo::new(ModelSelector::new("model-id")?,
    Some("Example model".into()), vec![ReasoningEffort::low()], false)?;
assert_eq!(info.display_name(), Some("Example model"));

pub fn with_personalities(self, personalities: Vec<PersonalitySelector>) -> Self

Replaces the ordered backend-advertised personality values.

use agents_kit::model::{ModelInfo, ModelSelector, PersonalitySelector};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None, vec![], false)?
    .with_personalities(vec![PersonalitySelector::new("concise")?]);
assert_eq!(info.personalities()[0].as_str(), "concise");

pub fn selector(&self) -> &ModelSelector

Returns the selector callers can round-trip into prompts and defaults.

use agents_kit::model::{ModelInfo, ModelSelector};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None, vec![], false)?;
let request = agents_kit::prompt::PromptRequest::new("Hello")?.with_model(info.selector().clone());
assert_eq!(request.model(), Some(info.selector()));

pub fn display_name(&self) -> Option<&str>

Returns the optional caller-facing model name.

use agents_kit::model::{ModelInfo, ModelSelector};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None, vec![], false)?;
assert_eq!(info.display_name(), None);

pub fn reasoning_efforts(&self) -> &[ReasoningEffort]

Returns the advertised open-ended reasoning-effort values.

use agents_kit::model::{ModelInfo, ModelSelector, ReasoningEffort};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None,
    vec![ReasoningEffort::low()], false)?;
assert_eq!(info.reasoning_efforts(), &[ReasoningEffort::low()]);

pub fn personalities(&self) -> &[PersonalitySelector]

Returns the ordered backend-advertised personality values.

use agents_kit::model::{ModelInfo, ModelSelector};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None, vec![], false)?;
assert!(info.personalities().is_empty());

pub fn is_default(&self) -> bool

Reports whether this is the sourced agent-wide default model.

use agents_kit::model::{ModelInfo, ModelSelector};
let info = ModelInfo::new(ModelSelector::new("model-id")?, None, vec![], true)?;
assert!(info.is_default());

Trait Implementations

impl Clone for ModelInfo

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 ModelInfo

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

Formats the value using the given formatter.

impl Eq for ModelInfo

impl PartialEq for ModelInfo

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ModelInfo