Class VectorStore
-
- All Implemented Interfaces:
public final class VectorStore
A vector store is a collection of processed files can be used by the
file_search
tool.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final class
VectorStore.Builder
A builder for VectorStore.
public final class
VectorStore.FileCounts
public final class
VectorStore.Status
The status of the vector store, which can be either
expired
,in_progress
, orcompleted
. A status ofcompleted
indicates that the vector store is ready for use.public final class
VectorStore.ExpiresAfter
The expiration policy for a vector store.
-
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 was created. final VectorStore.FileCounts
fileCounts()
final Optional<Long>
lastActiveAt()
The Unix timestamp (in seconds) for when the vector store was last active. final Optional<Metadata>
metadata()
Set of 16 key-value pairs that can be attached to an object. final String
name()
The name of the vector store. final JsonValue
_object_()
The object type, which is always vector_store
.final VectorStore.Status
status()
The status of the vector store, which can be either expired
,in_progress
, orcompleted
.final Long
usageBytes()
The total number of bytes used by the files in the vector store. final Optional<VectorStore.ExpiresAfter>
expiresAfter()
The expiration policy for a vector store. final Optional<Long>
expiresAt()
The Unix timestamp (in seconds) for when the vector store will expire. 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 was created. final JsonField<VectorStore.FileCounts>
_fileCounts()
final JsonField<Long>
_lastActiveAt()
The Unix timestamp (in seconds) for when the vector store was last active. final JsonField<Metadata>
_metadata()
Set of 16 key-value pairs that can be attached to an object. final JsonField<String>
_name()
The name of the vector store. final JsonField<VectorStore.Status>
_status()
The status of the vector store, which can be either expired
,in_progress
, orcompleted
.final JsonField<Long>
_usageBytes()
The total number of bytes used by the files in the vector store. final JsonField<VectorStore.ExpiresAfter>
_expiresAfter()
The expiration policy for a vector store. final JsonField<Long>
_expiresAt()
The Unix timestamp (in seconds) for when the vector store will expire. final Map<String, JsonValue>
_additionalProperties()
final VectorStore
validate()
final VectorStore.Builder
toBuilder()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static VectorStore.Builder
builder()
-
-
Method Detail
-
createdAt
final Long createdAt()
The Unix timestamp (in seconds) for when the vector store was created.
-
fileCounts
final VectorStore.FileCounts fileCounts()
-
lastActiveAt
final Optional<Long> lastActiveAt()
The Unix timestamp (in seconds) for when the vector store was last active.
-
metadata
final Optional<Metadata> metadata()
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.
-
status
final VectorStore.Status status()
The status of the vector store, which can be either
expired
,in_progress
, orcompleted
. A status ofcompleted
indicates that the vector store is ready for use.
-
usageBytes
final Long usageBytes()
The total number of bytes used by the files in the vector store.
-
expiresAfter
final Optional<VectorStore.ExpiresAfter> expiresAfter()
The expiration policy for a vector store.
-
expiresAt
final Optional<Long> expiresAt()
The Unix timestamp (in seconds) for when the vector store will expire.
-
_createdAt
final JsonField<Long> _createdAt()
The Unix timestamp (in seconds) for when the vector store was created.
-
_fileCounts
final JsonField<VectorStore.FileCounts> _fileCounts()
-
_lastActiveAt
final JsonField<Long> _lastActiveAt()
The Unix timestamp (in seconds) for when the vector store was last active.
-
_metadata
final JsonField<Metadata> _metadata()
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.
-
_status
final JsonField<VectorStore.Status> _status()
The status of the vector store, which can be either
expired
,in_progress
, orcompleted
. A status ofcompleted
indicates that the vector store is ready for use.
-
_usageBytes
final JsonField<Long> _usageBytes()
The total number of bytes used by the files in the vector store.
-
_expiresAfter
final JsonField<VectorStore.ExpiresAfter> _expiresAfter()
The expiration policy for a vector store.
-
_expiresAt
final JsonField<Long> _expiresAt()
The Unix timestamp (in seconds) for when the vector store will expire.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
validate
final VectorStore validate()
-
toBuilder
final VectorStore.Builder toBuilder()
-
builder
final static VectorStore.Builder builder()
-
-
-
-