retrieval

RAG Retrieval package.

Modules:

• base –

  Base classes for retrieval.

• file –

  Base classes for retrieval.

• text_splitter –

  Package for classes about text splitter.

• tools –

  Tools for support retrieval classes.

Classes:

• PDFPathRet –

  PDFPathRet Retrieval class.

• RetrievalBase –

  Base Retrieval class.

• StringRet –

  String Retrieval class.

PDFPathRet

PDFPathRet(
    source: Any,
    splitter: TextSplitterBase = LangChainTextSplitter(
        'RecursiveCharacterTextSplitter'
    ),
    api_key: str = '',
    cache: Optional[Cache] = None,
    logs: dict[str, Any] = DEFAULT_LOGS,
)

Bases: FilePathRet

PDFPathRet Retrieval class.

Methods:

• get –

  Get the data from the source.

Source code in src/rago/retrieval/base.py

def __init__(
    self,
    source: Any,
    splitter: TextSplitterBase = LangChainTextSplitter(
        'RecursiveCharacterTextSplitter'
    ),
    api_key: str = '',
    cache: Optional[Cache] = None,
    logs: dict[str, Any] = DEFAULT_LOGS,
) -> None:
    """Initialize the Retrieval class."""
    if logs is DEFAULT_LOGS:
        logs = {}
    super().__init__(api_key=api_key, cache=cache, logs=logs)
    self.source = source
    self.splitter = splitter

    self._validate()
    self._setup()

get

get(query: str = '') -> Iterable[str]

Get the data from the source.

Source code in src/rago/retrieval/file.py

def get(self, query: str = '') -> Iterable[str]:
    """Get the data from the source."""
    cache_key = self.source
    cached = self._get_cache(cache_key)
    if cached is not None:
        return cast(Iterable[str], cached)

    text = extract_text_from_pdf(self.source)

    self.logs['text'] = text

    result = self.splitter.split(text)

    self._save_cache(cache_key, result)

    return result

RetrievalBase

RetrievalBase(
    source: Any,
    splitter: TextSplitterBase = LangChainTextSplitter(
        'RecursiveCharacterTextSplitter'
    ),
    api_key: str = '',
    cache: Optional[Cache] = None,
    logs: dict[str, Any] = DEFAULT_LOGS,
)

Bases: RagoBase

Base Retrieval class.

Methods:

• get –

  Get the data from the source.

Source code in src/rago/retrieval/base.py

def __init__(
    self,
    source: Any,
    splitter: TextSplitterBase = LangChainTextSplitter(
        'RecursiveCharacterTextSplitter'
    ),
    api_key: str = '',
    cache: Optional[Cache] = None,
    logs: dict[str, Any] = DEFAULT_LOGS,
) -> None:
    """Initialize the Retrieval class."""
    if logs is DEFAULT_LOGS:
        logs = {}
    super().__init__(api_key=api_key, cache=cache, logs=logs)
    self.source = source
    self.splitter = splitter

    self._validate()
    self._setup()

get abstractmethod

get(query: str = '') -> Iterable[str]

Get the data from the source.

Source code in src/rago/retrieval/base.py

@abstractmethod
def get(self, query: str = '') -> Iterable[str]:
    """Get the data from the source."""
    return []

StringRet

StringRet(
    source: Any,
    splitter: TextSplitterBase = LangChainTextSplitter(
        'RecursiveCharacterTextSplitter'
    ),
    api_key: str = '',
    cache: Optional[Cache] = None,
    logs: dict[str, Any] = DEFAULT_LOGS,
)

Bases: RetrievalBase

String Retrieval class.

This is a very generic class that assumes that the input (source) is already a list of strings.

Methods:

• get –

  Get the data from the sources.

Source code in src/rago/retrieval/base.py

def __init__(
    self,
    source: Any,
    splitter: TextSplitterBase = LangChainTextSplitter(
        'RecursiveCharacterTextSplitter'
    ),
    api_key: str = '',
    cache: Optional[Cache] = None,
    logs: dict[str, Any] = DEFAULT_LOGS,
) -> None:
    """Initialize the Retrieval class."""
    if logs is DEFAULT_LOGS:
        logs = {}
    super().__init__(api_key=api_key, cache=cache, logs=logs)
    self.source = source
    self.splitter = splitter

    self._validate()
    self._setup()

get

get(query: str = '') -> Iterable[str]

Get the data from the sources.

Source code in src/rago/retrieval/base.py

def get(self, query: str = '') -> Iterable[str]:
    """Get the data from the sources."""
    return cast(list[str], self.source)