IEmbeddingGenerationService<TValue,TEmbedding> Interface
Definition
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 generator of embeddings.
public interface IEmbeddingGenerationService<TValue,TEmbedding> : Microsoft.SemanticKernel.Services.IAIService where TEmbedding : structtype IEmbeddingGenerationService<'Value, 'Embedding (requires 'Embedding : struct)> = interface
interface IAIServicePublic Interface IEmbeddingGenerationService(Of TValue, TEmbedding)
Implements IAIServiceType Parameters
- TValue
The type from which embeddings will be generated.
- TEmbedding
The numeric type of the embedding data.
- Derived
- Implements
Properties
| Name | Description |
|---|---|
| Attributes |
Gets the AI service attributes. (Inherited from IAIService) |
Methods
| Name | Description |
|---|---|
| GenerateEmbeddingsAsync(IList<TValue>, Kernel, CancellationToken) |
Generates an embedding from the given |
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 |
| GetApiVersion(IAIService) |
Gets the API version from |
| GetDimensions<TValue,TEmbedding>(IEmbeddingGenerationService<TValue,TEmbedding>) |
Gets the dimensions from |
| GetEndpoint(IAIService) |
Gets the endpoint from |
| GetModelId(IAIService) |
Gets the model identifier from |