VectorStoreRecordKeyAttribute Class

Reference

Definition

Namespace:: Microsoft.Extensions.VectorData

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

Package:: Microsoft.Extensions.VectorData.Abstractions v9.0.0-preview.1.25078.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.

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 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".
TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute)

Methods

Equals(Object)	Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute)
GetHashCode()	Returns the hash code for this instance. (Inherited from Attribute)
GetType()	Gets the Type of the current instance. (Inherited from Object)
IsDefaultAttribute()	When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute)
Match(Object)	When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Dela via