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

import asyncio

from ragbits.core.embeddings 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_name="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("local://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.4.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.4.0.tar.gz (721.5 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.4.0-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-1.4.0.tar.gz
  • Upload date:
  • Size: 721.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.19

File hashes

Hashes for ragbits_document_search-1.4.0.tar.gz
Algorithm Hash digest
SHA256 dfea68d95ee616b0221b9c085a9387d17c23205aec75f00c0e4d0eb032b53ece
MD5 e8a797d6fa7aa7df4e1a1796619901f6
BLAKE2b-256 b81f6c91f9f5912f10c94d26455b077b1a26ffb696e38e4ae1ff858207481e53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 be4139c136cc7f0854f73b5175d5103d1eaf6ae2f93fcc5da3ff41de4f9ac7a1
MD5 3ad93a08e5715b8f4b7a8366f5757f5e
BLAKE2b-256 abe27170b3d72948bb7ad0e449f647e1a41b851770f1eb613ec1599ec66e6670

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