Class CollectionVectorAttribute

Namespace

DataStax.AstraDB.DataApi.Core

Assembly

DataStax.AstraDB.DataApi.dll

Specifies vector options for a collection.

[AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public class CollectionVectorAttribute : Attribute, _Attribute

Inheritance

object

Attribute

CollectionVectorAttribute

Implements

_Attribute

Inherited Members

Attribute.GetCustomAttributes(MemberInfo, Type)

Attribute.GetCustomAttributes(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(MemberInfo)

Attribute.GetCustomAttributes(MemberInfo, bool)

Attribute.IsDefined(MemberInfo, Type)

Attribute.IsDefined(MemberInfo, Type, bool)

Attribute.GetCustomAttribute(MemberInfo, Type)

Attribute.GetCustomAttribute(MemberInfo, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo)

Attribute.GetCustomAttributes(ParameterInfo, Type)

Attribute.GetCustomAttributes(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(ParameterInfo, bool)

Attribute.IsDefined(ParameterInfo, Type)

Attribute.IsDefined(ParameterInfo, Type, bool)

Attribute.GetCustomAttribute(ParameterInfo, Type)

Attribute.GetCustomAttribute(ParameterInfo, Type, bool)

Attribute.GetCustomAttributes(Module, Type)

Attribute.GetCustomAttributes(Module)

Attribute.GetCustomAttributes(Module, bool)

Attribute.GetCustomAttributes(Module, Type, bool)

Attribute.IsDefined(Module, Type)

Attribute.IsDefined(Module, Type, bool)

Attribute.GetCustomAttribute(Module, Type)

Attribute.GetCustomAttribute(Module, Type, bool)

Attribute.GetCustomAttributes(Assembly, Type)

Attribute.GetCustomAttributes(Assembly, Type, bool)

Attribute.GetCustomAttributes(Assembly)

Attribute.GetCustomAttributes(Assembly, bool)

Attribute.IsDefined(Assembly, Type)

Attribute.IsDefined(Assembly, Type, bool)

Attribute.GetCustomAttribute(Assembly, Type)

Attribute.GetCustomAttribute(Assembly, Type, bool)

Attribute.Equals(object)

Attribute.GetHashCode()

Attribute.Match(object)

Attribute.IsDefaultAttribute()

Attribute.TypeId

object.ToString()

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Constructors

CollectionVectorAttribute()

Initializes a new instance of CollectionVectorAttribute with default settings.

public CollectionVectorAttribute()

CollectionVectorAttribute(SimilarityMetric, int, string)

Initializes a new instance with the specified metric and optionally other settings.

public CollectionVectorAttribute(SimilarityMetric metric, int dimension = -1, string sourceModel = null)

Parameters

metric SimilarityMetric

The similarity metric to use for vector comparisons.

dimension int

Optional. The number of dimensions for the vector.

sourceModel string

Optional. The source model for embeddings optimization.

CollectionVectorAttribute(int, string)

Initializes a new instance, optionally specifying various settings.

public CollectionVectorAttribute(int dimension = -1, string sourceModel = null)

Parameters

dimension int

Optional. The number of dimensions for the vector.

sourceModel string

Optional. The source model for embeddings optimization.

Properties

Dimension

The number of dimensions for the vector.

public int? Dimension { get; set; }

Property Value

int?

Metric

The similarity metric to use for vector comparisons.

public SimilarityMetric? Metric { get; set; }

Property Value

SimilarityMetric?

SourceModel

Configures the index with the fastest settings for a given source of embeddings vectors. Example values include 'openai-v3-large', 'cohere-v3', 'bert'. Defaults to 'other' if not set.

public string SourceModel { get; set; }

Property Value

string