Struct ModelList 

pub struct ModelList {
    pub data: Vec<Model>,
}

Represents a complete list of models from a provider.

This struct contains all available models from a provider. Providers that support pagination internally handle fetching all pages before returning results.

Fields

• data: The complete list of available models

Example

use rig::model::{Model, ModelList};

let list = ModelList::new(vec![
    Model::from_id("gpt-4"),
    Model::from_id("gpt-3.5-turbo"),
]);

println!("Found {} models", list.len());
for model in list.iter() {
    println!("- {}", model.display_name());
}

Fields

data: Vec<Model>

The complete list of available models

Implementations

impl ModelList

pub fn new(data: Vec<Model>) -> Self

Creates a new ModelList with the given models.

Arguments

• data - The list of models

Example

use rig::model::{Model, ModelList};

let list = ModelList::new(vec![
    Model::from_id("gpt-4"),
    Model::from_id("gpt-3.5-turbo"),
]);
assert_eq!(list.len(), 2);

pub fn is_empty(&self) -> bool

Returns true if the list is empty.

Example

use rig::model::ModelList;

let empty = ModelList::new(vec![]);
assert!(empty.is_empty());

let non_empty = ModelList::new(vec![rig::model::Model::from_id("gpt-4")]);
assert!(!non_empty.is_empty());

pub fn len(&self) -> usize

Returns the number of models in this page.

Example

use rig::model::{Model, ModelList};

let list = ModelList::new(vec![
    Model::from_id("gpt-4"),
    Model::from_id("gpt-3.5-turbo"),
]);
assert_eq!(list.len(), 2);

pub fn iter(&self) -> Iter<'_, Model>

Returns an iterator over the models in this list.

Example

use rig::model::{Model, ModelList};

let list = ModelList::new(vec![
    Model::from_id("gpt-4"),
    Model::from_id("gpt-3.5-turbo"),
]);

for model in list.iter() {
    println!("Model: {}", model.display_name());
}

Trait Implementations

impl Clone for ModelList

fn clone(&self) -> ModelList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ModelList

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ModelList

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a ModelList

type Item = &'a Model

The type of the elements being iterated over.

type IntoIter = Iter<'a, Model>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for ModelList

type Item = Model

The type of the elements being iterated over.

type IntoIter = IntoIter<Model>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for ModelList

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.