Struct BatchInput 

pub struct BatchInput {
    pub file_id: FileId,
    pub endpoint: String,
    pub completion_window: String,
    pub metadata: Option<Value>,
    pub created_by: Option<String>,
    pub api_key_id: Option<Uuid>,
    pub api_key: Option<String>,
    pub total_requests: Option<i64>,
}

Input parameters for creating a new batch.

Fields

file_id: FileId

The file containing request templates

endpoint: String

The API endpoint to use for all requests (e.g., “/v1/chat/completions”)

completion_window: String

Completion window (e.g., “24h”)

metadata: Option<Value>

Optional metadata key-value pairs (OpenAI allows up to 16 pairs)

created_by: Option<String>

User who created this batch (for ownership tracking)

api_key_id: Option<Uuid>

API key UUID that created this batch, for per-member attribution within orgs

api_key: Option<String>

API key secret for batch request execution. Used instead of the key in request_templates so that billing is attributed to the batch creator, not the file uploader.

total_requests: Option<i64>

Total number of request templates in the file. Set at creation time so the batch immediately reflects the expected request count before population completes.

Trait Implementations

impl Clone for BatchInput

fn clone(&self) -> BatchInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BatchInput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BatchInput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BatchInput

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

where __S: Serializer,

Serialize this value into the given Serde serializer.