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

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

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

Public NotInheritable Class VectorStoreRecordDataAttribute
Inherits Attribute

Inheritance: Attribute
VectorStoreRecordDataAttribute

Attributes: AttributeUsageAttribute

Remarks

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

Constructors

VectorStoreRecordDataAttribute()

Properties

IsFilterable	Gets or sets a value indicating whether this data property is filterable.
IsFullTextSearchable	Gets or sets a value indicating whether this data property is full text searchable.
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