Skip to content

RAG

Auxiliary types for RAG System

Query

Bases: _MultiModalDataContainer

Query data structure.

This class represents a multimodal representation of a RAG query.

Attributes:

Name Type Description
text str

Text content of query.
images list[Image] | None

Images content of query.
audios list[Any] | None

Audios content of query.
videos list[Any] | None

Videos content of query.
Source code in src/fed_rag/data_structures/rag.py 
58
59
60
61
62
63
64
65
66
67
68
69
70
class Query(_MultiModalDataContainer):
    """Query data structure.

    This class represents a multimodal representation of a RAG query.

    Attributes:
        text: Text content of query.
        images: Images content of query.
        audios: Audios content of query.
        videos: Videos content of query.
    """

    pass

Context

Bases: _MultiModalDataContainer

Context data structure.

This class represents a multimodal representation of RAG context.

Attributes:

Name Type Description
text str

Text content of query.
images list[Image] | None

Images content of query.
audios list[Any] | None

Audios content of query.
videos list[Any] | None

Videos content of query.
Source code in src/fed_rag/data_structures/rag.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
class Context(_MultiModalDataContainer):
    """Context data structure.

    This class represents a multimodal representation of RAG context.

    Attributes:
        text: Text content of query.
        images: Images content of query.
        audios: Audios content of query.
        videos: Videos content of query.
    """

    pass

Prompt

Bases: _MultiModalDataContainer

Prompt data structure.

This class represents a multimodal representation of a prompt given to a multi-modal LLM.

Attributes:

Name Type Description
text str

Text content of query.
images list[Image] | None

Images content of query.
audios list[Any] | None

Audios content of query.
videos list[Any] | None

Videos content of query.
Source code in src/fed_rag/data_structures/rag.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
class Prompt(_MultiModalDataContainer):
    """Prompt data structure.

    This class represents a multimodal representation of a prompt given to a
    multi-modal LLM.

    Attributes:
        text: Text content of query.
        images: Images content of query.
        audios: Audios content of query.
        videos: Videos content of query.
    """

    pass

SourceNode

Bases: BaseModel

Source code in src/fed_rag/data_structures/rag.py 
11
12
13
14
15
16
17
class SourceNode(BaseModel):
    score: float
    node: KnowledgeNode

    def __getattr__(self, __name: str) -> Any:
        """Convenient wrapper on getattr of associated node."""
        return getattr(self.node, __name)

__getattr__ 

__getattr__(__name)

Convenient wrapper on getattr of associated node.

Source code in src/fed_rag/data_structures/rag.py 
15
16
17
def __getattr__(self, __name: str) -> Any:
    """Convenient wrapper on getattr of associated node."""
    return getattr(self.node, __name)

RAGResponse

Bases: BaseModel

Response class returned by querying RAG systems.

Source code in src/fed_rag/data_structures/rag.py 
20
21
22
23
24
25
26
27
28
class RAGResponse(BaseModel):
    """Response class returned by querying RAG systems."""

    response: str
    raw_response: str | None = None
    source_nodes: list[SourceNode]

    def __str__(self) -> str:
        return self.response