Struct BatchJobBuilder 

pub struct BatchJobBuilder { /* private fields */ }

Builder for creating batch jobs.

Batch jobs allow you to process multiple requests asynchronously at a lower cost with longer processing time (up to 24 hours).

Implementations

impl BatchJobBuilder

pub fn new(input_file_id: impl Into<String>, endpoint: BatchEndpoint) -> Self

Create a new batch job builder.

Examples

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

let builder = BatchJobBuilder::new("file-batch-input", BatchEndpoint::ChatCompletions);

pub fn completion_window(self, window: BatchCompletionWindow) -> Self

Set the completion window for the batch job.

pub fn metadata(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add metadata to the batch job.

pub fn input_file_id(&self) -> &str

Get the input file ID.

pub fn endpoint(&self) -> &BatchEndpoint

Get the endpoint for this batch job.

pub fn completion_window_ref(&self) -> &BatchCompletionWindow

Get the completion window.

pub fn metadata_ref(&self) -> &HashMap<String, String>

Get the metadata.

pub fn has_metadata(&self) -> bool

Check if metadata is empty.

Trait Implementations

impl Clone for BatchJobBuilder

fn clone(&self) -> BatchJobBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchJobBuilder

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

Formats the value using the given formatter.