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.13.0.tar.gz (356.0 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.13.0-py3-none-any.whl (55.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.13.0.tar.gz
  • Upload date:
  • Size: 356.0 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.13.0.tar.gz
Algorithm Hash digest
SHA256 f314f6b1249db6b3d15a9fb9b8f531c5923873f7b9486696efd8996ff308b2dd
MD5 9a78e77ef1e85b3163f675ef8c62d841
BLAKE2b-256 765cf9719fda4f9b10cd924e9ebcb8b120e6d351c89041db032dab3b314bfb3d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd0eb809800d8de02ebe3e612cc8acd08b499831d777a977ab5281b9382c817a
MD5 579fd391fa3eac7a75a1f70ac32d0e9f
BLAKE2b-256 601ce535d0b6ea7daa7133afa063d3ec6b4d9f9ac464733443ea59a31e8dd364

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