Class BatchCreateParams.BatchCreateBody
-
- All Implemented Interfaces:
public final class BatchCreateParams.BatchCreateBody
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
BatchCreateParams.BatchCreateBody.Builder
A builder for BatchCreateBody.
-
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>
_additionalProperties()
final BatchCreateParams.BatchCreateBody
validate()
final BatchCreateParams.BatchCreateBody.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static BatchCreateParams.BatchCreateBody.Builder
builder()
-
-
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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final BatchCreateParams.BatchCreateBody validate()
-
toBuilder
final BatchCreateParams.BatchCreateBody.Builder toBuilder()
-
builder
final static BatchCreateParams.BatchCreateBody.Builder builder()
-
-
-
-