Struct CreateBatchRequest 

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

Creates and executes a batch from an uploaded JSONL file of requests.

Fields

input_file_id: String

The ID of the uploaded JSONL input file.

endpoint: String

The API endpoint the batch runs against, e.g. /v1/chat/completions.

completion_window: CompletionWindow

The time window within which the batch should be processed. Only 24h is currently supported.

metadata: Option<HashMap<String, String>>

Up to 16 arbitrary key-value metadata pairs attached to the batch.

extra_body_map: Option<Map<String, Value>>

Additional JSON properties flattened into the request body, for fields not covered by the typed struct.

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 Default for CreateBatchRequest

fn default() -> CreateBatchRequest

Returns the “default value” for a type.

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 Post for CreateBatchRequest

fn build_url(&self, base_url: &str) -> Result<String, OapiError>

Builds the URL for the request.

base_url should be like https://api.openai.com/v1

fn is_streaming(&self) -> bool

impl PostNoStream for CreateBatchRequest

type Response = Batch

fn get_response_string( &self, client: &Client, base_url: &str, options: &RequestOptions, ) -> impl Future<Output = Result<String, OapiError>> + Send + Sync

Sends a POST request and returns the raw response body.

fn get_response( &self, client: &Client, url: &str, options: &RequestOptions, ) -> impl Future<Output = Result<Self::Response, OapiError>> + Send + Sync

Sends a POST request and deserializes the response.

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.