سیستم مستندات یکپارچه

Knowledge - Modules

کاتالوگ ماژول‌ها

در این صفحه هر ماژول فقط به عنوان مسیر فایل نمایش داده نشده است؛ توضیح بیزینسی، نقش فنی، ورودی/خروجی، endpointها و مدل‌های مرتبط نیز بر اساس نام فایل‌ها، controllerها، routeها و schemaهای موجود استخراج شده‌اند.

ModulePathKindFiles
elevator_biblesrc/elevator_bibleکد کاربردی16
elevator_bible_pdf_patchelevator_bible_pdf_patch/ingestionکد کاربردی2
scriptsscriptsکد کاربردی4
web-frontendapps/web-frontend/app/admin/audit-logsکد کاربردی16

elevator_bible

توضیح بیزینسی: مدیریت کاربران، پروفایل، نقش‌ها یا اطلاعات فردی را پوشش می‌دهد.

توضیح فنی: معمولاً به auth، permission و مدل‌های کاربر وابسته است و تغییرات آن روی دسترسی و تجربه کاربر اثر مستقیم دارد. در اسکن فعلی 96 endpoint، 63 مدل و 16 فایل مرتبط ثبت شده است.

مسیر ماژولsrc/elevator_bible
نوع غالبکد کاربردی
ورودی‌هاHTTP/API، فرم UI، job/scheduler یا service call داخلی بر اساس فایل‌های موجود
خروجی‌هاresponse API، رکورد پایگاه داده، رخداد audit/notification یا state قابل نمایش
نکته نگهداریبرای توسعه، ابتدا فایل‌های controller/view، سپس service و در نهایت مدل‌ها یا DTOهای مرتبط بررسی شوند.

Endpointهای مرتبط

  • GET /admin/audit-logs - audit_logs
  • GET /admin/usage - usage
  • GET /admin/usage/summary - usage_summary
  • GET /admin/usage/tenants/{tenant_id} - tenant_usage
  • GET /admin/system-settings - system_settings
  • PATCH /admin/system-settings - patch_system_settings
  • GET /admin/licenses - list_licenses
  • GET /admin/license-plans - list_plans

مدل‌های مرتبط

  • AssistantModel - Pydantic model
  • AssistantModelsResponse - Pydantic model
  • AssistantChatRequest - Pydantic model
  • AssistantVisionRequest - Pydantic model
  • AssistantCitation - Pydantic model
  • AssistantAnswerSection - Pydantic model
  • AssistantAnswer - Pydantic model
  • AssistantChatResponse - Pydantic model

منابع کد

  • src/elevator_bible/__init__.py
  • src/elevator_bible/api/__init__.py
  • src/elevator_bible/api/admin_audit.py
  • src/elevator_bible/api/admin_license_instances.py
  • src/elevator_bible/api/admin_licenses.py
  • src/elevator_bible/api/admin_tenants.py
  • src/elevator_bible/api/admin_users.py
  • src/elevator_bible/api/app.py
  • src/elevator_bible/api/me.py
  • src/elevator_bible/api/synthetic_lab.py
  • src/elevator_bible/api/tenant.py
  • src/elevator_bible/artifact_store.py

elevator_bible_pdf_patch

توضیح بیزینسی: جریان داده عملیاتی و رخدادهای سلامت یا خرابی را دریافت، نرمال‌سازی و برای تصمیم‌گیری آماده می‌کند.

توضیح فنی: مرز اصلی ingest است؛ schema، idempotency و backpressure در این قسمت اهمیت بالایی دارند. در اسکن فعلی 0 endpoint، 0 مدل و 2 فایل مرتبط ثبت شده است.

مسیر ماژولelevator_bible_pdf_patch/ingestion
نوع غالبکد کاربردی
ورودی‌هاservice call داخلی، import از ماژول‌های دیگر یا داده محلی
خروجی‌هاخروجی helper/component/contract؛ نیازمند بررسی مصرف‌کننده‌ها
نکته نگهداریendpoint یا مدل مستقیمی برای این ماژول پیدا نشد؛ ممکن است نقش آن UI، helper، contract یا orchestration داخلی باشد.

Endpointهای مرتبط

  • Endpoint مستقیمی پیدا نشد.

مدل‌های مرتبط

  • مدل داده مستقیمی پیدا نشد.

منابع کد

  • elevator_bible_pdf_patch/ingestion/pdf_exam_parser.py
  • elevator_bible_pdf_patch/scripts/import_exam_pdfs.py

scripts

توضیح بیزینسی: این ماژول یک بخش کاربردی مستقل در پروژه است و از روی ساختار فایل‌ها به عنوان مرز منطقی برای قابلیت‌های مرتبط شناسایی شده است.

توضیح فنی: از نظر فنی شامل 4 فایل کلیدی است و در خروجی اسکن، 0 endpoint و 0 مدل داده مرتبط با آن پیدا شد.

مسیر ماژولscripts
نوع غالبکد کاربردی
ورودی‌هاservice call داخلی، import از ماژول‌های دیگر یا داده محلی
خروجی‌هاخروجی helper/component/contract؛ نیازمند بررسی مصرف‌کننده‌ها
نکته نگهداریendpoint یا مدل مستقیمی برای این ماژول پیدا نشد؛ ممکن است نقش آن UI، helper، contract یا orchestration داخلی باشد.

Endpointهای مرتبط

  • Endpoint مستقیمی پیدا نشد.

مدل‌های مرتبط

  • مدل داده مستقیمی پیدا نشد.

منابع کد

  • scripts/build_offline_pack.py
  • scripts/import_book_pdfs.py
  • scripts/import_exam_pdfs.py
  • scripts/import_reference_pdfs.py

web-frontend

توضیح بیزینسی: مسئول احراز هویت، صدور یا اعتبارسنجی نشست کاربر و آماده‌سازی context امنیتی درخواست‌ها است.

توضیح فنی: مرکز کنترل ورود، token/session، guard یا permission check است و باید با policyهای امنیتی پروژه هماهنگ بماند. در اسکن فعلی 0 endpoint، 0 مدل و 16 فایل مرتبط ثبت شده است.

مسیر ماژولapps/web-frontend/app/admin/audit-logs
نوع غالبکد کاربردی
ورودی‌هاservice call داخلی، import از ماژول‌های دیگر یا داده محلی
خروجی‌هاخروجی helper/component/contract؛ نیازمند بررسی مصرف‌کننده‌ها
نکته نگهداریendpoint یا مدل مستقیمی برای این ماژول پیدا نشد؛ ممکن است نقش آن UI، helper، contract یا orchestration داخلی باشد.

Endpointهای مرتبط

  • Endpoint مستقیمی پیدا نشد.

مدل‌های مرتبط

  • مدل داده مستقیمی پیدا نشد.

منابع کد

  • apps/web-frontend/app/admin/audit-logs/page.tsx
  • apps/web-frontend/app/admin/license-plans/page.tsx
  • apps/web-frontend/app/admin/licenses/page.tsx
  • apps/web-frontend/app/admin/overview/page.tsx
  • apps/web-frontend/app/admin/system-settings/page.tsx
  • apps/web-frontend/app/admin/tenants/[id]/page.tsx
  • apps/web-frontend/app/admin/tenants/page.tsx
  • apps/web-frontend/app/admin/usage/page.tsx
  • apps/web-frontend/app/admin/users/page.tsx
  • apps/web-frontend/app/analytics/page.tsx
  • apps/web-frontend/app/assistant/page.tsx
  • apps/web-frontend/app/books/page.tsx