Struct BatchClient 

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

Client for batch API.

Implementations

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

pub async fn create(&self, builder: BatchJobBuilder) -> Result<Batch>

Create a new batch job.

Example

use openai_ergonomic::Client;
use openai_ergonomic::builders::batch::{BatchJobBuilder, BatchEndpoint};

let client = Client::from_env()?;
let builder = BatchJobBuilder::new("file-batch-input", BatchEndpoint::ChatCompletions);
let batch = client.batch().create(builder).await?;
println!("Created batch: {}", batch.id);

pub async fn list( &self, after: Option<&str>, limit: Option<i32>, ) -> Result<ListBatchesResponse>

List batch jobs.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let response = client.batch().list(None, Some(20)).await?;
println!("Found {} batches", response.data.len());

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

Get a specific batch job.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let batch = client.batch().get("batch_123").await?;
println!("Batch status: {}", batch.status);

pub async fn cancel(&self, batch_id: impl Into<String>) -> Result<Batch>

Cancel a batch job.

Example

use openai_ergonomic::Client;

let client = Client::from_env()?;
let batch = client.batch().cancel("batch_123").await?;
println!("Batch cancelled: {}", batch.status);

Trait Implementations

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

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

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

Formats the value using the given formatter.

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