CollectionModel Class

Definition

Namespace:

Microsoft.Extensions.VectorData.ProviderServices

Assembly:

Microsoft.Extensions.VectorData.Abstractions.dll

Package:

Microsoft.Extensions.VectorData.Abstractions v10.9.0

Source:

CollectionModel.cs

Represents a record in a vector store collection. This is an internal support type meant for use by providers only and not by applications.

public ref class CollectionModel sealed

[System.Diagnostics.CodeAnalysis.Experimental("MEVD9001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public sealed class CollectionModel

[<System.Diagnostics.CodeAnalysis.Experimental("MEVD9001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")>]
type CollectionModel = class

Public NotInheritable Class CollectionModel

Inheritance

Object

CollectionModel

Attributes

ExperimentalAttribute

Properties

Name	Description
DataProperties	Gets the data properties of the record.
EmbeddingGenerationRequired	Gets a value indicating whether any of the vector properties in the model require embedding generation.
KeyProperties	Gets the key properties of the record.
KeyProperty	Gets the single key property in the model, and throws if there are multiple key properties.
Properties	Gets all properties of the record, of all types.
PropertyMap	Gets all properties of the record, of all types, indexed by their model name.
VectorProperties	Gets the vector properties of the record.
VectorProperty	Gets the single vector property in the model, and throws if there are multiple vector properties.

Methods

Name	Description
CreateRecord<TRecord>()	Instantiates a new record of the specified type.
GetDataOrKeyProperty<TRecord>(Expression<Func<TRecord,Object>>)	Gets the data or key property selected by the provided expression.
GetFullTextDataPropertyOrSingle<TRecord>(Expression<Func<TRecord,Object>>)	Gets the text data property with the provided name that has full text search indexing enabled, or falls back to a text data property in the schema if no name is provided.
GetVectorPropertyOrSingle<TRecord>(VectorSearchOptions<TRecord>)	Gets the vector property with the provided name if a name is provided, and falls back to a vector property in the schema if not.