VectorStoreRecordKeyProperty 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.

Defines a key property on a vector store record.

public sealed class VectorStoreRecordKeyProperty : Microsoft.SemanticKernel.Data.VectorStoreRecordProperty

type VectorStoreRecordKeyProperty = class
    inherit VectorStoreRecordProperty

Public NotInheritable Class VectorStoreRecordKeyProperty
Inherits VectorStoreRecordProperty

Inheritance: Object

VectorStoreRecordProperty
VectorStoreRecordKeyProperty

Remarks

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

Constructors

VectorStoreRecordKeyProperty(String, Type)	Initializes a new instance of the VectorStoreRecordKeyProperty class.
VectorStoreRecordKeyProperty(VectorStoreRecordKeyProperty)	Initializes a new instance of the VectorStoreRecordKeyProperty class by cloning the given source.

Properties

DataModelPropertyName	Gets or sets the name of the property on the data model. (Inherited from VectorStoreRecordProperty)
PropertyType	Gets or sets the type of the property. (Inherited from VectorStoreRecordProperty)
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". This property will only be respected by implementations that do not support a well known serialization mechanism like JSON, in which case the attributes used by that seriallization system will be used. (Inherited from VectorStoreRecordProperty)

Applies to

Share via