Constructor Detail

Method Detail

• body

   final FileCreateParams.Builder body(FileCreateParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • file

  • purpose

  • expiresAfter

• file

   final FileCreateParams.Builder file(InputStream file)

  The File object (not file name) to be uploaded.

• file

   final FileCreateParams.Builder file(MultipartField<InputStream> file)

  Sets Builder.file to an arbitrary multipart value.

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

• file

   final FileCreateParams.Builder file(ByteArray file)

  The File object (not file name) to be uploaded.

• file

   final FileCreateParams.Builder file(Path path)

  The File object (not file name) to be uploaded.

• purpose

   final FileCreateParams.Builder purpose(FilePurpose purpose)

  The intended purpose of the uploaded file. One of: - assistants: Used in the Assistants API - batch: Used in the Batch API - fine-tune: Used for fine-tuning - vision: Images used for vision fine-tuning - user_data: Flexible file type for any purpose - evals: Used for eval data sets

• purpose

   final FileCreateParams.Builder purpose(MultipartField<FilePurpose> purpose)

  Sets Builder.purpose to an arbitrary multipart value.

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

• expiresAfter

   final FileCreateParams.Builder expiresAfter(FileCreateParams.ExpiresAfter expiresAfter)

  The expiration policy for a file. By default, files with purpose=batch expire after 30 days and all other files are persisted until they are manually deleted.

• expiresAfter

   final FileCreateParams.Builder expiresAfter(MultipartField<FileCreateParams.ExpiresAfter> expiresAfter)

  Sets Builder.expiresAfter to an arbitrary multipart value.

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

• additionalBodyProperties

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

• putAdditionalBodyProperty

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

• putAllAdditionalBodyProperties

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

• removeAdditionalBodyProperty

   final FileCreateParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

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

• additionalHeaders

   final FileCreateParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

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

• putAdditionalHeader

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

• putAdditionalHeaders

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

• putAllAdditionalHeaders

   final FileCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAdditionalHeaders

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

• replaceAllAdditionalHeaders

   final FileCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

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

• removeAdditionalHeaders

   final FileCreateParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

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

• additionalQueryParams

   final FileCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

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

• putAdditionalQueryParam

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

• putAdditionalQueryParams

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

• putAllAdditionalQueryParams

   final FileCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAdditionalQueryParams

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

• replaceAllAdditionalQueryParams

   final FileCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

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

• removeAdditionalQueryParams

   final FileCreateParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

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

• build

   final FileCreateParams build()

  Returns an immutable instance of FileCreateParams.

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

  The following fields are required:

  .file()
  .purpose()