پرش به مطلب اصلی

مستندات برای هوش مصنوعی

این مستندات طوری منتشر می‌شوند که مدل‌های زبانی، دستیارهای برنامه‌نویسی (Claude، ChatGPT، Cursor، Copilot) و عامل‌های خودکار بتوانند آن‌ها را کامل و دقیق بخوانند.

فایل‌ها​

فایلمحتوا
/llms.txtفهرست همه صفحه‌ها با توضیح کوتاه و پیوند به نسخه Markdown، به قالب llmstxt.org
/llms-full.txtکل مستندات در یک فایل متنی، به ترتیب فهرست کناری
/<صفحه>.mdنسخه Markdown هر صفحه؛ مثلاً /cloud-api.md
/en/llms.txt و /en/llms-full.txtهمان فایل‌ها به انگلیسی
سندهای OpenAPIتوصیف ماشین‌خوان هر وب سرویس؛ فهرست در مرجع API

نسخه انگلیسی برای بیشتر مدل‌ها دقیق‌تر است؛ محتوای هر دو زبان یکی است.

دکمه «کپی صفحه»​

بالای هر صفحه دکمه کپی صفحه متن Markdown همان صفحه را کپی می‌کند تا آن را در گفتگو بچسبانید. منوی کنار آن صفحه را مستقیم در Claude یا ChatGPT باز می‌کند یا نسخه Markdown را نشان می‌دهد.

نمونه پرامپت​

Read https://docs.ariaservice.net/en/llms.txt and the pages it links that you need.
Using the Arianet Cloud API, write a Python script that creates a server named web-1
in datacenter ovh with plan 3 and image ubuntu-24.04, waits for the create action
to finish, and prints its public IPv4. Read the token from ARIANET_TOKEN.

قواعد برای عامل‌های خودکار​

اگر عاملی می‌سازید که با توکن شما روی آریانت کار می‌کند:

  • کمترین دسترسی: برای عامل یک توکن جدا با کمترین scope لازم بسازید؛ برای کارهای فقط‌خواندنی فقط scopeهای read.
  • توکن را به مدل ندهید: توکن را در متغیر محیطی ابزار نگه دارید، نه در پرامپت یا تاریخچه گفتگو.
  • تأیید انسان برای کارهای پرهزینه یا برگشت‌ناپذیر: ساخت، حذف، نصب مجدد، تمدید و ارسال پیامک هزینه دارند یا داده پاک می‌کنند؛ پیش از اجرا تأیید بگیرید.
  • تکرار امن: برای سفارش‌ها کلید ایدمپوتنسی بفرستید و پس از 504 پیش از تکرار وضعیت را بخوانید.
  • منتظر پایان بمانید: پاسخ 201/202 یعنی کار شروع شده، نه تمام شده؛ action را دنبال کنید.
  • محدودیت نرخ: هدرهای RateLimit-* و Retry-After را رعایت کنید.
  • منبع حقیقت: برای نام دقیق فیلدها به سند OpenAPI همان وب سرویس تکیه کنید، نه به حدس مدل.