Struct CreateBatchRequest 

pub struct CreateBatchRequest {
    pub input_file_id: String,
    pub endpoint: BatchEndpoint,
    pub completion_window: CompletionWindow,
    pub metadata: Option<HashMap<String, String>>,
}

Request to create a new batch job.

Fields

input_file_id: String

The ID of an uploaded file that contains requests for the batch. The file must be uploaded with purpose “batch”.

endpoint: BatchEndpoint

The endpoint to use for all requests in the batch.

completion_window: CompletionWindow

The time window in which the batch must be completed.

metadata: Option<HashMap<String, String>>

Optional metadata to attach to the batch.

Implementations

impl CreateBatchRequest

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

Creates a new batch request with the given input file ID and endpoint.

Arguments

• input_file_id - The ID of the uploaded input file
• endpoint - The API endpoint to use for the batch

Example

use openai_tools::batch::request::{CreateBatchRequest, BatchEndpoint};

let request = CreateBatchRequest::new("file-abc123", BatchEndpoint::ChatCompletions);

pub fn with_metadata(self, metadata: HashMap<String, String>) -> Self

Sets the metadata for the batch.

Arguments

• metadata - Key-value pairs to attach to the batch

Trait Implementations

impl Clone for CreateBatchRequest

fn clone(&self) -> CreateBatchRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateBatchRequest

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

Formats the value using the given formatter.

impl Serialize for CreateBatchRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.