Struct UsageClient 

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

Client for usage API.

Implementations

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

pub async fn audio_speeches( &self, builder: UsageBuilder, ) -> Result<UsageResponse>

Get usage data for audio speeches.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::usage::UsageBuilder;

let client = Client::from_env()?;
let builder = UsageBuilder::new(1704067200, None);
let usage = client.usage().audio_speeches(builder).await?;
println!("Usage: {:?}", usage);

Examples found in repository

examples/usage.rs (line 145)

async fn audio_usage(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time)).limit(10);

    // Audio speeches (text-to-speech)
    let speeches = client.usage().audio_speeches(builder.clone()).await?;
    println!("Audio speeches usage: {} data points", speeches.data.len());

    // Audio transcriptions
    let transcriptions = client.usage().audio_transcriptions(builder).await?;
    println!(
        "Audio transcriptions usage: {} data points",
        transcriptions.data.len()
    );

    Ok(())
}

pub async fn audio_transcriptions( &self, builder: UsageBuilder, ) -> Result<UsageResponse>

Get usage data for audio transcriptions.

Examples found in repository

examples/usage.rs (line 149)

async fn audio_usage(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time)).limit(10);

    // Audio speeches (text-to-speech)
    let speeches = client.usage().audio_speeches(builder.clone()).await?;
    println!("Audio speeches usage: {} data points", speeches.data.len());

    // Audio transcriptions
    let transcriptions = client.usage().audio_transcriptions(builder).await?;
    println!(
        "Audio transcriptions usage: {} data points",
        transcriptions.data.len()
    );

    Ok(())
}

pub async fn code_interpreter_sessions( &self, builder: UsageBuilder, ) -> Result<UsageResponse>

Get usage data for code interpreter sessions.

pub async fn completions(&self, builder: UsageBuilder) -> Result<UsageResponse>

Get usage data for completions.

Examples found in repository

examples/usage.rs (line 75)

async fn basic_usage_query(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time));

    let usage = client.usage().completions(builder).await?;

    println!("Completions usage:");
    println!("  Data points: {}", usage.data.len());

    if usage.has_more {
        println!("  Has more: yes");
    }

    Ok(())
}

async fn usage_with_aggregation(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time))
        .bucket_width(BucketWidth::Day)
        .limit(10);

    let usage = client.usage().completions(builder).await?;

    println!("Daily aggregated completions usage:");
    println!("  Bucket width: 1 day");
    println!("  Data points: {}", usage.data.len());

    Ok(())
}

async fn usage_by_model(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time))
        .model("gpt-4")
        .limit(100);

    let usage = client.usage().completions(builder).await?;

    println!("Completions usage for gpt-4:");
    println!("  Data points: {}", usage.data.len());

    Ok(())
}

async fn usage_grouped_by_project(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time))
        .group_by(GroupBy::ProjectId)
        .group_by(GroupBy::Model)
        .limit(50);

    let usage = client.usage().completions(builder).await?;

    println!("Completions usage grouped by project and model:");
    println!("  Data points: {}", usage.data.len());

    Ok(())
}

pub async fn embeddings(&self, builder: UsageBuilder) -> Result<UsageResponse>

Get usage data for embeddings.

Examples found in repository

examples/usage.rs (line 176)

async fn embeddings_usage(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time))
        .model("text-embedding-3-small")
        .limit(100);

    let usage = client.usage().embeddings(builder).await?;

    println!("Embeddings usage for text-embedding-3-small:");
    println!("  Data points: {}", usage.data.len());

    Ok(())
}

pub async fn images(&self, builder: UsageBuilder) -> Result<UsageResponse>

Get usage data for images.

Examples found in repository

examples/usage.rs (line 163)

async fn image_usage(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time))
        .bucket_width(BucketWidth::Day)
        .limit(10);

    let usage = client.usage().images(builder).await?;

    println!("Image generation usage:");
    println!("  Data points: {}", usage.data.len());

    Ok(())
}

pub async fn moderations(&self, builder: UsageBuilder) -> Result<UsageResponse>

Get usage data for moderations.

pub async fn vector_stores( &self, builder: UsageBuilder, ) -> Result<UsageResponse>

Get usage data for vector stores.

pub async fn costs(&self, builder: UsageBuilder) -> Result<UsageResponse>

Get cost data.

Examples found in repository

examples/usage.rs (line 133)

async fn cost_data(client: &Client, start_time: i32, end_time: i32) -> Result<()> {
    let builder = UsageBuilder::new(start_time, Some(end_time))
        .bucket_width(BucketWidth::Day)
        .limit(10);

    let costs = client.usage().costs(builder).await?;

    println!("Cost data:");
    println!("  Data points: {}", costs.data.len());

    Ok(())
}

Trait Implementations

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

fn clone(&self) -> UsageClient<'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 UsageClient<'a, T>

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

Formats the value using the given formatter.

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