autogen.agentchat.contrib.rag.RAGQueryEngine

RAGQueryEngine

RAGQueryEngine(*args, **kwargs)

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.

Parameters:

Name	Description
*args
**kwargs

Instance Methods

add_docs

add_docs(
    self,
    new_doc_dir: Path | str | None = None,
    new_doc_paths_or_urls: Sequence[Path | str] | None = None,
    *args: Any,
    **kwargs: Any
) -> None

Add new documents to the underlying data store.

Parameters:

Name	Description
new_doc_dir	Type: pathlib.Path | str | None Default: None
new_doc_paths_or_urls	Type: Sequence[pathlib.Path | str] | None Default: None
*args	Type: Any
**kwargs	Type: Any

connect_db

connect_db(
    self,
    *args: Any,
    **kwargs: Any
) -> bool

Connect to the database.

Parameters:

Name	Description
*args	Any additional arguments Type: Any
**kwargs	Any additional keyword arguments Type: Any

Returns:

Type	Description
bool	bool: True if connection is successful, False otherwise

init_db

init_db(
    self,
    new_doc_dir: Path | str | None = None,
    new_doc_paths_or_urls: Sequence[Path | str] | None = 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.

Parameters:

Name	Description
new_doc_dir	A directory containing documents to be ingested. Type: pathlib.Path | str | None Default: None
new_doc_paths_or_urls	A list of paths or URLs to documents to be ingested. Type: Sequence[pathlib.Path | str] | None Default: None
*args	Any additional arguments Type: Any
**kwargs	Any additional keyword arguments Type: Any

Returns:

Type	Description
bool	bool: True if initialization is successful, False otherwise

query

query(
    self,
    question: str,
    *args: Any,
    **kwargs: Any
) -> str

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

Parameters:

Name	Description
question	a string format question Type: str
*args	Any additional arguments Type: Any
**kwargs	Any additional keyword arguments Type: Any