Struct ModelsClient 

pub struct ModelsClient<'a, T = ()> { /* private fields */ }

Client for models API.

Implementations

impl<T: Default + Send + Sync> ModelsClient<'_, T>

pub async fn list(&self) -> Result<ListModelsResponse>

List all available models.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let models = client.models().list().await?;
println!("Available models: {}", models.data.len());

Examples found in repository

examples/models.rs (line 76)

async fn fetch_models_from_api(client: &Client) -> Result<()> {
    // Example of using the ergonomic API to list models
    let response = client.models().list().await?;

    println!("Fetched {} models from API:", response.data.len());
    for model in response.data.iter().take(10) {
        println!("  - {} (owned by: {})", model.id, model.owned_by);
    }
    println!();

    // Example of getting a specific model
    if !response.data.is_empty() {
        let model_id = &response.data[0].id;
        let model = client.models().get(model_id).await?;
        println!("Model details for {}:", model.id);
        println!("  Owned by: {}", model.owned_by);
        println!("  Created: {}", model.created);
        println!();
    }

    Ok(())
}

pub async fn get(&self, model_id: impl Into<String>) -> Result<Model>

Retrieve information about a specific model.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let model = client.models().get("gpt-4").await?;
println!("Model ID: {}", model.id);

Examples found in repository

examples/models.rs (line 87)

async fn fetch_models_from_api(client: &Client) -> Result<()> {
    // Example of using the ergonomic API to list models
    let response = client.models().list().await?;

    println!("Fetched {} models from API:", response.data.len());
    for model in response.data.iter().take(10) {
        println!("  - {} (owned by: {})", model.id, model.owned_by);
    }
    println!();

    // Example of getting a specific model
    if !response.data.is_empty() {
        let model_id = &response.data[0].id;
        let model = client.models().get(model_id).await?;
        println!("Model details for {}:", model.id);
        println!("  Owned by: {}", model.owned_by);
        println!("  Created: {}", model.created);
        println!();
    }

    Ok(())
}

pub async fn retrieve(&self, builder: ModelRetrievalBuilder) -> Result<Model>

Retrieve information about a model using a builder.

pub async fn delete( &self, model_id: impl Into<String>, ) -> Result<DeleteModelResponse>

Delete a fine-tuned model.

You must have the Owner role in your organization to delete a model.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.models().delete("ft:gpt-3.5-turbo:my-org:custom:id").await?;
println!("Deleted: {}", response.deleted);

pub async fn remove( &self, builder: ModelDeleteBuilder, ) -> Result<DeleteModelResponse>

Delete a fine-tuned model using a builder.

Trait Implementations

impl<'a, T: Clone> Clone for ModelsClient<'a, T>

fn clone(&self) -> ModelsClient<'a, T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug> Debug for ModelsClient<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Copy> Copy for ModelsClient<'a, T>