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/responses, /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<BatchCreateParams.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.

• outputExpiresAfter

   final Optional<BatchCreateParams.OutputExpiresAfter> outputExpiresAfter()

  The expiration policy for the output and/or error file that are generated for a batch.

• _completionWindow

   final JsonField<BatchCreateParams.CompletionWindow> _completionWindow()

  Returns the raw JSON value of completionWindow.

  Unlike completionWindow, this method doesn't throw if the JSON field has an unexpected type.

• _endpoint

   final JsonField<BatchCreateParams.Endpoint> _endpoint()

  Returns the raw JSON value of endpoint.

  Unlike endpoint, this method doesn't throw if the JSON field has an unexpected type.

• _inputFileId

   final JsonField<String> _inputFileId()

  Returns the raw JSON value of inputFileId.

  Unlike inputFileId, this method doesn't throw if the JSON field has an unexpected type.

• _metadata

   final JsonField<BatchCreateParams.Metadata> _metadata()

  Returns the raw JSON value of metadata.

  Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.

• _outputExpiresAfter

   final JsonField<BatchCreateParams.OutputExpiresAfter> _outputExpiresAfter()

  Returns the raw JSON value of outputExpiresAfter.

  Unlike outputExpiresAfter, this method doesn't throw if the JSON field has an unexpected type.

• _additionalBodyProperties

   final Map<String, JsonValue> _additionalBodyProperties()

• _additionalHeaders

   final Headers _additionalHeaders()

  Additional headers to send with the request.

• _additionalQueryParams

   final QueryParams _additionalQueryParams()

  Additional query param to send with the request.

• toBuilder

   final BatchCreateParams.Builder toBuilder()

• _body

   final BatchCreateParams.Body _body()

• _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.

• equals

   Boolean equals(Object other)

• hashCode

   Integer hashCode()

• toString

   String toString()

• builder

   final static BatchCreateParams.Builder builder()

  Returns a mutable builder for constructing an instance of BatchCreateParams.

  The following fields are required:

  .completionWindow()
  .endpoint()
  .inputFileId()