Embedding_builders

This module contains functionality related to the the embedding_builders module for common.builders.

Embedding_builders

HuggingFaceEmbeddingModelBuilder

Builder for creating HuggingFace embedding model instances.

Provides factory method to create configured HuggingFaceEmbedding objects.

Source code in src/common/builders/embedding_builders.py
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
class HuggingFaceEmbeddingModelBuilder:
    """Builder for creating HuggingFace embedding model instances.

    Provides factory method to create configured HuggingFaceEmbedding objects.
    """

    @staticmethod
    @inject
    def build(
        configuration: "HuggingFaceConfiguration",
    ) -> HuggingFaceEmbedding:
        """Creates a configured HuggingFace embedding model.

        Args:
            configuration: Model settings including name and batch size.

        Returns:
            HuggingFaceEmbedding: Configured embedding model instance.
        """
        return HuggingFaceEmbedding(
            model_name=configuration.name,
            embed_batch_size=configuration.batch_size,
        )

build(configuration) staticmethod

Creates a configured HuggingFace embedding model.

Parameters:
  • configuration (HuggingFaceConfiguration) –

    Model settings including name and batch size.

Returns:
  • HuggingFaceEmbedding( HuggingFaceEmbedding ) –

    Configured embedding model instance.

Source code in src/common/builders/embedding_builders.py
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
@staticmethod
@inject
def build(
    configuration: "HuggingFaceConfiguration",
) -> HuggingFaceEmbedding:
    """Creates a configured HuggingFace embedding model.

    Args:
        configuration: Model settings including name and batch size.

    Returns:
        HuggingFaceEmbedding: Configured embedding model instance.
    """
    return HuggingFaceEmbedding(
        model_name=configuration.name,
        embed_batch_size=configuration.batch_size,
    )

OpenAIEmbeddingModelBuilder

Builder for creating OpenAI embedding model instances.

Provides factory method to create configured OpenAIEmbedding objects.

Source code in src/common/builders/embedding_builders.py
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
class OpenAIEmbeddingModelBuilder:
    """Builder for creating OpenAI embedding model instances.

    Provides factory method to create configured OpenAIEmbedding objects.
    """

    @staticmethod
    @inject
    def build(
        configuration: "OpenAIEmbeddingModelConfiguration",
    ) -> OpenAIEmbedding:
        """Creates a configured OpenAI embedding model.

        Args:
            configuration: Model settings including API key, name and batch size.

        Returns:
            OpenAIEmbedding: Configured embedding model instance.
        """
        return OpenAIEmbedding(
            api_key=configuration.secrets.api_key.get_secret_value(),
            model_name=configuration.name,
            embed_batch_size=configuration.batch_size,
        )

build(configuration) staticmethod

Creates a configured OpenAI embedding model.

Parameters:
  • configuration (OpenAIEmbeddingModelConfiguration) –

    Model settings including API key, name and batch size.

Returns:
  • OpenAIEmbedding( OpenAIEmbedding ) –

    Configured embedding model instance.

Source code in src/common/builders/embedding_builders.py
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
@staticmethod
@inject
def build(
    configuration: "OpenAIEmbeddingModelConfiguration",
) -> OpenAIEmbedding:
    """Creates a configured OpenAI embedding model.

    Args:
        configuration: Model settings including API key, name and batch size.

    Returns:
        OpenAIEmbedding: Configured embedding model instance.
    """
    return OpenAIEmbedding(
        api_key=configuration.secrets.api_key.get_secret_value(),
        model_name=configuration.name,
        embed_batch_size=configuration.batch_size,
    )

VoyageEmbeddingModelBuilder

Builder for creating Voyage AI embedding model instances.

Provides factory method to create configured VoyageEmbedding objects.

Source code in src/common/builders/embedding_builders.py
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
class VoyageEmbeddingModelBuilder:
    """Builder for creating Voyage AI embedding model instances.

    Provides factory method to create configured VoyageEmbedding objects.
    """

    @staticmethod
    @inject
    def build(
        configuration: "VoyageConfiguration",
    ) -> VoyageEmbedding:
        """Creates a configured Voyage AI embedding model.

        Args:
            configuration: Model settings including API key, name and batch size.

        Returns:
            VoyageEmbedding: Configured embedding model instance.
        """
        return VoyageEmbedding(
            voyage_api_key=configuration.secrets.api_key.get_secret_value(),
            model_name=configuration.name,
            embed_batch_size=configuration.batch_size,
        )

build(configuration) staticmethod

Creates a configured Voyage AI embedding model.

Parameters:
  • configuration (VoyageConfiguration) –

    Model settings including API key, name and batch size.

Returns:
  • VoyageEmbedding( VoyageEmbedding ) –

    Configured embedding model instance.

Source code in src/common/builders/embedding_builders.py
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
@staticmethod
@inject
def build(
    configuration: "VoyageConfiguration",
) -> VoyageEmbedding:
    """Creates a configured Voyage AI embedding model.

    Args:
        configuration: Model settings including API key, name and batch size.

    Returns:
        VoyageEmbedding: Configured embedding model instance.
    """
    return VoyageEmbedding(
        voyage_api_key=configuration.secrets.api_key.get_secret_value(),
        model_name=configuration.name,
        embed_batch_size=configuration.batch_size,
    )