Class VectorStore.Builder
-
- All Implemented Interfaces:
public final class VectorStore.Builder
A builder for VectorStore.
-
-
Method Summary
Modifier and Type Method Description final VectorStore.Builder
id(String id)
The identifier, which can be referenced in API endpoints. final VectorStore.Builder
id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value. final VectorStore.Builder
createdAt(Long createdAt)
The Unix timestamp (in seconds) for when the vector store was created. final VectorStore.Builder
createdAt(JsonField<Long> createdAt)
Sets Builder.createdAt to an arbitrary JSON value. final VectorStore.Builder
fileCounts(VectorStore.FileCounts fileCounts)
final VectorStore.Builder
fileCounts(JsonField<VectorStore.FileCounts> fileCounts)
Sets Builder.fileCounts to an arbitrary JSON value. final VectorStore.Builder
lastActiveAt(Long lastActiveAt)
The Unix timestamp (in seconds) for when the vector store was last active. final VectorStore.Builder
lastActiveAt(Long lastActiveAt)
Alias for Builder.lastActiveAt. final VectorStore.Builder
lastActiveAt(Optional<Long> lastActiveAt)
Alias for calling Builder.lastActiveAt with lastActiveAt.orElse(null)
.final VectorStore.Builder
lastActiveAt(JsonField<Long> lastActiveAt)
Sets Builder.lastActiveAt to an arbitrary JSON value. final VectorStore.Builder
metadata(VectorStore.Metadata metadata)
Set of 16 key-value pairs that can be attached to an object. final VectorStore.Builder
metadata(Optional<VectorStore.Metadata> metadata)
Alias for calling Builder.metadata with metadata.orElse(null)
.final VectorStore.Builder
metadata(JsonField<VectorStore.Metadata> metadata)
Sets Builder.metadata to an arbitrary JSON value. final VectorStore.Builder
name(String name)
The name of the vector store. final VectorStore.Builder
name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value. final VectorStore.Builder
object_(JsonValue object_)
Sets the field to an arbitrary JSON value. final VectorStore.Builder
status(VectorStore.Status status)
The status of the vector store, which can be either expired
,in_progress
, orcompleted
.final VectorStore.Builder
status(JsonField<VectorStore.Status> status)
Sets Builder.status to an arbitrary JSON value. final VectorStore.Builder
usageBytes(Long usageBytes)
The total number of bytes used by the files in the vector store. final VectorStore.Builder
usageBytes(JsonField<Long> usageBytes)
Sets Builder.usageBytes to an arbitrary JSON value. final VectorStore.Builder
expiresAfter(VectorStore.ExpiresAfter expiresAfter)
The expiration policy for a vector store. final VectorStore.Builder
expiresAfter(JsonField<VectorStore.ExpiresAfter> expiresAfter)
Sets Builder.expiresAfter to an arbitrary JSON value. final VectorStore.Builder
expiresAt(Long expiresAt)
The Unix timestamp (in seconds) for when the vector store will expire. final VectorStore.Builder
expiresAt(Long expiresAt)
Alias for Builder.expiresAt. final VectorStore.Builder
expiresAt(Optional<Long> expiresAt)
Alias for calling Builder.expiresAt with expiresAt.orElse(null)
.final VectorStore.Builder
expiresAt(JsonField<Long> expiresAt)
Sets Builder.expiresAt to an arbitrary JSON value. final VectorStore.Builder
additionalProperties(Map<String, JsonValue> additionalProperties)
final VectorStore.Builder
putAdditionalProperty(String key, JsonValue value)
final VectorStore.Builder
putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
final VectorStore.Builder
removeAdditionalProperty(String key)
final VectorStore.Builder
removeAllAdditionalProperties(Set<String> keys)
final VectorStore
build()
Returns an immutable instance of VectorStore. -
-
Method Detail
-
id
final VectorStore.Builder id(String id)
The identifier, which can be referenced in API endpoints.
-
id
final VectorStore.Builder id(JsonField<String> id)
Sets Builder.id to an arbitrary JSON value.
You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
createdAt
final VectorStore.Builder createdAt(Long createdAt)
The Unix timestamp (in seconds) for when the vector store was created.
-
createdAt
final VectorStore.Builder createdAt(JsonField<Long> createdAt)
Sets Builder.createdAt to an arbitrary JSON value.
You should usually call Builder.createdAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
fileCounts
final VectorStore.Builder fileCounts(VectorStore.FileCounts fileCounts)
-
fileCounts
final VectorStore.Builder fileCounts(JsonField<VectorStore.FileCounts> fileCounts)
Sets Builder.fileCounts to an arbitrary JSON value.
You should usually call Builder.fileCounts with a well-typed FileCounts value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
lastActiveAt
final VectorStore.Builder lastActiveAt(Long lastActiveAt)
The Unix timestamp (in seconds) for when the vector store was last active.
-
lastActiveAt
final VectorStore.Builder lastActiveAt(Long lastActiveAt)
Alias for Builder.lastActiveAt.
This unboxed primitive overload exists for backwards compatibility.
-
lastActiveAt
final VectorStore.Builder lastActiveAt(Optional<Long> lastActiveAt)
Alias for calling Builder.lastActiveAt with
lastActiveAt.orElse(null)
.
-
lastActiveAt
final VectorStore.Builder lastActiveAt(JsonField<Long> lastActiveAt)
Sets Builder.lastActiveAt to an arbitrary JSON value.
You should usually call Builder.lastActiveAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
metadata
final VectorStore.Builder metadata(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.
-
metadata
final VectorStore.Builder metadata(Optional<VectorStore.Metadata> metadata)
Alias for calling Builder.metadata with
metadata.orElse(null)
.
-
metadata
final VectorStore.Builder metadata(JsonField<VectorStore.Metadata> metadata)
Sets Builder.metadata to an arbitrary JSON value.
You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
name
final VectorStore.Builder name(String name)
The name of the vector store.
-
name
final VectorStore.Builder name(JsonField<String> name)
Sets Builder.name to an arbitrary JSON value.
You should usually call Builder.name with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
object_
final VectorStore.Builder object_(JsonValue object_)
Sets the field to an arbitrary JSON value.
It is usually unnecessary to call this method because the field defaults to the following:
JsonValue.from("vector_store")
This method is primarily for setting the field to an undocumented or not yet supported value.
-
status
final VectorStore.Builder status(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.
-
status
final VectorStore.Builder status(JsonField<VectorStore.Status> status)
Sets Builder.status to an arbitrary JSON value.
You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
usageBytes
final VectorStore.Builder usageBytes(Long usageBytes)
The total number of bytes used by the files in the vector store.
-
usageBytes
final VectorStore.Builder usageBytes(JsonField<Long> usageBytes)
Sets Builder.usageBytes to an arbitrary JSON value.
You should usually call Builder.usageBytes with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
expiresAfter
final VectorStore.Builder expiresAfter(VectorStore.ExpiresAfter expiresAfter)
The expiration policy for a vector store.
-
expiresAfter
final VectorStore.Builder expiresAfter(JsonField<VectorStore.ExpiresAfter> expiresAfter)
Sets Builder.expiresAfter to an arbitrary JSON value.
You should usually call Builder.expiresAfter with a well-typed ExpiresAfter value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
expiresAt
final VectorStore.Builder expiresAt(Long expiresAt)
The Unix timestamp (in seconds) for when the vector store will expire.
-
expiresAt
final VectorStore.Builder expiresAt(Long expiresAt)
Alias for Builder.expiresAt.
This unboxed primitive overload exists for backwards compatibility.
-
expiresAt
final VectorStore.Builder expiresAt(Optional<Long> expiresAt)
Alias for calling Builder.expiresAt with
expiresAt.orElse(null)
.
-
expiresAt
final VectorStore.Builder expiresAt(JsonField<Long> expiresAt)
Sets Builder.expiresAt to an arbitrary JSON value.
You should usually call Builder.expiresAt with a well-typed Long value instead. This method is primarily for setting the field to an undocumented or not yet supported value.
-
additionalProperties
final VectorStore.Builder additionalProperties(Map<String, JsonValue> additionalProperties)
-
putAdditionalProperty
final VectorStore.Builder putAdditionalProperty(String key, JsonValue value)
-
putAllAdditionalProperties
final VectorStore.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)
-
removeAdditionalProperty
final VectorStore.Builder removeAdditionalProperty(String key)
-
removeAllAdditionalProperties
final VectorStore.Builder removeAllAdditionalProperties(Set<String> keys)
-
build
final VectorStore build()
Returns an immutable instance of VectorStore.
Further updates to this Builder will not mutate the returned instance.
The following fields are required:
.id() .createdAt() .fileCounts() .lastActiveAt() .metadata() .name() .status() .usageBytes()
-
-
-
-