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.0.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.0.0.tar.gz (345.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-1.0.0-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ragbits_document_search-1.0.0.tar.gz
Algorithm Hash digest
SHA256 2ae5a46640cbce45656ef0137435ceea7fa3b4026bf94f057016e410d877dd15
MD5 471731352081df1447911d3380afd4d9
BLAKE2b-256 a435d2a49a8f3bbafa59c210ae049a9e3102b7043c82efe6972488aa63808f61

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ragbits_document_search-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5bfcadbcc5b3fc34006685bdbf6bd8f8eb6a5ebab03b93aa8c4cabb2ad8f516e
MD5 748617515db4bcb418847787ea174cd5
BLAKE2b-256 979b7066bc286903da19185934313e805fd1f119ba74c713e61894a06306e976

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