VertexAITextEmbeddingGenerationService Class

Definition

Namespace:: Microsoft.SemanticKernel.Connectors.Google

Assembly:: Microsoft.SemanticKernel.Connectors.Google.dll

Package:: Microsoft.SemanticKernel.Connectors.Google 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.

Represents a service for generating text embeddings using the Vertex AI Gemini API.

public sealed class VertexAITextEmbeddingGenerationService : Microsoft.SemanticKernel.Embeddings.IEmbeddingGenerationService<string,float>, Microsoft.SemanticKernel.Embeddings.ITextEmbeddingGenerationService

type VertexAITextEmbeddingGenerationService = class
    interface ITextEmbeddingGenerationService
    interface IEmbeddingGenerationService<string, single>
    interface IAIService

Public NotInheritable Class VertexAITextEmbeddingGenerationService
Implements IEmbeddingGenerationService(Of String, Single), ITextEmbeddingGenerationService

Inheritance: Object
VertexAITextEmbeddingGenerationService

Implements: IEmbeddingGenerationService<String,Single> ITextEmbeddingGenerationService IAIService

Constructors

Name	Description
VertexAITextEmbeddingGenerationService(String, Func<ValueTask<String>>, String, String, VertexAIVersion, HttpClient, ILoggerFactory)	Initializes a new instance of the VertexAITextEmbeddingGenerationService class.
VertexAITextEmbeddingGenerationService(String, String, String, String, VertexAIVersion, HttpClient, ILoggerFactory)	Initializes a new instance of the VertexAITextEmbeddingGenerationService 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