Embedding Class

Definition

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

C#
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Half>), "halves")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Single>), "floats")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Double>), "doubles")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Byte>), "bytes")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.SByte>), "sbytes")]
[System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")]
public class Embedding
C#
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Single>), "floats")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Double>), "doubles")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.Byte>), "bytes")]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Extensions.AI.Embedding<System.SByte>), "sbytes")]
[System.Text.Json.Serialization.JsonPolymorphic(TypeDiscriminatorPropertyName="$type")]
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

Embedding()

Initializes a new instance of the Embedding class.

Properties

AdditionalProperties

Gets or sets any additional properties associated with the embedding.

CreatedAt

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

ModelId

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

Applies to

Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)