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.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.
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<VectorStore.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()
Returns the raw JSON value of id. final JsonField<Long>
_createdAt()
Returns the raw JSON value of createdAt. final JsonField<VectorStore.FileCounts>
_fileCounts()
Returns the raw JSON value of fileCounts. final JsonField<Long>
_lastActiveAt()
Returns the raw JSON value of lastActiveAt. final JsonField<VectorStore.Metadata>
_metadata()
Returns the raw JSON value of metadata. final JsonField<String>
_name()
Returns the raw JSON value of name. final JsonField<VectorStore.Status>
_status()
Returns the raw JSON value of status. final JsonField<Long>
_usageBytes()
Returns the raw JSON value of usageBytes. final JsonField<VectorStore.ExpiresAfter>
_expiresAfter()
Returns the raw JSON value of expiresAfter. final JsonField<Long>
_expiresAt()
Returns the raw JSON value of expiresAt. final Map<String, JsonValue>
_additionalProperties()
final VectorStore.Builder
toBuilder()
final VectorStore
validate()
final Boolean
isValid()
Boolean
equals(Object other)
Integer
hashCode()
String
toString()
final static VectorStore.Builder
builder()
Returns a mutable builder for constructing an instance of VectorStore. -
-
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<VectorStore.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.
-
_object_
final JsonValue _object_()
The object type, which is always
vector_store
.Expected to always return the following:
JsonValue.from("vector_store")
However, this method can be useful for debugging and logging (e.g. if the server responded with an unexpected value).
-
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.
-
_id
final JsonField<String> _id()
Returns the raw JSON value of id.
Unlike id, this method doesn't throw if the JSON field has an unexpected type.
-
_createdAt
final JsonField<Long> _createdAt()
Returns the raw JSON value of createdAt.
Unlike createdAt, this method doesn't throw if the JSON field has an unexpected type.
-
_fileCounts
final JsonField<VectorStore.FileCounts> _fileCounts()
Returns the raw JSON value of fileCounts.
Unlike fileCounts, this method doesn't throw if the JSON field has an unexpected type.
-
_lastActiveAt
final JsonField<Long> _lastActiveAt()
Returns the raw JSON value of lastActiveAt.
Unlike lastActiveAt, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<VectorStore.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_status
final JsonField<VectorStore.Status> _status()
Returns the raw JSON value of status.
Unlike status, this method doesn't throw if the JSON field has an unexpected type.
-
_usageBytes
final JsonField<Long> _usageBytes()
Returns the raw JSON value of usageBytes.
Unlike usageBytes, this method doesn't throw if the JSON field has an unexpected type.
-
_expiresAfter
final JsonField<VectorStore.ExpiresAfter> _expiresAfter()
Returns the raw JSON value of expiresAfter.
Unlike expiresAfter, this method doesn't throw if the JSON field has an unexpected type.
-
_expiresAt
final JsonField<Long> _expiresAt()
Returns the raw JSON value of expiresAt.
Unlike expiresAt, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final VectorStore.Builder toBuilder()
-
validate
final VectorStore validate()
-
builder
final static VectorStore.Builder builder()
Returns a mutable builder for constructing an instance of VectorStore.
The following fields are required:
.id() .createdAt() .fileCounts() .lastActiveAt() .metadata() .name() .status() .usageBytes()
-
-
-
-