Skip to main content

Document Search module for Ragbits

Project description

Ragbits Document Search

Ragbits Document Search is a Python package that provides tools for building RAG applications. It helps ingest, index, and search documents to retrieve relevant information for your prompts.

Installation

You can install the latest version of Ragbits Document Search using pip:

pip install ragbits-document-search

Quickstart

from ragbits.core.embeddings.litellm import LiteLLMEmbedder
from ragbits.core.vector_stores.in_memory import InMemoryVectorStore
from ragbits.document_search import DocumentSearch

async def main() -> None:
    """
    Run the example.
    """
    embedder = LiteLLMEmbedder(
        model="text-embedding-3-small",
    )
    vector_store = InMemoryVectorStore(embedder=embedder)
    document_search = DocumentSearch(
        vector_store=vector_store,
    )

    # Ingest all .txt files from the "biographies" directory
    await document_search.ingest("file://biographies/*.txt")

    # Search the documents for the query
    results = await document_search.search("When was Marie Curie-Sklodowska born?")
    print(results)


if __name__ == "__main__":
    asyncio.run(main())

Documentation

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ragbits_document_search-0.16.0.tar.gz (341.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ragbits_document_search-0.16.0-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

Details for the file ragbits_document_search-0.16.0.tar.gz.

File metadata

  • Download URL: ragbits_document_search-0.16.0.tar.gz
  • Upload date:
  • Size: 341.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ragbits_document_search-0.16.0.tar.gz
Algorithm Hash digest
SHA256 0de28bb844fba34376a08ac0737ebe9789d1930e5b98f7e9dfb025ad00c9e499
MD5 5407ba8dbbc2df9a28fa1042912a0036
BLAKE2b-256 6bb532e5e4a44d9701935777153cf49065c871ff85f026e703f777260dcac8bd

See more details on using hashes here.

File details

Details for the file ragbits_document_search-0.16.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ragbits_document_search-0.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ce1b7c2c75b13081519f0c8a08d10c50c795a8b41297091764e47af9f69ab389
MD5 7111e19c923c669e0abc6c5421df1c38
BLAKE2b-256 57e59fe7ea9ec515b2cfd14ecc837e95e95b8745e87f63b9c15ee65e5dd59a83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page