Struct CreateBatchRequest

pub struct CreateBatchRequest {
    pub input_file_id: String,
    pub endpoint: CreateBatchRequestEndpoint,
    pub completion_window: CreateBatchRequestCompletionWindow,
    pub metadata: Option<Metadata>,
}

Fields

input_file_id: String

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 200 MB in size.

endpoint: CreateBatchRequestEndpoint

The endpoint to be used for all requests in the batch. Currently /v1/responses, /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.

completion_window: CreateBatchRequestCompletionWindow

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

metadata: Option<Metadata>

Implementations

impl CreateBatchRequest

pub fn builder() -> CreateBatchRequestBuilder<((), (), (), ())>

Create a builder for building CreateBatchRequest. On the builder, call .input_file_id(...), .endpoint(...), .completion_window(...), .metadata(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of CreateBatchRequest.

Trait Implementations

impl Clone for CreateBatchRequest

fn clone(&self) -> CreateBatchRequest

Returns a duplicate of the value.

const 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<'de> Deserialize<'de> for CreateBatchRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateBatchRequest

fn eq(&self, other: &CreateBatchRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl StructuralPartialEq for CreateBatchRequest