VectorStoreRecordVectorAttribute Class

Reference

Definition

Namespace:: Microsoft.SemanticKernel.Data

Assembly:: Microsoft.SemanticKernel.Abstractions.dll

Package:: Microsoft.SemanticKernel.Abstractions v1.20.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.

Attribute to mark a property on a record class as a vector.

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

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

Public NotInheritable Class VectorStoreRecordVectorAttribute
Inherits Attribute

Inheritance: Attribute
VectorStoreRecordVectorAttribute

Attributes: AttributeUsageAttribute

Remarks

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

Constructors

VectorStoreRecordVectorAttribute()	Initializes a new instance of the VectorStoreRecordVectorAttribute class.
VectorStoreRecordVectorAttribute(Int32, String, String)	Initializes a new instance of the VectorStoreRecordVectorAttribute class.
VectorStoreRecordVectorAttribute(Int32)	Initializes a new instance of the VectorStoreRecordVectorAttribute class.

Properties

Dimensions	Gets or sets 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.
StoragePropertyName	Gets or sets an optional name to use for the property in storage, if different from the property name. E.g. the property name might be "MyProperty" but the storage name might be "my_property".

Applies to

Share via