class

OpenAI::VectorStoreObject

Inherits JSON::Serializable < Reference < Object

A vector store is a collection of processed files can be used by the file_search tool.

Constructors

new(pull : JSON::PullParser)
Source
new(id : String = "", object : VectorStoreObjectObject = VectorStoreObjectObject::VectorStore, created_at : Int64 = 0, name : String = "", usage_bytes : Int64 = 0, file_counts : VectorStoreObjectFileCounts = VectorStoreObjectFileCounts.new, status : VectorStoreObjectStatus = VectorStoreObjectStatus::Expired, expires_after : VectorStoreExpirationAfter | Nil = nil, expires_at : VectorStoreObjectExpiresAt | Nil = nil, last_active_at : VectorStoreObjectLastActiveAt = nil, metadata : Metadata = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

created_at

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

Source
created_at=(created_at : Int64)

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

Source
expires_after
Source
expires_after=(expires_after : VectorStoreExpirationAfter | Nil)
Source
expires_at
Source
expires_at=(expires_at : VectorStoreObjectExpiresAt | Nil)
Source
file_counts
Source
file_counts=(file_counts : VectorStoreObjectFileCounts)
Source
id

The identifier, which can be referenced in API endpoints.

Source
id=(id : String)

The identifier, which can be referenced in API endpoints.

Source
last_active_at
Source
last_active_at=(last_active_at : VectorStoreObjectLastActiveAt)
Source
metadata
Source
metadata=(metadata : Metadata)
Source
name

The name of the vector store.

Source
name=(name : String)

The name of the vector store.

Source
object

The object type, which is always vector_store.

Source
object=(object : VectorStoreObjectObject)

The object type, which is always vector_store.

Source
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.

Source
status=(status : VectorStoreObjectStatus)

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.

Source
usage_bytes

The total number of bytes used by the files in the vector store.

Source
usage_bytes=(usage_bytes : Int64)

The total number of bytes used by the files in the vector store.

Source