CreateVectorStoreRequest class abstract

Request object for the Create assistant file endpoint.

Available extensions
Annotations
  • @freezed

Constructors

CreateVectorStoreRequest({@JsonKey.new(includeIfNull: false) String? name, @JsonKey.new(name: 'file_ids', includeIfNull: false) List<String>? fileIds, @JsonKey.new(name: 'expires_after', includeIfNull: false) VectorStoreExpirationAfter? expiresAfter, @JsonKey.new(name: 'chunking_strategy', includeIfNull: false) ChunkingStrategyRequestParam? chunkingStrategy, @JsonKey.new(includeIfNull: false) dynamic metadata})
Factory constructor for CreateVectorStoreRequest
const
factory
CreateVectorStoreRequest.fromJson(Map<String, dynamic> json)
Object construction from a JSON representation
factory

Properties

chunkingStrategy → ChunkingStrategyRequestParam?
The chunking strategy used to chunk the file(s). If not set, will use the auto strategy. Any of: AutoChunkingStrategyRequestParam, StaticChunkingStrategyRequestParam
no setterinherited
copyWith → $CreateVectorStoreRequestCopyWith<CreateVectorStoreRequest>
Create a copy of CreateVectorStoreRequest with the given fields replaced by the non-null parameter values.
no setterinherited
expiresAfter → VectorStoreExpirationAfter?
The expiration policy for a vector store.
no setterinherited
fileIds → List<String>?
A list of File IDs that the vector store should use. Useful for tools like file_search that can access files.
no setterinherited
hashCode → int
The hash code for this object.
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
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

map<TResult extends Object?>(TResult $default(_CreateVectorStoreRequest value)) → TResult

Available on CreateVectorStoreRequest, provided by the CreateVectorStoreRequestPatterns extension

A switch-like method, using callbacks.
mapOrNull<TResult extends Object?>(TResult? $default(_CreateVectorStoreRequest value)?) → TResult?

Available on CreateVectorStoreRequest, provided by the CreateVectorStoreRequestPatterns extension

A variant of map that fallback to returning null.
maybeMap<TResult extends Object?>(TResult $default(_CreateVectorStoreRequest value)?, {required TResult orElse()}) → TResult

Available on CreateVectorStoreRequest, provided by the CreateVectorStoreRequestPatterns extension

A variant of map that fallback to returning orElse.
maybeWhen<TResult extends Object?>(TResult $default(String? name, List<String>? fileIds, VectorStoreExpirationAfter? expiresAfter, ChunkingStrategyRequestParam? chunkingStrategy, dynamic metadata)?, {required TResult orElse()}) → TResult

Available on CreateVectorStoreRequest, provided by the CreateVectorStoreRequestPatterns extension

A variant of when that fallback to an orElse callback.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
Serializes this CreateVectorStoreRequest 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
when<TResult extends Object?>(TResult $default(String? name, List<String>? fileIds, VectorStoreExpirationAfter? expiresAfter, ChunkingStrategyRequestParam? chunkingStrategy, dynamic metadata)) → TResult

Available on CreateVectorStoreRequest, provided by the CreateVectorStoreRequestPatterns extension

A switch-like method, using callbacks.
whenOrNull<TResult extends Object?>(TResult? $default(String? name, List<String>? fileIds, VectorStoreExpirationAfter? expiresAfter, ChunkingStrategyRequestParam? chunkingStrategy, dynamic metadata)?) → TResult?

Available on CreateVectorStoreRequest, provided by the CreateVectorStoreRequestPatterns extension

A variant of when that fallback to returning null

Operators

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

Constants

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