GeneratedEmbeddings Class

Definition

Namespace:: Microsoft.Extensions.AI

Assembly:: Microsoft.Extensions.AI.Abstractions.dll

Package:: Microsoft.Extensions.AI.Abstractions v10.9.0

Source:: GeneratedEmbeddings.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 the result of an operation to generate embeddings.

generic 
 where TEmbedding : Embeddingpublic ref class GeneratedEmbeddings sealed : System::Collections::Generic::ICollection, System::Collections::Generic::IEnumerable, System::Collections::Generic::IList, System::Collections::Generic::IReadOnlyCollection, System::Collections::Generic::IReadOnlyList

public sealed class GeneratedEmbeddings : System.Collections.Generic.ICollection, System.Collections.Generic.IEnumerable, System.Collections.Generic.IList, System.Collections.Generic.IReadOnlyCollection, System.Collections.Generic.IReadOnlyList where TEmbedding : Embedding

type GeneratedEmbeddings<'Embedding (requires 'Embedding :> Embedding)> = class
    interface IList<'Embedding (requires 'Embedding :> Embedding)>
    interface ICollection<'Embedding (requires 'Embedding :> Embedding)>
    interface seq<'Embedding (requires 'Embedding :> Embedding)>
    interface IEnumerable
    interface IReadOnlyList<'Embedding (requires 'Embedding :> Embedding)>
    interface IReadOnlyCollection<'Embedding (requires 'Embedding :> Embedding)>

Public NotInheritable Class GeneratedEmbeddings(Of TEmbedding)
Implements ICollection(Of TEmbedding), IEnumerable(Of TEmbedding), IList(Of TEmbedding), IReadOnlyCollection(Of TEmbedding), IReadOnlyList(Of TEmbedding)

Type Parameters

TEmbedding

Specifies the type of the generated embeddings.

Inheritance: Object
GeneratedEmbeddings

Implements: ICollection ICollection IEnumerable IEnumerable IList IReadOnlyCollection IReadOnlyCollection IReadOnlyList IEnumerable

Constructors

Name	Description
GeneratedEmbeddings()	Initializes a new instance of the GeneratedEmbeddings class.
GeneratedEmbeddings(IEnumerable)	Initializes a new instance of the GeneratedEmbeddings class that contains all of the embeddings from the specified collection.
GeneratedEmbeddings(Int32)	Initializes a new instance of the GeneratedEmbeddings class with the specified capacity.

Properties

Name	Description
AdditionalProperties	Gets or sets any additional properties associated with the embeddings.
Count	Gets the number of elements contained in the ICollection.
Item[Int32]	Gets or sets the element at the specified index.
Usage	Gets or sets usage details for the embeddings' generation.

Methods

Name	Description
Add(TEmbedding)	Adds an item to the ICollection.
AddRange(IEnumerable)	Adds the embeddings from the specified collection to the end of this list.
Clear()	Removes all items from the ICollection.
Contains(TEmbedding)	Determines whether the ICollection contains a specific value.
CopyTo(TEmbedding[], Int32)	Copies the elements of the ICollection to an Array, starting at a particular Array index.
GetEnumerator()	Returns an enumerator that iterates through the collection.
IndexOf(TEmbedding)	Determines the index of a specific item in the IList.
Insert(Int32, TEmbedding)	Inserts an item to the IList at the specified index.
Remove(TEmbedding)	Removes the first occurrence of a specific object from the ICollection.
RemoveAt(Int32)	Removes the IList item at the specified index.

Explicit Interface Implementations

Name	Description
ICollection.IsReadOnly	Gets a value indicating whether the ICollection is read-only.
IEnumerable.GetEnumerator()	Returns an enumerator that iterates through a collection.

Extension Methods

Name	Description
ToAsyncEnumerable(IEnumerable)	Converts an IEnumerable to an IAsyncEnumerable.
ToFrozenDictionary(IEnumerable, Func, Func, IEqualityComparer)	Creates a FrozenDictionary from an IEnumerable according to specified key selector and element selector functions.
ToFrozenDictionary(IEnumerable, Func, IEqualityComparer)	Creates a FrozenDictionary from an IEnumerable according to specified key selector function.
ToFrozenSet(IEnumerable, IEqualityComparer)	Creates a FrozenSet with the specified values.
ToImmutableArray(IEnumerable)	Creates an immutable array from the specified collection.
ToImmutableDictionary(IEnumerable, Func, Func, IEqualityComparer, IEqualityComparer)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key and value comparers.
ToImmutableDictionary(IEnumerable, Func, Func, IEqualityComparer)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents by using the specified key comparer.
ToImmutableDictionary(IEnumerable, Func, Func)	Enumerates and transforms a sequence, and produces an immutable dictionary of its contents.
ToImmutableDictionary(IEnumerable, Func, IEqualityComparer)	Constructs an immutable dictionary based on some transformation of a sequence.
ToImmutableDictionary(IEnumerable, Func)	Constructs an immutable dictionary from an existing collection of elements, applying a transformation function to the source keys.
ToImmutableHashSet(IEnumerable, IEqualityComparer)	Enumerates a sequence, produces an immutable hash set of its contents, and uses the specified equality comparer for the set type.
ToImmutableHashSet(IEnumerable)	Enumerates a sequence and produces an immutable hash set of its contents.
ToImmutableList(IEnumerable)	Enumerates a sequence and produces an immutable list of its contents.
ToImmutableSortedDictionary(IEnumerable, Func, Func, IComparer, IEqualityComparer)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key and value comparers.
ToImmutableSortedDictionary(IEnumerable, Func, Func, IComparer)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents by using the specified key comparer.
ToImmutableSortedDictionary(IEnumerable, Func, Func)	Enumerates and transforms a sequence, and produces an immutable sorted dictionary of its contents.
ToImmutableSortedSet(IEnumerable, IComparer)	Enumerates a sequence, produces an immutable sorted set of its contents, and uses the specified comparer.
ToImmutableSortedSet(IEnumerable)	Enumerates a sequence and produces an immutable sorted set of its contents.

Applies to

Feedback

Was this page helpful?