Package com.composum.ai.backend.base.service.chat

Interface GPTEmbeddingService

All Known Implementing Classes:

GPTEmbeddingServiceImpl

public interface GPTEmbeddingService

Methods related to embeddings. Based on the low level service GPTChatCompletionService.getEmbeddings(List, GPTConfiguration) but with a more convenient API.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	GPTEmbeddingService.EmbeddingsCache	Optional cache for embedding values.

Method Summary

Modifier and Type	Method	Description
List<String>	findMostRelated(String query, List<String> comparedStrings, int limit, GPTConfiguration configuration, GPTEmbeddingService.EmbeddingsCache cache)	Determines the at most limit to query semantically closest of the comparedStrings according to the embedding service.
List<float[]>	getEmbeddings(List<String> texts, GPTConfiguration configuration, GPTEmbeddingService.EmbeddingsCache cache)	Get embeddings for the given texts.

Method Detail

getEmbeddings

List<float[]> getEmbeddings(List<String> texts,
                            @Nullable
                            GPTConfiguration configuration,
                            @Nullable
                            GPTEmbeddingService.EmbeddingsCache cache)
                     throws GPTException

Get embeddings for the given texts.

Parameters:

texts - the texts to get embeddings for

configuration - the configuration to use

Returns:

the embeddings for the given texts

Throws:

GPTException - if an error occurs

findMostRelated

List<String> findMostRelated(String query,
                             List<String> comparedStrings,
                             int limit,
                             @Nullable
                             GPTConfiguration configuration,
                             @Nullable
                             GPTEmbeddingService.EmbeddingsCache cache)
                      throws GPTException

Determines the at most limit to query semantically closest of the comparedStrings according to the embedding service.

Throws:

GPTException