VectorStoreVectorProperty Class

Definition

Namespace:: Microsoft.Extensions.VectorData

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

Package:: Microsoft.Extensions.VectorData.Abstractions v9.6.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 vector property on a vector store record.

public ref class VectorStoreVectorProperty : Microsoft::Extensions::VectorData::VectorStoreProperty

public class VectorStoreVectorProperty : Microsoft.Extensions.VectorData.VectorStoreProperty

type VectorStoreVectorProperty = class
    inherit VectorStoreProperty

Public Class VectorStoreVectorProperty
Inherits VectorStoreProperty

Inheritance: Object

VectorStoreProperty
VectorStoreVectorProperty

Derived: Microsoft.Extensions.VectorData.VectorStoreVectorProperty<TInput>

Remarks

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

Constructors

VectorStoreVectorProperty(String, Int32)	Initializes a new instance of the VectorStoreVectorProperty class.
VectorStoreVectorProperty(String, Type, Int32)	Initializes a new instance of the VectorStoreVectorProperty class.

Properties

Dimensions	Gets or sets the number of dimensions that the vector has.
DistanceFunction	Gets or sets the distance function to use when comparing vectors.
EmbeddingGenerator	Gets or sets the default embedding generator to use for this property.
EmbeddingType	Gets or sets the desired embedding type (for example, `Embedding<Half>`) for cases where the default (typically `Embedding<float>`) isn't suitable.
IndexKind	Gets or sets the kind of index to use.
Name	Gets or sets the name of the property on the data model. (Inherited from VectorStoreProperty)
StorageName	Gets or sets an optional name to use for the property in storage, if different from the property name. (Inherited from VectorStoreProperty)
Type	Gets or sets the type of the property. (Inherited from VectorStoreProperty)

Applies to