VectorStoreKeyAttribute Class

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 the key under which the record is stored in a vector store.

public ref class VectorStoreKeyAttribute sealed : Attribute

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

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

Public NotInheritable Class VectorStoreKeyAttribute
Inherits Attribute

Inheritance: Object

Attribute
VectorStoreKeyAttribute

Attributes: AttributeUsageAttribute

Remarks

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

Constructors

VectorStoreKeyAttribute()

Properties

StorageName

Gets or sets an optional name to use for the property in storage, if different from the property name.

Applies to