Query_engine_builders

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

Query_engine_builders

QueryEngineBuilder

Builder for creating RAG query engine instances.

Provides factory method to create configured RagQueryEngine with retriever, postprocessors, synthesizer and callback management.

Source code in src/common/builders/query_engine_builders.py
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
class QueryEngineBuilder:
    """Builder for creating RAG query engine instances.

    Provides factory method to create configured RagQueryEngine with retriever,
    postprocessors, synthesizer and callback management.
    """

    @staticmethod
    @inject
    def build(
        retriever: BaseRetriever,
        postprocessors: BoundPostprocessors,
        synthesizer: BaseSynthesizer,
        callback_manager: CallbackManager,
        configuration: LangfuseConfiguration,
    ) -> RagQueryEngine:
        """Creates a configured RAG query engine instance.

        Sets up callback management for components and assembles the engine.

        Args:
            retriever: Document retrieval component
            postprocessors: List of document processing steps
            synthesizer: Response generation component
            callback_manager: Callback handling for components
            configuration: Langfuse integration settings

        Returns:
            RagQueryEngine: Configured query engine instance
        """
        retriever.callback_manager = callback_manager
        synthesizer.callback_manager = callback_manager
        for postprocessor in postprocessors:
            postprocessor.callback_manager = callback_manager

        return RagQueryEngine(
            retriever=retriever,
            postprocessors=postprocessors,
            response_synthesizer=synthesizer,
            callback_manager=callback_manager,
            chainlit_tag_format=configuration.chainlit_tag_format,
        )

build(retriever, postprocessors, synthesizer, callback_manager, configuration) staticmethod

Creates a configured RAG query engine instance.

Sets up callback management for components and assembles the engine.

Parameters:
  • retriever (BaseRetriever) –

    Document retrieval component

  • postprocessors (BoundPostprocessors) –

    List of document processing steps

  • synthesizer (BaseSynthesizer) –

    Response generation component

  • callback_manager (CallbackManager) –

    Callback handling for components

  • configuration (LangfuseConfiguration) –

    Langfuse integration settings

Returns:
  • RagQueryEngine( RagQueryEngine ) –

    Configured query engine instance

Source code in src/common/builders/query_engine_builders.py
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@staticmethod
@inject
def build(
    retriever: BaseRetriever,
    postprocessors: BoundPostprocessors,
    synthesizer: BaseSynthesizer,
    callback_manager: CallbackManager,
    configuration: LangfuseConfiguration,
) -> RagQueryEngine:
    """Creates a configured RAG query engine instance.

    Sets up callback management for components and assembles the engine.

    Args:
        retriever: Document retrieval component
        postprocessors: List of document processing steps
        synthesizer: Response generation component
        callback_manager: Callback handling for components
        configuration: Langfuse integration settings

    Returns:
        RagQueryEngine: Configured query engine instance
    """
    retriever.callback_manager = callback_manager
    synthesizer.callback_manager = callback_manager
    for postprocessor in postprocessors:
        postprocessor.callback_manager = callback_manager

    return RagQueryEngine(
        retriever=retriever,
        postprocessors=postprocessors,
        response_synthesizer=synthesizer,
        callback_manager=callback_manager,
        chainlit_tag_format=configuration.chainlit_tag_format,
    )