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.20.1.tar.gz (345.2 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.20.1-py3-none-any.whl (41.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-0.20.1.tar.gz
  • Upload date:
  • Size: 345.2 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.20.1.tar.gz
Algorithm Hash digest
SHA256 2bdbe9fb9b1b064e07b79a86645c7ac26000a4b0a6ea26cd376c4857a0125194
MD5 5723e2c009c83543e019d6661ed38a6c
BLAKE2b-256 5f09fbd33767bc733f2126055e15712c2c574d1e0e4bc1d435572be2e09b4ca6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.20.1-py3-none-any.whl
Algorithm Hash digest
SHA256 872bfde9c869524ce3d52050ffad0d540261d3e772c7c6d3d6c71e11e1c71400
MD5 cee48880fc871b4791685f49a84daf66
BLAKE2b-256 b4bc734290e2ac779ade6796c5defc650151352c091a3c6e67dca81e14ffaf20

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