Class SemanticKernelTextEmbeddingService

Namespace

FoundationaLLM.SemanticKernel.Core.Services

Assembly

FoundationaLLM.SemanticKernel.Core.dll

Generates text embeddings using the Semantic Kernel orchestrator.

public class SemanticKernelTextEmbeddingService : ITextEmbeddingService

Inheritance

object

SemanticKernelTextEmbeddingService

Implements

ITextEmbeddingService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

SemanticKernelTextEmbeddingService(IOptions<SemanticKernelTextEmbeddingServiceSettings>, ILoggerFactory)

Creates a new SemanticKernelTextEmbeddingService instance.

public SemanticKernelTextEmbeddingService(IOptions<SemanticKernelTextEmbeddingServiceSettings> options, ILoggerFactory loggerFactory)

Parameters

options IOptions<SemanticKernelTextEmbeddingServiceSettings>

The IOptions<TOptions> providing configuration settings.

loggerFactory ILoggerFactory

The ILoggerFactory used to create loggers for logging.

Methods

GetEmbeddingsAsync(IList<TextChunk>, string, int, bool)

Initializes the text embedding operation. Depending on the implementation, this can be an atomic operation or a long-running one.

public Task<TextOperationResult> GetEmbeddingsAsync(IList<TextChunk> textChunks, string modelName = "text-embedding-ada-002", int embeddingDimensions = 1536, bool Prioritized = false)

Parameters

textChunks IList<TextChunk>

The list of text chunks which need to be embedded.

modelName string

embeddingDimensions int

The number of dimensions for the embedding model.

Prioritized bool

Returns

Task<TextOperationResult>

A TextOperationResult object containing the result of the text embedding operation.

GetEmbeddingsAsync(string)

Retrieves the result of a long-running text embedding operation.

public Task<TextOperationResult> GetEmbeddingsAsync(string operationId)

Parameters

operationId string

The unique identifier of the long-running operation.

Returns

Task<TextOperationResult>

A TextOperationResult object containing the result of the text embedding operation.