Skip to main content

Easily implement RAG workflows with pre-built modules.

Project description

easy_rag_llm

CAUTION

  • easy-rag-llm==1.0.* version is testing version. These versions are usually invalid.

🇰🇷 소개

  • easy_rag_llm는 OpenAI 및 DeepSeek 모델을 지원하는 간단한 RAG(정보 검색 및 생성) 기반 서비스를 제공합니다. 간단하게 RAG LLM을 서비스에 통합시킬 수 있도록 만들어졌습니다.
  • (2025.01.15 기준/ v1.0.0) 학습가능한 자료 포맷은 PDF입니다.

🇺🇸 Introduction

  • easy_rag_llm is a lightweight RAG-based service that supports both OpenAI and DeepSeek models. It is designed to seamlessly integrate RAG-based LLM functionalities into your service.
  • As of 2025-01-15 (v1.0.0), the supported resource format for training is PDF.

Usage

Install

pip install easy_rag_llm

How to integrate to your service?

from easy_rag import RagService

rs = RagService(
    embedding_model="text-embedding-3-small", #Fixed to OpenAI model
    response_model="deepseek-chat",  # Options: "openai" or "deepseek-chat"
    open_api_key="your_openai_api_key_here",
    deepseek_api_key="your_deepseek_api_key_here",
    deepseek_base_url="https://api.deepseek.com",
)

resource = rs.rsc("./rscFiles")  # Learn from all files under ./rscFiles

query = "What is the summary of the first document?"
response, top_evidence = rs.generate_response(resource, query)

print(response)

🇰🇷 메모.

pdf 제목을 명확하게 적어주세요. 메타데이터에는 pdf제목이 추출되어 들어가며, 답변 근거를 출력할때 유용하게 사용될 수 있습니다.

🇺🇸 Memo.

  • Ensure that your PDFs have clear titles. Extracted titles from the PDF metadata are used during training and for generating evidence-based responses.

Author Information

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

easy_rag_llm-1.0.9.tar.gz (8.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

easy_rag_llm-1.0.9-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file easy_rag_llm-1.0.9.tar.gz.

File metadata

  • Download URL: easy_rag_llm-1.0.9.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for easy_rag_llm-1.0.9.tar.gz
Algorithm Hash digest
SHA256 d55962cb3ea21ec79f3736e875f9855425a200fff1378283b4c814ae1d4fc35d
MD5 85a9f194f47770b07b7fa0dac163e7a3
BLAKE2b-256 1a8187114e557ece5a653cc8cf00494c0f43ee569028d522f9fc0830c876931b

See more details on using hashes here.

File details

Details for the file easy_rag_llm-1.0.9-py3-none-any.whl.

File metadata

  • Download URL: easy_rag_llm-1.0.9-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for easy_rag_llm-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 85ad25a2b8b7e099efaf3a1004f2725d7147c181dd172f7ce427f2f90558cd3e
MD5 d76e13e0d8010281193bd5de0966f0c8
BLAKE2b-256 072375a8f64f476e899670ec8c0c2a774b8f3ba8041333f00de53f98bafc1017

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