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

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

Attributes: AttributeUsageAttribute

Remarks

The characteristics defined here will 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. E.g. the property name might be "MyProperty" but the storage name might be "my_property".

Applies to

Share via