VectorStoreObject class

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

Annotations
  • @freezed

Constructors

VectorStoreObject({required String id, required String object, @JsonKey(name: 'created_at') required int createdAt, required String? name, @JsonKey(name: 'usage_bytes') required int usageBytes, @JsonKey(name: 'file_counts') required VectorStoreObjectFileCounts fileCounts, required VectorStoreObjectStatus status, @JsonKey(name: 'expires_after', includeIfNull: false) VectorStoreExpirationAfter? expiresAfter, @JsonKey(name: 'expires_at', includeIfNull: false) int? expiresAt, @JsonKey(name: 'last_active_at') required int? lastActiveAt, required dynamic metadata})
Factory constructor for VectorStoreObject
const
factory
VectorStoreObject.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

copyWith → $VectorStoreObjectCopyWith<VectorStoreObject>
Create a copy of VectorStoreObject with the given fields replaced by the non-null parameter values.
no setterinherited
createdAt → int
The Unix timestamp (in seconds) for when the vector store was created.
no setterinherited
expiresAfter → VectorStoreExpirationAfter?
The expiration policy for a vector store.
no setterinherited
expiresAt → int?
The Unix timestamp (in seconds) for when the vector store will expire.
no setterinherited
fileCounts → VectorStoreObjectFileCounts
The number of files in the vector store.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
id → String
The identifier, which can be referenced in API endpoints.
no setterinherited
lastActiveAt → int?
The Unix timestamp (in seconds) for when the vector store was last active.
no setterinherited
metadata → dynamic
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.
no setterinherited
name → String?
The name of the vector store.
no setterinherited
object → String
The object type, which is always vector_store.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
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.
no setterinherited
usageBytes → int
The total number of bytes used by the files in the vector store.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this VectorStoreObject to a JSON map.
inherited
toMap() → Map<String, dynamic>
Map representation of object (not serialized)
toString() → String
A string representation of this object.
inherited
validateSchema() → String?
Perform validations on the schema property values

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

propertyNames → const List<String>
List of all property names of schema