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

Uploaded Python 3

File details

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

File metadata

  • Download URL: ragbits_document_search-1.4.1.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.1.tar.gz
Algorithm Hash digest
SHA256 68f744e2a55bd4d51c5f334988e8cde8b7929d93eed752a791e0fd112a263cbc
MD5 15138b90dd798001d0e1cfc9e5548fab
BLAKE2b-256 615c0ec1bcf02fddd6c59f7763d7969530bb40f0db1b8e0f8510b70aa2dbc763

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 2c7931304cb16506a8571364e38922bf074fba6fa2db42f2c10ac5161b3b7360
MD5 f30b95e2b3c907d502335e26cb898e40
BLAKE2b-256 6c2ba6d3f4f08b22f1878eab69a3ddbdb27a2c4b68ead029c6a0a237aac2a9a3

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