Class CollectionVectorizeAttribute

Namespace

DataStax.AstraDB.DataApi.Core

Assembly

DataStax.AstraDB.DataApi.dll

Specifies vectorize options for a collection.

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

Inheritance

object

Attribute

BaseVectorizeAttribute

CollectionVectorizeAttribute

Implements

_Attribute

Inherited Members

BaseVectorizeAttribute.Dimension

BaseVectorizeAttribute.Provider

BaseVectorizeAttribute.ModelName

BaseVectorizeAttribute.AuthenticationPairs

BaseVectorizeAttribute.ParameterPairs

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

CollectionVectorizeAttribute()

Initializes a new instance of CollectionVectorizeAttribute with default settings.

public CollectionVectorizeAttribute()

CollectionVectorizeAttribute(string, string, SimilarityMetric, int, string[], object[])

Initializes a new instance with the specified provider and model name and optionally other settings.

public CollectionVectorizeAttribute(string provider, string modelName, SimilarityMetric metric, int dimension = -1, string[] authenticationPairs = null, object[] parameterPairs = null)

Parameters

provider string

The name of the embedding service provider.

modelName string

The model name to use for embedding generation.

metric SimilarityMetric

The similarity metric to use for vector comparisons.

dimension int

Optional: The number of dimensions for the generated vector.

authenticationPairs string[]

Optional: Key-value pairs for authenticating with the embedding service.

parameterPairs object[]

Optional: Additional key-value parameter pairs for the embedding service.

CollectionVectorizeAttribute(string, string, int, string[], object[])

Initializes a new instance with the specified provider and model name and optionally other settings.

public CollectionVectorizeAttribute(string provider, string modelName, int dimension = -1, string[] authenticationPairs = null, object[] parameterPairs = null)

Parameters

provider string

The name of the embedding service provider.

modelName string

The model name to use for embedding generation.

dimension int

Optional: The number of dimensions for the generated vector.

authenticationPairs string[]

Optional: Key-value pairs for authenticating with the embedding service.

parameterPairs object[]

Optional: Additional key-value parameter pairs for the embedding service.

Properties

Metric

The similarity metric to use for vector comparisons.

public SimilarityMetric? Metric { get; set; }

Property Value

SimilarityMetric?