Skip to content

RAGQueryEngine

autogen.agentchat.contrib.rag.RAGQueryEngine #

Bases: Protocol

A protocol class that represents a document ingestation and query engine on top of an underlying database.

This interface defines the basic methods for RAG.

init_db #

init_db(new_doc_dir=None, new_doc_paths_or_urls=None, *args, **kwargs)

Initialize the database with the input documents or records.

This method initializes database with the input documents or records. Usually, it takes the following steps: 1. connecting to a database. 2. insert records 3. build indexes etc.

PARAMETER DESCRIPTION
new_doc_dir

A directory containing documents to be ingested.

TYPE: Optional[Union[Path, str]] DEFAULT: None

new_doc_paths_or_urls

A list of paths or URLs to documents to be ingested.

TYPE: Optional[Sequence[Union[Path, str]]] DEFAULT: None

*args

Any additional arguments

TYPE: Any DEFAULT: ()

**kwargs

Any additional keyword arguments

TYPE: Any DEFAULT: {}

Returns: bool: True if initialization is successful, False otherwise

Source code in autogen/agentchat/contrib/rag/query_engine.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
def init_db(
    self,
    new_doc_dir: Optional[Union[Path, str]] = None,
    new_doc_paths_or_urls: Optional[Sequence[Union[Path, str]]] = None,
    *args: Any,
    **kwargs: Any,
) -> bool:
    """Initialize the database with the input documents or records.

    This method initializes database with the input documents or records.
    Usually, it takes the following steps:
    1. connecting to a database.
    2. insert records
    3. build indexes etc.

    Args:
        new_doc_dir (Optional[Union[Path, str]]): A directory containing documents to be ingested.
        new_doc_paths_or_urls (Optional[Sequence[Union[Path, str]]]): A list of paths or URLs to documents to be ingested.
        *args: Any additional arguments
        **kwargs: Any additional keyword arguments
    Returns:
        bool: True if initialization is successful, False otherwise
    """
    ...

add_docs #

add_docs(new_doc_dir=None, new_doc_paths_or_urls=None, *args, **kwargs)

Add new documents to the underlying data store.

Source code in autogen/agentchat/contrib/rag/query_engine.py 
46
47
48
49
50
51
52
53
54
def add_docs(
    self,
    new_doc_dir: Optional[Union[Path, str]] = None,
    new_doc_paths_or_urls: Optional[Sequence[Union[Path, str]]] = None,
    *args: Any,
    **kwargs: Any,
) -> None:
    """Add new documents to the underlying data store."""
    ...

connect_db #

connect_db(*args, **kwargs)

Connect to the database. Args: args: Any additional arguments *kwargs: Any additional keyword arguments Returns: bool: True if connection is successful, False otherwise

Source code in autogen/agentchat/contrib/rag/query_engine.py 
56
57
58
59
60
61
62
63
64
def connect_db(self, *args: Any, **kwargs: Any) -> bool:
    """Connect to the database.
    Args:
        *args: Any additional arguments
        **kwargs: Any additional keyword arguments
    Returns:
        bool: True if connection is successful, False otherwise
    """
    ...

query #

query(question, *args, **kwargs)

Transform a string format question into database query and return the result.

PARAMETER DESCRIPTION
question

a string format question

TYPE: str

*args

Any additional arguments

TYPE: Any DEFAULT: ()

**kwargs

Any additional keyword arguments

TYPE: Any DEFAULT: {}

Source code in autogen/agentchat/contrib/rag/query_engine.py 
66
67
68
69
70
71
72
73
74
def query(self, question: str, *args: Any, **kwargs: Any) -> str:
    """Transform a string format question into database query and return the result.

    Args:
        question: a string format question
        *args: Any additional arguments
        **kwargs: Any additional keyword arguments
    """
    ...