VectorStoreRecordKeyAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.VectorData

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

Package:: Microsoft.Extensions.VectorData.Abstractions v9.0.0-preview.1.25161.1

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 VectorStoreRecordKeyAttribute sealed : Attribute

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

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

Public NotInheritable Class VectorStoreRecordKeyAttribute
Inherits Attribute

Inheritance: Object

Attribute
VectorStoreRecordKeyAttribute

Attributes: AttributeUsageAttribute

Remarks

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

Constructors

VectorStoreRecordKeyAttribute()

Properties

StoragePropertyName

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

Applies to