All Implemented Interfaces:


public final class VectorStoreFile

A list of files attached to a vector store.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`VectorStoreFile.Builder`	A builder for VectorStoreFile.
`public final class`	`VectorStoreFile.LastError`	The last error associated with this vector store file. Will be `null` if there are no errors.
`public final class`	`VectorStoreFile.Status`	The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`. The status `completed` indicates that the vector store file is ready for use.
`public final class`	`VectorStoreFile.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.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`id()`	The identifier, which can be referenced in API endpoints.
`final Long`	`createdAt()`	The Unix timestamp (in seconds) for when the vector store file was created.
`final Optional<VectorStoreFile.LastError>`	`lastError()`	The last error associated with this vector store file.
`final JsonValue`	`_object_()`	The object type, which is always `vector_store.file`.
`final VectorStoreFile.Status`	`status()`	The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`.
`final Long`	`usageBytes()`	The total vector store usage in bytes.
`final String`	`vectorStoreId()`	The ID of the vector store that the File is attached to.
`final Optional<VectorStoreFile.Attributes>`	`attributes()`	Set of 16 key-value pairs that can be attached to an object.
`final Optional<FileChunkingStrategy>`	`chunkingStrategy()`	The strategy used to chunk the file.
`final JsonField<String>`	`_id()`	The identifier, which can be referenced in API endpoints.
`final JsonField<Long>`	`_createdAt()`	The Unix timestamp (in seconds) for when the vector store file was created.
`final JsonField<VectorStoreFile.LastError>`	`_lastError()`	The last error associated with this vector store file.
`final JsonField<VectorStoreFile.Status>`	`_status()`	The status of the vector store file, which can be either `in_progress`, `completed`, `cancelled`, or `failed`.
`final JsonField<Long>`	`_usageBytes()`	The total vector store usage in bytes.
`final JsonField<String>`	`_vectorStoreId()`	The ID of the vector store that the File is attached to.
`final JsonField<VectorStoreFile.Attributes>`	`_attributes()`	Set of 16 key-value pairs that can be attached to an object.
`final JsonField<FileChunkingStrategy>`	`_chunkingStrategy()`	The strategy used to chunk the file.
`final Map<String, JsonValue>`	`_additionalProperties()`
`final VectorStoreFile`	`validate()`
`final VectorStoreFile.Builder`	`toBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static VectorStoreFile.Builder`	`builder()`	Returns a mutable builder for constructing an instance of VectorStoreFile.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - id
```
 final String id()
```
    The identifier, which can be referenced in API endpoints.
  - createdAt
```
 final Long createdAt()
```
    The Unix timestamp (in seconds) for when the vector store file was created.
  - lastError
```
 final Optional<VectorStoreFile.LastError> lastError()
```
    The last error associated with this vector store file. Will be null if there are no errors.
  - _object_
```
 final JsonValue _object_()
```
    The object type, which is always vector_store.file.
  - status
```
 final VectorStoreFile.Status status()
```
    The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.
  - usageBytes
```
 final Long usageBytes()
```
    The total vector store usage in bytes. Note that this may be different from the original file size.
  - vectorStoreId
```
 final String vectorStoreId()
```
    The ID of the vector store that the File is attached to.
  - attributes
```
 final Optional<VectorStoreFile.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<FileChunkingStrategy> chunkingStrategy()
```
    The strategy used to chunk the file.
  - _id
```
 final JsonField<String> _id()
```
    The identifier, which can be referenced in API endpoints.
  - _createdAt
```
 final JsonField<Long> _createdAt()
```
    The Unix timestamp (in seconds) for when the vector store file was created.
  - _lastError
```
 final JsonField<VectorStoreFile.LastError> _lastError()
```
    The last error associated with this vector store file. Will be null if there are no errors.
  - _status
```
 final JsonField<VectorStoreFile.Status> _status()
```
    The status of the vector store file, which can be either in_progress, completed, cancelled, or failed. The status completed indicates that the vector store file is ready for use.
  - _usageBytes
```
 final JsonField<Long> _usageBytes()
```
    The total vector store usage in bytes. Note that this may be different from the original file size.
  - _vectorStoreId
```
 final JsonField<String> _vectorStoreId()
```
    The ID of the vector store that the File is attached to.
  - _attributes
```
 final JsonField<VectorStoreFile.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 JsonField<FileChunkingStrategy> _chunkingStrategy()
```
    The strategy used to chunk the file.
  - _additionalProperties
```
 final Map<String, JsonValue> _additionalProperties()
```
  - validate
```
 final VectorStoreFile validate()
```
  - toBuilder
```
 final VectorStoreFile.Builder toBuilder()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - builder
```
 final static VectorStoreFile.Builder builder()
```
    Returns a mutable builder for constructing an instance of VectorStoreFile.
    The following fields are required:
    .id() .createdAt() .lastError() .status() .usageBytes() .vectorStoreId()

Class VectorStoreFile

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

id

createdAt

lastError

_object_

status

usageBytes

vectorStoreId

attributes

chunkingStrategy

_id

_createdAt

_lastError

_status

_usageBytes

_vectorStoreId

_attributes

_chunkingStrategy

_additionalProperties

validate

toBuilder

equals

hashCode

toString

builder