Struct BatchRequestArgs

pub struct BatchRequestArgs { /* private fields */ }

Builder for BatchRequest.

Implementations

impl BatchRequestArgs

pub fn input_file_id<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The ID of an uploaded file that contains requests for the new batch.

See upload file for how to upload a file.

Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 100 MB in size.

pub fn endpoint<VALUE: Into<BatchEndpoint>>( &mut self, value: VALUE, ) -> &mut Self

The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

pub fn completion_window<VALUE: Into<BatchCompletionWindow>>( &mut self, value: VALUE, ) -> &mut Self

The time frame within which the batch should be processed. Currently only 24h is supported.

pub fn metadata<VALUE: Into<HashMap<String, Value>>>( &mut self, value: VALUE, ) -> &mut Self

Optional custom metadata for the batch.

pub fn build(&self) -> Result<BatchRequest, OpenAIError>

Builds a new BatchRequest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for BatchRequestArgs

fn clone(&self) -> BatchRequestArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchRequestArgs

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

Formats the value using the given formatter.

impl Default for BatchRequestArgs

fn default() -> Self

Returns the “default value” for a type.