Constructor Detail

Method Detail

• vectorStoreId

   final FileCreateParams.Builder vectorStoreId(String vectorStoreId)

• 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:

  • fileId

  • attributes

  • chunkingStrategy

• fileId

   final FileCreateParams.Builder fileId(String fileId)

  A File ID that the vector store should use. Useful for tools like file_search that can access files.

• fileId

   final FileCreateParams.Builder fileId(JsonField<String> fileId)

  Sets Builder.fileId to an arbitrary JSON value.

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

• attributes

   final FileCreateParams.Builder attributes(FileCreateParams.Attributes attributes)

  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, booleans, or numbers.

• attributes

   final FileCreateParams.Builder attributes(Optional<FileCreateParams.Attributes> attributes)

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

• attributes

   final FileCreateParams.Builder attributes(JsonField<FileCreateParams.Attributes> attributes)

  Sets Builder.attributes to an arbitrary JSON value.

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

• chunkingStrategy

   final FileCreateParams.Builder chunkingStrategy(FileChunkingStrategyParam chunkingStrategy)

  The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Only applicable if file_ids is non-empty.

• chunkingStrategy

   final FileCreateParams.Builder chunkingStrategy(JsonField<FileChunkingStrategyParam> chunkingStrategy)

  Sets Builder.chunkingStrategy to an arbitrary JSON value.

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

• chunkingStrategy

   final FileCreateParams.Builder chunkingStrategy(AutoFileChunkingStrategyParam auto)

  Alias for calling chunkingStrategy with FileChunkingStrategyParam.ofAuto(auto).

• chunkingStrategy

   final FileCreateParams.Builder chunkingStrategy(StaticFileChunkingStrategyObjectParam static_)

  Alias for calling chunkingStrategy with FileChunkingStrategyParam.ofStatic(static_).

• staticChunkingStrategy

   final FileCreateParams.Builder staticChunkingStrategy(StaticFileChunkingStrategy static_)

  Alias for calling chunkingStrategy with the following:

  StaticFileChunkingStrategyObjectParam.builder()
      .static_(static_)
      .build()

• 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:

  .vectorStoreId()
  .fileId()