All Implemented Interfaces:

com.openai.core.Params
```
public final class BatchCreateParams
 implements Params
                    
```
Creates and executes a batch from an uploaded file of requests

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BatchCreateParams.Body`
`public final class`	`BatchCreateParams.Builder`	A builder for BatchCreateParams.
`public final class`	`BatchCreateParams.CompletionWindow`	The time frame within which the batch should be processed. Currently only `24h` is supported.
`public final class`	`BatchCreateParams.Endpoint`	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.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final BatchCreateParams.CompletionWindow`	`completionWindow()`	The time frame within which the batch should be processed.
`final BatchCreateParams.Endpoint`	`endpoint()`	The endpoint to be used for all requests in the batch.
`final String`	`inputFileId()`	The ID of an uploaded file that contains requests for the new batch.
`final Optional<Metadata>`	`metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final JsonField<BatchCreateParams.CompletionWindow>`	`_completionWindow()`	The time frame within which the batch should be processed.
`final JsonField<BatchCreateParams.Endpoint>`	`_endpoint()`	The endpoint to be used for all requests in the batch.
`final JsonField<String>`	`_inputFileId()`	The ID of an uploaded file that contains requests for the new batch.
`final JsonField<Metadata>`	`_metadata()`	Set of 16 key-value pairs that can be attached to an object.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`final BatchCreateParams.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static BatchCreateParams.Builder`	`builder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - completionWindow
```
 final BatchCreateParams.CompletionWindow completionWindow()
```
    The time frame within which the batch should be processed. Currently only 24h is supported.
  - endpoint
```
 final BatchCreateParams.Endpoint endpoint()
```
    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.
  - inputFileId
```
 final String inputFileId()
```
    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.
  - metadata
```
 final Optional<Metadata> metadata()
```
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
  - _completionWindow
```
 final JsonField<BatchCreateParams.CompletionWindow> _completionWindow()
```
    The time frame within which the batch should be processed. Currently only 24h is supported.
  - _endpoint
```
 final JsonField<BatchCreateParams.Endpoint> _endpoint()
```
    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.
  - _inputFileId
```
 final JsonField<String> _inputFileId()
```
    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.
  - _metadata
```
 final JsonField<Metadata> _metadata()
```
    Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.
    Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - toBuilder
```
 final BatchCreateParams.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static BatchCreateParams.Builder builder()
```

Class BatchCreateParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

completionWindow

endpoint

inputFileId

metadata

_completionWindow

_endpoint

_inputFileId

_metadata

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

_headers

_queryParams

toBuilder

equals

hashCode

toString

builder