Interface IImageEmbedder
- Namespace
- LMKit.Abstractions
- Assembly
- LM-Kit.NET.dll
Optional capability for providers that embed images into the same vector space as text (multimodal embedding).
public interface IImageEmbedderRemarks
A provider implements IImageEmbedder in addition to IEmbedder
when its model can turn images into embedding vectors. Consumers that need image embeddings
feature-detect this interface and, when the embedder does not implement it (or reports
SupportsImageEmbeddings as false), surface the same "model does not
support image embeddings" condition they would for an unsuitable local model.
Properties
- SupportsImageEmbeddings
Gets a value indicating whether the underlying model can currently produce image embeddings.
Methods
- GetEmbeddingsAsync(ImageBuffer, CancellationToken)
Asynchronously generates the embedding vector for a single image.
- GetEmbeddingsAsync(IEnumerable<ImageBuffer>, CancellationToken)
Asynchronously generates embedding vectors for a batch of images.