Struct BatchApi 

pub struct BatchApi { /* private fields */ }

Batch API client.

Implementations

impl BatchApi

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

Create a new batch.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let batch = client.batch().create("my-batch").await?;
println!("Created batch: {}", batch.id);

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

Get batch information by ID.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let batch = client.batch().get("batch-123").await?;
println!("Status: {:?}", batch.status);

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

List all batches.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let response = client.batch().list().await?;
for batch in response.data {
    println!("{}: {:?}", batch.name, batch.status);
}

pub async fn list_with_options( &self, limit: Option<u32>, next_token: Option<&str>, ) -> Result<BatchListResponse>

List batches with pagination options.

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

Cancel a batch.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let batch = client.batch().cancel("batch-123").await?;
println!("Cancelled: {:?}", batch.status);

pub async fn add_requests( &self, batch_id: impl AsRef<str>, requests: Vec<BatchRequest>, ) -> Result<()>

Add requests to a batch.

Example

use xai_rust::{XaiClient, BatchRequest};
use xai_rust::chat::{user, system};

let client = XaiClient::from_env()?;

let requests = vec![
    BatchRequest::new("req-1", "grok-4")
        .message(user("Hello!")),
    BatchRequest::new("req-2", "grok-4")
        .message(user("How are you?")),
];

client.batch().add_requests("batch-123", requests).await?;

pub async fn list_requests( &self, batch_id: impl AsRef<str>, ) -> Result<BatchRequestListResponse>

List requests in a batch.

pub async fn list_requests_with_options( &self, batch_id: impl AsRef<str>, limit: Option<u32>, next_token: Option<&str>, ) -> Result<BatchRequestListResponse>

List requests in a batch with pagination options.

pub async fn list_results( &self, batch_id: impl AsRef<str>, ) -> Result<BatchResultListResponse>

List results of a batch.

Example

use xai_rust::XaiClient;

let client = XaiClient::from_env()?;

let results = client.batch().list_results("batch-123").await?;
for result in results.data {
    if result.is_success() {
        println!("{}: {}", result.custom_id, result.text().unwrap_or_default());
    } else {
        println!("{}: Error - {:?}", result.custom_id, result.error_message);
    }
}

pub async fn list_results_with_options( &self, batch_id: impl AsRef<str>, limit: Option<u32>, next_token: Option<&str>, ) -> Result<BatchResultListResponse>

List results of a batch with pagination options.

pub async fn get_result( &self, batch_id: impl AsRef<str>, request_id: impl AsRef<str>, ) -> Result<BatchResult>

Get a specific result by request ID.

Trait Implementations

impl Clone for BatchApi

fn clone(&self) -> BatchApi

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchApi

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

Formats the value using the given formatter.