openai-core/com.aallam.openai.api.vectorstore/VectorStore

VectorStore

@Serializable

data class VectorStore(val id: VectorStoreId, val createdAt: Long, val name: String? = null, val usageBytes: Long, val fileCounts: FileCounts, val status: Status, val expiresAfter: ExpirationPolicy? = null, val expiresAt: Long? = null, val lastActiveAt: Long? = null, val metadata: Map<String, String>? = null)

The vector store object.

Constructors

VectorStore

constructor(id: VectorStoreId, createdAt: Long, name: String? = null, usageBytes: Long, fileCounts: FileCounts, status: Status, expiresAfter: ExpirationPolicy? = null, expiresAt: Long? = null, lastActiveAt: Long? = null, metadata: Map<String, String>? = null)

Properties

createdAt

@SerialName(value = "created_at")

val createdAt: Long

The Unix timestamp (in seconds) for when the vector store was created.

expiresAfter

@SerialName(value = "expires_after")

val expiresAfter: ExpirationPolicy? = null

The expiration policy for a vector store.

expiresAt

@SerialName(value = "expires_at")

val expiresAt: Long? = null

The Unix timestamp (in seconds) for when the vector store will expire.

fileCounts

@SerialName(value = "file_counts")

val fileCounts: FileCounts

Files that are currently being processed.

@SerialName(value = "id")

val id: VectorStoreId

The identifier, which can be referenced in API endpoints.

lastActiveAt

@SerialName(value = "last_active_at")

val lastActiveAt: Long? = null

The Unix timestamp (in seconds) for when the vector store was last active.

metadata

@SerialName(value = "metadata")

val metadata: Map<String, String>? = null

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. Keys can be a maximum of 64 characters long, and values can be a maximum of 512 characters long.

name

@SerialName(value = "name")

val name: String? = null

The name of the vector store.

status

@SerialName(value = "status")

val status: Status

The status of the vector store, which can be either expired, in_progress, or completed. A status of completed indicates that the vector store is ready for use.

usageBytes

@SerialName(value = "usage_bytes")

val usageBytes: Long

The byte size of the vector store that is currently in use.