From b10dc1ae85eab4b9f993d4edcf57f46ec4fb1f65 Mon Sep 17 00:00:00 2001 From: MasihMoafi Date: Fri, 2 May 2025 10:58:09 +0000 Subject: [PATCH] Update note.md --- note.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/note.md b/note.md index 31c2d67..d3941b0 100644 --- a/note.md +++ b/note.md @@ -70,6 +70,17 @@ rag.load_pdf("path/to/your/document.pdf") این سیستم تنها وظیفه بازیابی متن مرتبط را بر عهده دارد و برای تولید پاسخ نهایی نیازی به فراخوانی مستقیم یک مدل زبانی بزرگ (LLM) توسط کاربر ندارد (هرچند خروجی آن می‌تواند به عنوان ورودی به LLM داده شود). برای استفاده از این سیستم در پروژه‌های دیگر، کافی است فایل پایتون مربوطه را وارد (import) کرده و تابع get_context را فراخوانی نمایید. +## **توضیح توابع اصلی** + +* `load_pdf`: بارگذاری، پردازش و تقسیم‌بندی محتوای فایل‌های PDF. +* `search_duckduckgo`: انجام جستجو در موتور جستجوی DuckDuckGo. +* `crawl_page`: استخراج محتوای متنی و لینک‌های موجود در یک صفحه وب. +* `crawl_web`: ترکیب جستجو و خزش صفحات وب برای یافتن اطلاعات مرتبط. +* `build_retriever`: ساخت و آماده‌سازی بازیاب (Retriever) بر اساس الگوریتم `BM25` برای جستجوی کلیدواژه‌ای در اسناد. +* `get_relevant_documents`: یافتن مرتبط‌ترین اسناد موجود با پرسش کاربر. +* `extract_context_from_documents`: استخراج متن مرتبط با پرسش از اسناد یافت‌شده. +* `extract_context_from_web`: استخراج متن مرتبط با پرسش از نتایج خزش وب. +* `get_context`: تابع اصلی و رابط کاربری سیستم که فرآیند جستجو در اسناد و یا خزش وب را مدیریت کرده و نتیجه نهایی را برمی‌گرداند. ## **نکات مهم**