Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

VectorStoreKeyAttribute Class

Definition

Namespace:
Microsoft.Extensions.VectorData
Assembly:
Microsoft.Extensions.VectorData.Abstractions.dll
Package:
Microsoft.Extensions.VectorData.Abstractions v10.7.0
Source:
VectorStoreKeyAttribute.cs

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
VectorStoreKeyAttribute
Attributes

Remarks

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

Constructors

Name Description
VectorStoreKeyAttribute()

Properties

Name Description
IsAutoGenerated

Gets or sets a value indicating whether this key property's value is auto-generated or not.
StorageName

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

Applies to

Feedback

Was this page helpful?