Torus.Embedding behaviour (Torus v0.5.2)

View Source

Behaviour for generating embeddings for a list of terms.

Summary

Callbacks

Returns a string representing the embedding model name Torus currently uses to generate embeddings.

Generates embeddings for a given list of terms.

Callbacks

embedding_model(opts)

@callback embedding_model(opts :: keyword()) :: String.t()

Returns a string representing the embedding model name Torus currently uses to generate embeddings.

For example: "sentence-transformers/paraphrase-MiniLM-L6-v2".

generate(terms, opts)

@callback generate(terms :: [binary()], opts :: keyword()) :: [%Pgvector{data: term()}]

Generates embeddings for a given list of terms.

Should raise or retry on errors.