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

This version

1.1.0

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-1.1.0.tar.gz (345.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-1.1.0-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ca325acc6cc44658f95d4162d54ff892c3be4f6f843f546ad5e3aa775fddb98a
MD5 a5e4ad76cad04b08b908addcde681264
BLAKE2b-256 14b313dfd5769f612e1cdf35c229504aa5dbe9c0000155a59f1180e874a845c2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4c1f803349f112a0d616a057b6bb6f73ba32a113d118dc79c6a4817fa5926ed4
MD5 015b6b4827f635451c4b6866d136e29c
BLAKE2b-256 b8c9277c8a1f58dcbed0474f18420b4fcddb7e668507258bf9d03464d7ffe5f8

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