KeyPropertyModel Class

Definition

Namespace:

Microsoft.Extensions.VectorData.ProviderServices

Assembly:

Microsoft.Extensions.VectorData.Abstractions.dll

Package:

Microsoft.Extensions.VectorData.Abstractions v10.9.0

Source:

KeyPropertyModel.cs

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

public ref class KeyPropertyModel : Microsoft::Extensions::VectorData::ProviderServices::PropertyModel

[System.Diagnostics.CodeAnalysis.Experimental("MEVD9001", UrlFormat="https://aka.ms/dotnet-extensions-warnings/{0}")]
public class KeyPropertyModel : Microsoft.Extensions.VectorData.ProviderServices.PropertyModel

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

Public Class KeyPropertyModel
Inherits PropertyModel

Inheritance

Object

PropertyModel

KeyPropertyModel

Attributes

ExperimentalAttribute

Constructors

Name	Description
KeyPropertyModel(String, Type)	Represents a key property on a vector store record. This is an internal support type meant for use by providers only and not by applications.

Properties

Name	Description
IsAutoGenerated	Gets or sets a value indicating whether this key property's value is auto-generated or not.
IsNullable	Gets a value indicating whether the property type is nullable. (Inherited from PropertyModel)
ModelName	Gets or sets the model name of the property. (Inherited from PropertyModel)
PropertyInfo	Gets or sets the reflection PropertyInfo for the .NET property. (Inherited from PropertyModel)
ProviderAnnotations	Gets or sets a dictionary of provider-specific annotations for this property. (Inherited from PropertyModel)
SerializedKeyName	Gets or sets the name that the JSON serializer will produce for this key property.
StorageName	Gets or sets the storage name of the property. (Inherited from PropertyModel)
Type	Gets or sets the CLR type of the property. (Inherited from PropertyModel)

Methods

Name	Description
GetValue<T>(Object)	Reads the property from the given record. (Inherited from PropertyModel)
GetValueAsObject(Object)	Reads the property from the given record, returning the value as an Object. (Inherited from PropertyModel)
SetValue<T>(Object, T)	Writes the property from the given record. (Inherited from PropertyModel)
SetValueAsObject(Object, Object)	Writes the property from the given record, accepting the value to write as an Object. (Inherited from PropertyModel)
ToString()	Returns a string that represents the current object.