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

This version

1.2.1

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.2.1.tar.gz (345.6 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.2.1-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-1.2.1.tar.gz
Algorithm Hash digest
SHA256 f0348e5bfa440e61a24c7d2ddda0e19c674e9890ec65d8603c87c367d4afbf30
MD5 c724af196cfc1ba3ed3ace155841ce4f
BLAKE2b-256 401c18554c5e80727979a77dd169fc2cdf9985c973d13d773ecad09169678642

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8d933ec106d074f70433e8cafc33e83acffd43e28b28d1315dd740233adc39a0
MD5 0d12bd436a88f751c78f15fb36ea86a6
BLAKE2b-256 606e885aac0875c1e7ffa3023d8571d1638347d56b67bd9573c79fa7b1601de6

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