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.10.0.tar.gz (485.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.10.0-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-0.10.0.tar.gz
Algorithm Hash digest
SHA256 03844f2174f07085c074ccb47ba6a9a7217c7fea0c0b336e3e849941eaffa475
MD5 24c6c316e5dad96e5acd47346d079ff3
BLAKE2b-256 87ff019af8d120d139a3c05cdf0bf640fb1e9404c988533ea07221ae19475130

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-0.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 301652e0894bc000e98cc3aa20654d91d3681122cba885cd32042020c70baad6
MD5 a28bca2da7ca9c92e1955487af58b160
BLAKE2b-256 a58dfa396494285638e40469348354314424b42a1ecd0956ba6ef2e9fc66b0c2

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