Interface ITextEmbeddingService

Namespace

FoundationaLLM.Common.Interfaces

Assembly

FoundationaLLM.Common.dll

Provides text embedding capabilities.

public interface ITextEmbeddingService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

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.

Task<TextEmbeddingResult> GetEmbeddingsAsync(IList<TextChunk> textChunks, string deploymentName, int embeddingDimensions, bool prioritized)

Parameters

textChunks IList<TextChunk>

The list of text chunks which need to be embedded.

deploymentName string

The name of the model deployment to use for embedding.

embeddingDimensions int

The number of dimensions for the embedding model.

prioritized bool

Indicates whether the request should be prioritized.

Returns

Task<TextEmbeddingResult>

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

GetEmbeddingsAsync(string)

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

Task<TextEmbeddingResult> GetEmbeddingsAsync(string operationId)

Parameters

operationId string

The unique identifier of the long-running operation.

Returns

Task<TextEmbeddingResult>

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