VectorStoreVectorProperty<TInput> Class

Definition

Namespace:: Microsoft.Extensions.VectorData

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

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

generic <typename TInput>
public ref class VectorStoreVectorProperty : Microsoft::Extensions::VectorData::VectorStoreVectorProperty

public class VectorStoreVectorProperty<TInput> : Microsoft.Extensions.VectorData.VectorStoreVectorProperty

type VectorStoreVectorProperty<'Input> = class
    inherit VectorStoreVectorProperty

Public Class VectorStoreVectorProperty(Of TInput)
Inherits VectorStoreVectorProperty

Type Parameters

TInput

Inheritance: Object

VectorStoreProperty

VectorStoreVectorProperty
VectorStoreVectorProperty<TInput>

Remarks

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

This generic version of VectorStoreVectorProperty only needs to be used when an IEmbeddingGenerator is configured on the property, and a custom .NET type is used as input (any type other than String or DataContent).

Constructors

VectorStoreVectorProperty<TInput>(String, Int32)

Initializes a new instance of the VectorStoreVectorProperty class.

Properties

Dimensions	Gets or sets the number of dimensions that the vector has. (Inherited from VectorStoreVectorProperty)
DistanceFunction	Gets or sets the distance function to use when comparing vectors. (Inherited from VectorStoreVectorProperty)
EmbeddingGenerator	Gets or sets the default embedding generator to use for this property. (Inherited from VectorStoreVectorProperty)
EmbeddingType	Gets or sets the desired embedding type (for example, `Embedding<Half>`) for cases where the default (typically `Embedding<float>`) isn't suitable. (Inherited from VectorStoreVectorProperty)
IndexKind	Gets or sets the kind of index to use. (Inherited from VectorStoreVectorProperty)
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