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)

  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.Body.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.Body.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.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)

  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.Body.Builder metadata(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.

• metadata

   final BatchCreateParams.Body.Builder metadata(Optional<BatchCreateParams.Metadata> metadata)

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

• metadata

   final BatchCreateParams.Body.Builder metadata(JsonField<BatchCreateParams.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.

• outputExpiresAfter

   final BatchCreateParams.Body.Builder outputExpiresAfter(BatchCreateParams.OutputExpiresAfter outputExpiresAfter)

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

• outputExpiresAfter

   final BatchCreateParams.Body.Builder outputExpiresAfter(JsonField<BatchCreateParams.OutputExpiresAfter> outputExpiresAfter)

  Sets Builder.outputExpiresAfter to an arbitrary JSON value.

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

• 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()

  Returns an immutable instance of Body.

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

  The following fields are required:

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