diff --git a/python/python/lancedb/embeddings/base.py b/python/python/lancedb/embeddings/base.py index dc78e27a..f711e5b7 100644 --- a/python/python/lancedb/embeddings/base.py +++ b/python/python/lancedb/embeddings/base.py @@ -17,12 +17,13 @@ class EmbeddingFunction(BaseModel, ABC): """ An ABC for embedding functions. - All concrete embedding functions must implement the following: + All concrete embedding functions must implement the following methods: 1. compute_query_embeddings() which takes a query and returns a list of embeddings - 2. get_source_embeddings() which returns a list of embeddings for the source column + 2. compute_source_embeddings() which returns a list of embeddings for + the source column For text data, the two will be the same. For multi-modal data, the source column might be images and the vector column might be text. - 3. ndims method which returns the number of dimensions of the vector column + 3. ndims() which returns the number of dimensions of the vector column """ __slots__ = ("__weakref__",) # pydantic 1.x compatibility