Class FileBatchCreateParams.Body
-
- All Implemented Interfaces:
public final class FileBatchCreateParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileBatchCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Optional<FileBatchCreateParams.Attributes>attributes()Set of 16 key-value pairs that can be attached to an object. final Optional<FileChunkingStrategyParam>chunkingStrategy()The chunking strategy used to chunk the file(s). final Optional<List<String>>fileIds()A list of File IDs that the vector store should use. final Optional<List<FileBatchCreateParams.File>>files()A list of objects that each include a file_idplus optionalattributesorchunking_strategy.final JsonField<FileBatchCreateParams.Attributes>_attributes()Returns the raw JSON value of attributes. final JsonField<FileChunkingStrategyParam>_chunkingStrategy()Returns the raw JSON value of chunkingStrategy. final JsonField<List<String>>_fileIds()Returns the raw JSON value of fileIds. final JsonField<List<FileBatchCreateParams.File>>_files()Returns the raw JSON value of files. final Map<String, JsonValue>_additionalProperties()final FileBatchCreateParams.Body.BuildertoBuilder()final FileBatchCreateParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileBatchCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
attributes
final Optional<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.
-
chunkingStrategy
final Optional<FileChunkingStrategyParam> chunkingStrategy()
The chunking strategy used to chunk the file(s). If not set, will use the
autostrategy. Only applicable iffile_idsis non-empty.
-
fileIds
final Optional<List<String>> fileIds()
A list of File IDs that the vector store should use. Useful for tools like
file_searchthat can access files. Ifattributesorchunking_strategyare provided, they will be applied to all files in the batch. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive withfiles.
-
files
final Optional<List<FileBatchCreateParams.File>> files()
A list of objects that each include a
file_idplus optionalattributesorchunking_strategy. Use this when you need to override metadata for specific files. The globalattributesorchunking_strategywill be ignored and must be specified for each file. The maximum batch size is 2000 files. This endpoint is recommended for multi-file ingestion and helps reduce per-vector-store write request pressure. Mutually exclusive withfile_ids.
-
_attributes
final JsonField<FileBatchCreateParams.Attributes> _attributes()
Returns the raw JSON value of attributes.
Unlike attributes, this method doesn't throw if the JSON field has an unexpected type.
-
_chunkingStrategy
final JsonField<FileChunkingStrategyParam> _chunkingStrategy()
Returns the raw JSON value of chunkingStrategy.
Unlike chunkingStrategy, this method doesn't throw if the JSON field has an unexpected type.
-
_fileIds
final JsonField<List<String>> _fileIds()
Returns the raw JSON value of fileIds.
Unlike fileIds, this method doesn't throw if the JSON field has an unexpected type.
-
_files
final JsonField<List<FileBatchCreateParams.File>> _files()
Returns the raw JSON value of files.
Unlike files, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FileBatchCreateParams.Body.Builder toBuilder()
-
validate
final FileBatchCreateParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static FileBatchCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
-
-
-
-