EmbeddingModel
Overview
EmbeddingModel provides methods to generate embeddings for text and manage embedding stores. It supports in-memory and Servoy (pgvector) embedding stores.
Methods Summarized
Creates an in-memory embedding store for storing and retrieving embeddings.
Creates a builder for servoy embedding stores.
Generates an embedding for a single text string this can be used to use in the foundset.
Methods Detailed
createInMemoryStore()
Creates an in-memory embedding store for storing and retrieving embeddings.
Returns: EmbeddingStore An EmbeddingStore backed by an in-memory store.
createServoyEmbeddingStoreBuilder()
Creates a builder for servoy embedding stores.
Returns: ServoyEmbeddingStoreBuilder ServoyEmbeddingStoreBuilder instance.
embedding(text)
Generates an embedding for a single text string this can be used to use in the foundset.sort(vectorColumn, embeddingModel.embed("text"), maxRows);
Parameters
String text The text string to create embeddings for.
Returns: Array The embedding as a float array, or null if input is empty.
embedding(texts)
Generates embeddings for an array of text strings asynchronously.
Parameters
Array texts The array of text strings to embed.
Returns: Promise A Promise resolving to a float array of embeddings, or null if input is empty.
getDimension()
Gets the dimension of the embeddings produced by the model. This can be used when createing a vector column in a database, to use as the "size" of the vector.
Returns: Number The embeddings model dimension.
Last updated
Was this helpful?