VectorStoreDataAttribute 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 'data'.

public ref class VectorStoreDataAttribute sealed : Attribute

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

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

Public NotInheritable Class VectorStoreDataAttribute
Inherits Attribute

Inheritance: Object

Attribute
VectorStoreDataAttribute

Attributes: AttributeUsageAttribute

Remarks

Marking a property as 'data' means that the property is not a key and not a vector. But optionally, this property can have an associated vector field containing an embedding for this data. The characteristics defined here influence how the property is treated by the vector store.

Constructors

VectorStoreDataAttribute()

Properties

IsFullTextIndexed	Gets or sets a value indicating whether this data property is indexed for full-text search.
IsIndexed	Gets or sets a value indicating whether this data property is indexed.
StorageName	Gets or sets an optional name to use for the property in storage, if different from the property name.

Applies to