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

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.2.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.2-py3-none-any.whl (49.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-1.4.2.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.2.tar.gz
Algorithm Hash digest
SHA256 bbd33529161538233f240f9055788e8f18f143d8203c6532ba0e2e264ff873c1
MD5 63bf065f46d98e98ad37678b5c1f3052
BLAKE2b-256 6c7c95c4e11f19aa2d52822ad466f9c132206f3016b6c1fc8a586f84042a8374

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d8bf865adddf2259039d27287d7440f2983f7db9186fd4816ad7b4808ad662d2
MD5 69a26b9970a03a126b5cb84ad27da28c
BLAKE2b-256 605a468abdcdd70a205ac3f0b0a2e943f74d9aa3e1f79a56b223e86e0e99ddd6

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