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.10.1.tar.gz (485.4 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.10.1-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-0.10.1.tar.gz
Algorithm Hash digest
SHA256 4328d8b74759b3fe0ffcd9737df20b237ebc2b2daa04e75babf49fe278cd7f30
MD5 29a4176e190aa8b75af8b5b755dea9e4
BLAKE2b-256 b5ba97db93caccabf13201e736c5ad54ade7a5dadb6502f8c35f62a9ca409653

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 518b65b2952b09eb2092974300fa56cced910fb7fdfdc47d6ea4bcd8efc69a2a
MD5 f876fbc22a5b55b9fdd1589d0864e653
BLAKE2b-256 fb931724936ed880162cd0cfdbf2be040f0519c2975288d59972192cfba6d7fa

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