Skip to content

BaseEmbeddingModel

llmfy.llmfy_core.embeddings.base_embedding_model

BaseEmbeddingModel

Bases: ABC

BaseEmbeddingModel Abstract

Source code in llmfy/llmfy_core/embeddings/base_embedding_model.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
class BaseEmbeddingModel(ABC):
    """BaseEmbeddingModel Abstract"""

    def __init__(self):
        """Model provider."""
        self.provider: ServiceProvider
        self.model: str

    @abstractmethod
    def encode(
        self,
        text: str,
    ) -> List[float]:
        pass

    @abstractmethod
    def encode_batch(
        self,
        texts: List[str] | str,
        batch_size: int = 10,
        max_retries: int = 3,
        retry_delay: float = 1.0,
        show_progress_bar: bool = False,
    ) -> Any:
        pass

provider instance-attribute

model instance-attribute

__init__()

Model provider.

Source code in llmfy/llmfy_core/embeddings/base_embedding_model.py 
10
11
12
13
def __init__(self):
    """Model provider."""
    self.provider: ServiceProvider
    self.model: str

encode(text) abstractmethod

Source code in llmfy/llmfy_core/embeddings/base_embedding_model.py 
15
16
17
18
19
20
@abstractmethod
def encode(
    self,
    text: str,
) -> List[float]:
    pass

encode_batch(texts, batch_size=10, max_retries=3, retry_delay=1.0, show_progress_bar=False) abstractmethod

Source code in llmfy/llmfy_core/embeddings/base_embedding_model.py 
22
23
24
25
26
27
28
29
30
31
@abstractmethod
def encode_batch(
    self,
    texts: List[str] | str,
    batch_size: int = 10,
    max_retries: int = 3,
    retry_delay: float = 1.0,
    show_progress_bar: bool = False,
) -> Any:
    pass