Class FileBatchCreateParams.File
-
- All Implemented Interfaces:
public final class FileBatchCreateParams.File
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classFileBatchCreateParams.File.BuilderA builder for File.
public final classFileBatchCreateParams.File.AttributesSet 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.
-
Method Summary
Modifier and Type Method Description final StringfileId()A File ID that the vector store should use. final Optional<FileBatchCreateParams.File.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 JsonField<String>_fileId()Returns the raw JSON value of fileId. final JsonField<FileBatchCreateParams.File.Attributes>_attributes()Returns the raw JSON value of attributes. final JsonField<FileChunkingStrategyParam>_chunkingStrategy()Returns the raw JSON value of chunkingStrategy. final Map<String, JsonValue>_additionalProperties()final FileBatchCreateParams.File.BuildertoBuilder()final FileBatchCreateParams.Filevalidate()final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static FileBatchCreateParams.File.Builderbuilder()Returns a mutable builder for constructing an instance of File. -
-
Method Detail
-
fileId
final String fileId()
A File ID that the vector store should use. Useful for tools like
file_searchthat can access files.
-
attributes
final Optional<FileBatchCreateParams.File.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.
-
_fileId
final JsonField<String> _fileId()
Returns the raw JSON value of fileId.
Unlike fileId, this method doesn't throw if the JSON field has an unexpected type.
-
_attributes
final JsonField<FileBatchCreateParams.File.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.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final FileBatchCreateParams.File.Builder toBuilder()
-
validate
final FileBatchCreateParams.File validate()
-
builder
final static FileBatchCreateParams.File.Builder builder()
Returns a mutable builder for constructing an instance of File.
The following fields are required:
.fileId()
-
-
-
-