All Implemented Interfaces:


public final class BatchCreateParams.Body.Builder

A builder for Body.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

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.Body.Builder`	`completionWindow(BatchCreateParams.CompletionWindow completionWindow)`	The time frame within which the batch should be processed.
`final BatchCreateParams.Body.Builder`	`completionWindow(JsonField<BatchCreateParams.CompletionWindow> completionWindow)`	The time frame within which the batch should be processed.
`final BatchCreateParams.Body.Builder`	`endpoint(BatchCreateParams.Endpoint endpoint)`	The endpoint to be used for all requests in the batch.
`final BatchCreateParams.Body.Builder`	`endpoint(JsonField<BatchCreateParams.Endpoint> endpoint)`	The endpoint to be used for all requests in the batch.
`final BatchCreateParams.Body.Builder`	`inputFileId(String inputFileId)`	The ID of an uploaded file that contains requests for the new batch.
`final BatchCreateParams.Body.Builder`	`inputFileId(JsonField<String> inputFileId)`	The ID of an uploaded file that contains requests for the new batch.
`final BatchCreateParams.Body.Builder`	`metadata(Metadata metadata)`	Set of 16 key-value pairs that can be attached to an object.
`final BatchCreateParams.Body.Builder`	`metadata(Optional<Metadata> metadata)`	Set of 16 key-value pairs that can be attached to an object.
`final BatchCreateParams.Body.Builder`	`metadata(JsonField<Metadata> metadata)`	Set of 16 key-value pairs that can be attached to an object.
`final BatchCreateParams.Body.Builder`	`additionalProperties(Map<String, JsonValue> additionalProperties)`
`final BatchCreateParams.Body.Builder`	`putAdditionalProperty(String key, JsonValue value)`
`final BatchCreateParams.Body.Builder`	`putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)`
`final BatchCreateParams.Body.Builder`	`removeAdditionalProperty(String key)`
`final BatchCreateParams.Body.Builder`	`removeAllAdditionalProperties(Set<String> keys)`
`final BatchCreateParams.Body`	`build()`

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.Body.Builder completionWindow(BatchCreateParams.CompletionWindow completionWindow)
```
    The time frame within which the batch should be processed. Currently only 24h is supported.
  - completionWindow
```
 final BatchCreateParams.Body.Builder completionWindow(JsonField<BatchCreateParams.CompletionWindow> completionWindow)
```
    The time frame within which the batch should be processed. Currently only 24h is supported.
  - endpoint
```
 final BatchCreateParams.Body.Builder endpoint(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.
  - endpoint
```
 final BatchCreateParams.Body.Builder endpoint(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 BatchCreateParams.Body.Builder inputFileId(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.
  - inputFileId
```
 final BatchCreateParams.Body.Builder inputFileId(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 BatchCreateParams.Body.Builder metadata(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.
  - metadata
```
 final BatchCreateParams.Body.Builder metadata(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.
  - metadata
```
 final BatchCreateParams.Body.Builder metadata(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 BatchCreateParams.Body.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
```
  - putAdditionalProperty
```
 final BatchCreateParams.Body.Builder putAdditionalProperty(String key, JsonValue value)
```
  - putAllAdditionalProperties
```
 final BatchCreateParams.Body.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
```
  - removeAdditionalProperty
```
 final BatchCreateParams.Body.Builder removeAdditionalProperty(String key)
```
  - removeAllAdditionalProperties
```
 final BatchCreateParams.Body.Builder removeAllAdditionalProperties(Set<String> keys)
```
  - build
```
 final BatchCreateParams.Body build()
```

Class BatchCreateParams.Body.Builder

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

completionWindow

completionWindow

endpoint

endpoint

inputFileId

inputFileId

metadata

metadata

metadata

additionalProperties

putAdditionalProperty

putAllAdditionalProperties

removeAdditionalProperty

removeAllAdditionalProperties

build