Class BatchCreateParams
-
- All Implemented Interfaces:
public final class BatchCreateParamsCreates and executes a batch from an uploaded file of requests
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBatchCreateParams.BatchCreateBodypublic final classBatchCreateParams.Builderpublic final classBatchCreateParams.CompletionWindowThe time frame within which the batch should be processed. Currently only
24his supported.public final classBatchCreateParams.EndpointThe endpoint to be used for all requests in the batch. Currently
/v1/chat/completions,/v1/embeddings, and/v1/completionsare supported. Note that/v1/embeddingsbatches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.public final classBatchCreateParams.MetadataOptional custom metadata for the batch.
-
Constructor Summary
Constructors Constructor Description BatchCreateParams(BatchCreateParams.BatchCreateBody body, Headers additionalHeaders, QueryParams additionalQueryParams)
-
Method Summary
Modifier and Type Method Description final BatchCreateParams.CompletionWindowcompletionWindow()The time frame within which the batch should be processed. final BatchCreateParams.Endpointendpoint()The endpoint to be used for all requests in the batch. final StringinputFileId()The ID of an uploaded file that contains requests for the new batch. final Optional<BatchCreateParams.Metadata>metadata()Optional custom metadata for the batch. 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<BatchCreateParams.Metadata>_metadata()Optional custom metadata for the batch. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final BatchCreateParams.BuildertoBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final static BatchCreateParams.Builderbuilder()-
-
Constructor Detail
-
BatchCreateParams
BatchCreateParams(BatchCreateParams.BatchCreateBody body, Headers additionalHeaders, QueryParams additionalQueryParams)
-
-
Method Detail
-
completionWindow
final BatchCreateParams.CompletionWindow completionWindow()
The time frame within which the batch should be processed. Currently only
24his 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/completionsare supported. Note that/v1/embeddingsbatches 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<BatchCreateParams.Metadata> metadata()
Optional custom metadata for the batch.
-
_completionWindow
final JsonField<BatchCreateParams.CompletionWindow> _completionWindow()
The time frame within which the batch should be processed. Currently only
24his 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/completionsare supported. Note that/v1/embeddingsbatches 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<BatchCreateParams.Metadata> _metadata()
Optional custom metadata for the batch.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
-
toBuilder
final BatchCreateParams.Builder toBuilder()
-
builder
final static BatchCreateParams.Builder builder()
-
-
-
-