Class FileBatchCreateParams.Builder
-
- All Implemented Interfaces:
public final class FileBatchCreateParams.Builder
A builder for FileBatchCreateParams.
-
-
Method Summary
-
-
Method Detail
-
vectorStoreId
final FileBatchCreateParams.Builder vectorStoreId(String vectorStoreId)
-
vectorStoreId
final FileBatchCreateParams.Builder vectorStoreId(Optional<String> vectorStoreId)
Alias for calling Builder.vectorStoreId with
vectorStoreId.orElse(null)
.
-
body
final FileBatchCreateParams.Builder body(FileBatchCreateParams.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:
-
fileIds
final FileBatchCreateParams.Builder fileIds(List<String> fileIds)
A list of File IDs that the vector store should use. Useful for tools like
file_search
that can access files.
-
fileIds
final FileBatchCreateParams.Builder fileIds(JsonField<List<String>> fileIds)
Sets Builder.fileIds to an arbitrary JSON value.
You should usually call Builder.fileIds with a well-typed
List<String>
value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
addFileId
final FileBatchCreateParams.Builder addFileId(String fileId)
-
attributes
final FileBatchCreateParams.Builder attributes(FileBatchCreateParams.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 FileBatchCreateParams.Builder attributes(Optional<FileBatchCreateParams.Attributes> attributes)
Alias for calling Builder.attributes with
attributes.orElse(null)
.
-
attributes
final FileBatchCreateParams.Builder attributes(JsonField<FileBatchCreateParams.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 FileBatchCreateParams.Builder chunkingStrategy(FileChunkingStrategyParam chunkingStrategy)
The chunking strategy used to chunk the file(s). If not set, will use the
auto
strategy. Only applicable iffile_ids
is non-empty.
-
chunkingStrategy
final FileBatchCreateParams.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 FileBatchCreateParams.Builder chunkingStrategy(AutoFileChunkingStrategyParam auto)
Alias for calling chunkingStrategy with
FileChunkingStrategyParam.ofAuto(auto)
.
-
chunkingStrategy
final FileBatchCreateParams.Builder chunkingStrategy(StaticFileChunkingStrategyObjectParam static_)
Alias for calling chunkingStrategy with
FileChunkingStrategyParam.ofStatic(static_)
.
-
staticChunkingStrategy
final FileBatchCreateParams.Builder staticChunkingStrategy(StaticFileChunkingStrategy static_)
Alias for calling chunkingStrategy with the following:
StaticFileChunkingStrategyObjectParam.builder() .static_(static_) .build()
-
additionalBodyProperties
final FileBatchCreateParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
putAdditionalBodyProperty
final FileBatchCreateParams.Builder putAdditionalBodyProperty(String key, JsonValue value)
-
putAllAdditionalBodyProperties
final FileBatchCreateParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)
-
removeAdditionalBodyProperty
final FileBatchCreateParams.Builder removeAdditionalBodyProperty(String key)
-
removeAllAdditionalBodyProperties
final FileBatchCreateParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)
-
additionalHeaders
final FileBatchCreateParams.Builder additionalHeaders(Headers additionalHeaders)
-
additionalHeaders
final FileBatchCreateParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
putAdditionalHeader
final FileBatchCreateParams.Builder putAdditionalHeader(String name, String value)
-
putAdditionalHeaders
final FileBatchCreateParams.Builder putAdditionalHeaders(String name, Iterable<String> values)
-
putAllAdditionalHeaders
final FileBatchCreateParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)
-
putAllAdditionalHeaders
final FileBatchCreateParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
replaceAdditionalHeaders
final FileBatchCreateParams.Builder replaceAdditionalHeaders(String name, String value)
-
replaceAdditionalHeaders
final FileBatchCreateParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)
-
replaceAllAdditionalHeaders
final FileBatchCreateParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)
-
replaceAllAdditionalHeaders
final FileBatchCreateParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)
-
removeAdditionalHeaders
final FileBatchCreateParams.Builder removeAdditionalHeaders(String name)
-
removeAllAdditionalHeaders
final FileBatchCreateParams.Builder removeAllAdditionalHeaders(Set<String> names)
-
additionalQueryParams
final FileBatchCreateParams.Builder additionalQueryParams(QueryParams additionalQueryParams)
-
additionalQueryParams
final FileBatchCreateParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
putAdditionalQueryParam
final FileBatchCreateParams.Builder putAdditionalQueryParam(String key, String value)
-
putAdditionalQueryParams
final FileBatchCreateParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)
-
putAllAdditionalQueryParams
final FileBatchCreateParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
putAllAdditionalQueryParams
final FileBatchCreateParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
replaceAdditionalQueryParams
final FileBatchCreateParams.Builder replaceAdditionalQueryParams(String key, String value)
-
replaceAdditionalQueryParams
final FileBatchCreateParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)
-
replaceAllAdditionalQueryParams
final FileBatchCreateParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)
-
replaceAllAdditionalQueryParams
final FileBatchCreateParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)
-
removeAdditionalQueryParams
final FileBatchCreateParams.Builder removeAdditionalQueryParams(String key)
-
removeAllAdditionalQueryParams
final FileBatchCreateParams.Builder removeAllAdditionalQueryParams(Set<String> keys)
-
build
final FileBatchCreateParams build()
Returns an immutable instance of FileBatchCreateParams.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.fileIds()
-
-
-
-