OllamaTextEmbeddingGenerationService Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Ollama

Assembly:: Microsoft.SemanticKernel.Connectors.Ollama.dll

Package:: Microsoft.SemanticKernel.Connectors.Ollama v1.45.0-alpha

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.

Caution

Dedicated OllamaTextEmbeddingGenerationService is deprecated. Use OllamaApiClient.AsEmbeddingGenerationService() instead.

Represents a embedding generation service using Ollama Original API.

[System.Obsolete("Dedicated OllamaTextEmbeddingGenerationService is deprecated. Use OllamaApiClient.AsEmbeddingGenerationService() instead.")]
public sealed class OllamaTextEmbeddingGenerationService : Microsoft.SemanticKernel.Connectors.Ollama.Core.ServiceBase, Microsoft.SemanticKernel.Embeddings.IEmbeddingGenerationService<string,float>, Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService

[<System.Obsolete("Dedicated OllamaTextEmbeddingGenerationService is deprecated. Use OllamaApiClient.AsEmbeddingGenerationService() instead.")>]
type OllamaTextEmbeddingGenerationService = class
    inherit ServiceBase
    interface ITextEmbeddingGenerationService
    interface IEmbeddingGenerationService<string, single>
    interface IAIService

Public NotInheritable Class OllamaTextEmbeddingGenerationService
Inherits ServiceBase
Implements IEmbeddingGenerationService(Of String, Single), ITextEmbeddingGenerationService

Inheritance: Object

ServiceBase
OllamaTextEmbeddingGenerationService

Attributes: ObsoleteAttribute

Implements: IEmbeddingGenerationService<String,Single> ITextEmbeddingGenerationService IAIService

Constructors

Name	Description
OllamaTextEmbeddingGenerationService(OllamaApiClient, ILoggerFactory)	Initializes a new instance of the OllamaTextEmbeddingGenerationService class.
OllamaTextEmbeddingGenerationService(String, HttpClient, ILoggerFactory)	Initializes a new instance of the OllamaTextEmbeddingGenerationService class.
OllamaTextEmbeddingGenerationService(String, Uri, ILoggerFactory)	Initializes a new instance of the OllamaTextEmbeddingGenerationService class.

Properties

Name	Description
Attributes	Gets the AI service attributes.

Methods

Name	Description
GenerateEmbeddingsAsync(IList<String>, Kernel, CancellationToken)	Generates an embedding from the given `data`.

Extension Methods

Name	Description
AsEmbeddingGenerator<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>)	Creates an IEmbeddingGenerator<TInput,TEmbedding> for the specified IEmbeddingGenerationService<TValue,TEmbedding>.
GenerateEmbeddingAsync<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>, TValue, Kernel, CancellationToken)	Generates an embedding from the given `value`.
GetApiVersion(IAIService)	Gets the API version from `service`'s Attributes
GetDimensions<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>)	Gets the dimensions from `service`'s IEmbeddingGenerationService<TValue,TEmbedding>.
GetEndpoint(IAIService)	Gets the endpoint from `service`'s Attributes.
GetModelId(IAIService)	Gets the model identifier from `service`'s Attributes.

Applies to