Constructor Detail

Method Detail

• completionWindow

   final BatchCreateParams.Builder completionWindow(BatchCreateParams.CompletionWindow completionWindow)

  The time frame within which the batch should be processed. Currently only 24h is supported.

• completionWindow

   final BatchCreateParams.Builder completionWindow(JsonField<BatchCreateParams.CompletionWindow> completionWindow)

  Sets Builder.completionWindow to an arbitrary JSON value.

  You should usually call Builder.completionWindow with a well-typed CompletionWindow value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• endpoint

   final BatchCreateParams.Builder endpoint(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.

• endpoint

   final BatchCreateParams.Builder endpoint(JsonField<BatchCreateParams.Endpoint> endpoint)

  Sets Builder.endpoint to an arbitrary JSON value.

  You should usually call Builder.endpoint with a well-typed Endpoint value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• inputFileId

   final BatchCreateParams.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.Builder inputFileId(JsonField<String> inputFileId)

  Sets Builder.inputFileId to an arbitrary JSON value.

  You should usually call Builder.inputFileId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• metadata

   final BatchCreateParams.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.Builder metadata(Optional<Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final BatchCreateParams.Builder metadata(JsonField<Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final BatchCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final BatchCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final BatchCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final BatchCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final BatchCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final BatchCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final BatchCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final BatchCreateParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final BatchCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final BatchCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final BatchCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final BatchCreateParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final BatchCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final BatchCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final BatchCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final BatchCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final BatchCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final BatchCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final BatchCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final BatchCreateParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final BatchCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final BatchCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final BatchCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final BatchCreateParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final BatchCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final BatchCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final BatchCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final BatchCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final BatchCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final BatchCreateParams build()

  Returns an immutable instance of BatchCreateParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

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