diff --git a/note.md b/note.md index 168281a..31c2d67 100644 --- a/note.md +++ b/note.md @@ -69,3 +69,15 @@ rag.load_pdf("path/to/your/document.pdf") سیستم به صورت خودکار اسناد پردازش‌شده و نتایج وب را ذخیره و در اجراهای بعدی مجدداً بارگذاری می‌کند تا از پردازش تکراری جلوگیری شود. این سیستم تنها وظیفه بازیابی متن مرتبط را بر عهده دارد و برای تولید پاسخ نهایی نیازی به فراخوانی مستقیم یک مدل زبانی بزرگ (LLM) توسط کاربر ندارد (هرچند خروجی آن می‌تواند به عنوان ورودی به LLM داده شود). برای استفاده از این سیستم در پروژه‌های دیگر، کافی است فایل پایتون مربوطه را وارد (import) کرده و تابع get_context را فراخوانی نمایید. + + +## **نکات مهم** + +* برای افزودن اسناد PDF جدید به سیستم، از تابع `load_pdf` استفاده کنید: + ```python + rag = ModularRAG() + rag.load_pdf("path/to/your/document.pdf") + ``` +* سیستم به صورت خودکار اسناد پردازش‌شده و نتایج وب را ذخیره و در اجراهای بعدی مجدداً بارگذاری می‌کند تا از پردازش تکراری جلوگیری شود. +* این سیستم تنها وظیفه **بازیابی متن مرتبط** را بر عهده دارد و برای تولید پاسخ نهایی نیازی به فراخوانی مستقیم یک مدل زبانی بزرگ (LLM) توسط کاربر ندارد (هرچند خروجی آن می‌تواند به عنوان ورودی به LLM داده شود). +* برای استفاده از این سیستم در پروژه‌های دیگر، کافی است فایل پایتون مربوطه را وارد (import) کرده و تابع `get_context` را فراخوانی نمایید. \ No newline at end of file