MetaGPT

1
"""RAG Interfaces."""
2

3
from typing import Protocol, runtime_checkable
4

5

6
@runtime_checkable
7
class RAGObject(Protocol):
8
    """Support rag add object."""
9

10
    def rag_key(self) -> str:
11
        """For rag search."""
12

13
    def model_dump_json(self) -> str:
14
        """For rag persist.
15

16
        Pydantic Model don't need to implement this, as there is a built-in function named model_dump_json.
17
        """
18

19

20
@runtime_checkable
21
class NoEmbedding(Protocol):
22
    """Some retriever does not require embeddings, e.g. BM25"""
23

24
    _no_embedding: bool
25