VectorStoreVectorAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.VectorData

Assembly:: Microsoft.Extensions.VectorData.Abstractions.dll

Package:: Microsoft.Extensions.VectorData.Abstractions v9.5.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines an attribute to mark a property on a record class as a vector.

public ref class VectorStoreVectorAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)]
public sealed class VectorStoreVectorAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Property, AllowMultiple=false)>]
type VectorStoreVectorAttribute = class
    inherit Attribute

Public NotInheritable Class VectorStoreVectorAttribute
Inherits Attribute

Inheritance: Object

Attribute
VectorStoreVectorAttribute

Attributes: AttributeUsageAttribute

Remarks

The characteristics defined here influence how the property is treated by the vector store.

Constructors

VectorStoreVectorAttribute(Int32)

Initializes a new instance of the VectorStoreVectorAttribute class.

Properties

Dimensions	Gets the number of dimensions that the vector has.
DistanceFunction	Gets the distance function to use when comparing vectors.
IndexKind	Gets the kind of index to use.
StorageName	Gets or sets an optional name to use for the property in storage, if different from the property name.

Applies to