eta.embedding.Embedder

class Embedder

Bases: object

Defines an abstract embedder class.

An embedder minimally contains a method for embedding a text or list of texts, and a method for scoring a set of documents (possibly with precomputed embeddings) relative to a text.

Methods

embed	Embed a text or list of texts.
score	Score a set of documents relative to a text.

embed(texts)

Embed a text or list of texts.

Parameters:

texts (str or list[str]) – Either a single text string or a list of text strings to embed.

Returns:

The embedding or embeddings computed from the input.

Return type:

list[float] or list[list[float]]

score(text, documents, embeddings=[])

Score a set of documents relative to a text.

Parameters:

• text (str) – A query text to use in computing scores for each document.

• documents (list[str]) – A list of documents to score.

• embeddings (list[list[float]], optional) – If embeddings for the documents have already been precomputed, passing the embeddings as an argument will bypass creating new embeddings for the documents.

Returns:

Scores for each document.

Return type:

list[float]