Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Embedding Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.7.0
Source:
Embedding.cs

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.

Represents an embedding generated by a IEmbeddingGenerator<TInput,TEmbedding>.

public ref class Embedding
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.BinaryEmbedding), "binary")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Byte>), "uint8")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.SByte>), "int8")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Half>), "float16")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Single>), "float32")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Double>), "float64")]
[System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")]
public class Embedding
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.BinaryEmbedding), "binary")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Byte>), "uint8")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.SByte>), "int8")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Single>), "float32")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Double>), "float64")]
[System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")]
public class Embedding
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.BinaryEmbedding), "binary")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Byte>), "uint8")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.SByte>), "int8")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Half>), "float16")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Single>), "float32")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Double>), "float64")>]
[<System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")>]
type Embedding = class
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.BinaryEmbedding), "binary")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Byte>), "uint8")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.SByte>), "int8")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Single>), "float32")>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Double>), "float64")>]
[<System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")>]
type Embedding = class
Public Class Embedding
Inheritance
Embedding
Derived
Attributes

Remarks

This base class provides metadata about the embedding. Derived types provide the concrete data contained in the embedding.

Constructors

Name Description
Embedding()

Initializes a new instance of the Embedding class.

Properties

Name Description
AdditionalProperties

Gets or sets any additional properties associated with the embedding.
CreatedAt

Gets or sets a timestamp at which the embedding was created.
Dimensions

Gets the dimensionality of the embedding vector.
ModelId

Gets or sets the model ID using in the creation of the embedding.

Applies to

Feedback

Was this page helpful?