[FA] فارسی | EN

هاب مثال‌های راهیانا ✨

به مرکز رسمی مثال‌ها و پروژه‌های آموزشی راهیانا خوش آمدید. این ریپو «هاب» تمام مثال‌های زبان‌های مختلف را یک‌جا معرفی و لینک می‌کند تا سریع‌تر شروع کنید و بهترین مسیر را پیدا کنید.

📎 مرور سریع نکات مشترک API

• آدرس پایه: https://rahyana.ir/api/v1
• احراز هویت: هدر Authorization: Bearer YOUR_API_KEY
• مدل‌ها: دریافت فهرست مدل‌ها با GET /api/v1/models
• قالب خطا: شیء error شامل message، type، code و در برخی موارد هدر X-Provider-Error.
• تست محلی: از متغیرهای محیطی API_KEY_OVERRIDE و BASE_URL_OVERRIDE استفاده کنید.

🧪 نمونه درخواست (cURL) — فهرست مدل‌ها

curl -s -H "Authorization: Bearer $API_KEY" \
     "https://rahyana.ir/api/v1/models"

🧪 نمونه درخواست (cURL) — چت کامپلشن

curl -s -X POST "https://rahyana.ir/api/v1/chat/completions" \
     -H "Authorization: Bearer $API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "model": "openai/gpt-4o",
       "messages": [{"role":"user","content":"سلام"}]
     }'

🤝 سازگاری با OpenAI

• «مسیرها» و «ساختار بدنه/پاسخ» با استاندارد OpenAI سازگار است؛ می‌توانید بسیاری از کلاینت‌های OpenAI را با تغییر آدرس پایه و کلید استفاده کنید.
• برای حالت‌های خاص (مانند تصویر/صوت/PDF یا ابزارها)، راهیانا نگاشت‌های سازگار فراهم کرده است.

🧠 مستندات تکمیلی

• مدل‌ها: docs/models.fa.md (و نسخه انگلیسی docs/models.en.md)
• چت کامپلشن: docs/chat-completions.fa.md (و نسخه انگلیسی docs/chat-completions.en.md)

📚 مخازن زبان‌ها

• JavaScript: به‌زودی اضافه می‌شود
• TypeScript: به‌زودی اضافه می‌شود
• Python: به‌زودی اضافه می‌شود

🧩 چه چیزهایی پیدا می‌کنید؟

• مثال‌های «چت تکمیلی» (Basic/Streaming/JSON Mode) و ورودی‌های تصویر/صوت/PDF
• پروژه‌های واقعی و پرتقاضا (تولید محتوا، چت‌بات، دستیار کدنویسی و ...)
• ابزارهای توسعه‌محور (تولید تست، مانیتورینگ عملکرد، تولید مستندات، بازبین کد، CI/CD)

✅ استانداردهای کیفیت

• مثال‌ها «قابل اجرا» و مستند هستند (FA/EN)
• تست دود (Smoke Test) برای اطمینان از صحت اجرای نمونه‌ها
• فرمت و لینت استاندارد (Black/Ruff، ESLint/Prettier)

🤝 مشارکت

• باگ یا پیشنهاد دارید؟ در «Issues» مطرح کنید.
• ایده‌های جدید را در «Discussions» به اشتراک بگذارید.
• راهنمای مشارکت: فایل CONTRIBUTING.md

---