رفتن به محتوا
پلی‌گراند API

پلی‌گراند API

تعاملی

همه مدل‌ها و endpointها را با کلید خودتان در مرورگر امتحان کنید — خروجی streaming، بازرس درخواست و کد تولیدشده که مستقیم در برنامه‌تان قابل جای‌گذاری است.

اجرای Playground

playground یک کنسول چت برای API در /docs/playground است. با یک مدل گفتگو می‌کنید و playground همان درخواست‌هایی را می‌فرستد که کد شما می‌فرستد: به یکی از سه endpoint، با مدل، system prompt، پارامترها و ابزارهایی که تنظیم کرده‌اید. هر درخواست را می‌توان به‌صورت کد و به‌صورت رویدادهای خام stream دوباره خواند.

شروع

  • یک کلید بدهید — اگر وارد شده باشید، playground از کلید API حساب شما استفاده می‌کند و موجودی شما را نشان می‌دهد. اگر وارد نشده باشید، افزودن کلید را انتخاب کنید و یک کلید بچسبانید: فقط در این تب نگه داشته می‌شود و هرگز ذخیره نمی‌شود.
  • یک endpoint و یک مدل انتخاب کنید — نوار بالا کلید endpoint و انتخاب‌گر مدل را دارد. گفتگوی جدید با Chat Completions و shannon-3 شروع می‌شود.
  • یک پیام بفرستید — در پایین تایپ کنید و Enter را بزنید. هر پاسخ به گفتگو می‌پیوندد، پس پیام بعدی آن را ادامه می‌دهد. صفحه خالی سه پرامپت شروع و یک نمونه آماده فراخوانی ابزار پیشنهاد می‌کند.

کلید خود را در صفحه «کلیدها و مصرف» پیدا و تعویض می‌کنید. کلیدها و مصرف

Endpointها و مدل‌ها

کلید endpoint تعیین می‌کند playground کدام فرمت درخواست را بسازد. می‌توانید آن را وسط گفتگو عوض کنید؛ پیام‌ها می‌مانند.

Endpoint درخواستی که می‌فرستد مرجع
Chat Completions POST /v1/chat/completions Chat Completions
Responses POST /v1/responses Responses API
Messages POST /v1/messages فرمت Anthropic

انتخاب‌گر مدل آنچه GET /v1/models برمی‌گرداند را فهرست می‌کند. می‌توان در آن جستجو کرد، مدل‌های اخیر شما را بالا نگه می‌دارد و برای هر مدل قیمت هر 1M توکن، پنجره زمینه و نشانه‌های ابزار، ورودی تصویر، استدلال و خروجی ساختاریافته را نشان می‌دهد.

گفتگو

  • پاسخ‌ها همان‌طور که نوشته می‌شوند در گفتگو stream می‌شوند. استدلال مدل در بلوک جداگانه‌ای نشان داده می‌شود که می‌توانید آن را جمع کنید.
  • زیر هر پاسخ: زمان تا اولین توکن، توکن در ثانیه، زمان سپری‌شده، توکن‌های ورودی و خروجی با بخش‌های کش‌شده و استدلال، تخمینی از هزینه نوبت، دلیل پایان و شناسه پاسخ.
  • پیام شما را می‌توان ویرایش کرد و از همان نقطه دوباره فرستاد. پاسخ را می‌توان دوباره تولید کرد. پیام را می‌توان حذف کرد و حذف تا چند ثانیه قابل بازگرداندن است.
  • توقف یا کلید Esc پاسخی را که نوشته می‌شود پایان می‌دهد.
  • تصاویر برای مدل‌هایی که تصویر می‌پذیرند با دکمه تصویر، با چسباندن یا با رها کردن فایل پیوست می‌شوند. تصویر پیش از ارسال تا 1,568 پیکسل در ضلع بلندش کوچک می‌شود. فایل بیش از 30 MB نادیده گرفته می‌شود.
  • کادر نوشتن و system prompt تعداد توکن را نشان می‌دهند. برای مدل‌های open-weight میزبانی‌شده این شمارش دقیق از POST /v1/tokenize است. برای مدل‌های دیگر تخمین است و با ≈ علامت می‌خورد.
  • درخواست ناموفق نشان می‌دهد بعد چه باید کرد: تنظیم کلید وقتی کلید رد شده، شارژ وقتی موجودی تمام شده، ثانیه‌های انتظار پس از درخواست‌های بیش از حد، یا تلاش دوباره پس از خطای سرور.

تنظیمات درخواست

دکمه تنظیمات پنلی با شش تب باز می‌کند. تنظیمات متعلق به گفتگو هستند: هر گفتگو تنظیمات خودش را نگه می‌دارد.

تب چه چیزی را نگه می‌دارد
سیستم system prompt گفتگو که با هر درخواست فرستاده می‌شود. پنج قالب آن را پر می‌کنند و تعداد توکن‌هایش نشان داده می‌شود.
پارامترها حداکثر توکن‌های خروجی، temperature، top_p، میزان تلاش استدلال، توالی‌های توقف، seed و کلیدهای streaming و جستجوی وب. کنترلی که endpoint انتخاب‌شده فیلدی برایش ندارد خاموش و علامت‌گذاری می‌شود.
ابزارها تعریف ابزارهایی که همراه درخواست فرستاده می‌شوند: چهار پیش‌تنظیم (get_weather، read_file، run_shell، web_search) یا تعریف خودتان به‌صورت JSON، و tool_choice (auto، none، required یا یک ابزار با نام). وقتی مدل ابزاری فراخوانی کند، گفتگو فراخوانی را با جعبه‌ای برای نتیجه نشان می‌دهد. با روشن بودن ارائه نتایج نمونه، یک کلیک نتیجه‌ای نمونه را پر می‌کند. می‌توانید نتیجه خودتان را هم تایپ کنید و برای ادامه نوبت بفرستید.
ساختاریافته response_format: text، json_object یا json_schema با نام schema و یک JSON schema. وقتی schema تنظیم شده باشد، آخرین پاسخ با آن مقایسه می‌شود و در گفتگو به‌عنوان مطابق یا نامطابق علامت می‌خورد. این تب روی endpoint مربوط به Messages خاموش است و گزینه‌ای که مدل انتخاب‌شده نمی‌پذیرد ارائه نمی‌شود.
کد درخواست گفتگوی فعلی به‌صورت کد cURL، Python، Node یا Go که از گفتگو و تنظیماتش ساخته می‌شود. کلید به‌صورت YOUR_API_KEY چاپ می‌شود. کد را می‌توان کپی کرد یا در نمای بزرگ باز کرد.
رویدادها آخرین نوبت همان‌طور که روی سیم رفت: هر رویداد stream با فاصله زمانی‌اش و یک فیلتر، پاسخ مونتاژشده، هدرهای پاسخ (x-request-id، content-type، retry-after، date) و بدنه درخواست. این‌ها تا بارگذاری دوباره صفحه نگه داشته می‌شوند.

بررسی ورودی‌ها

مقادیری که تایپ می‌کنید پیش از ارسال درخواست بررسی می‌شوند. مقدار خارج از بازه در همان فیلد علامت‌گذاری می‌شود و ارسال تا اصلاح آن متوقف می‌ماند.

تنظیم بررسی
حداکثر توکن‌های خروجی یک عدد صحیح از 1 تا max_output_tokens مدل.
Temperature یک عدد از 0 تا 2. خالی بودن فیلد را از درخواست حذف می‌کند.
top_p یک عدد از 0 تا 1. خالی بودن فیلد را از درخواست حذف می‌کند.
seed یک عدد صحیح.
توالی‌های توقف حداکثر 4 مورد، جداشده با کاما.
response_format باید یکی از مواردی باشد که مدل انتخاب‌شده می‌پذیرد. گفتگویی که به مدل بدون json_schema یا بدون response_format منتقل شود، همراه با دلیل نگه داشته می‌شود.
تصاویر وقتی به مدلی که فقط متن می‌پذیرد تغییر می‌دهید، همراه با یک یادداشت از پیام حذف می‌شوند.

مقایسه دو مدل

مقایسه دو مدل در منوی بیشتر یک انتخاب‌گر مدل دوم اضافه می‌کند. هر پیام آن‌گاه هم‌زمان و با همان تنظیمات به هر دو مدل می‌رود و دو پاسخ کنار هم، با علامت A و B، قرار می‌گیرند. می‌توانید فقط یک طرف را دوباره تولید کنید. وقتی یک طرف ابزاری فراخوانی کند، نتیجه‌ای که می‌فرستید فقط همان طرف را ادامه می‌دهد.

اشتراک‌گذاری، خروجی گرفتن و وارد کردن

  • کپی لینک اشتراک گفتگو را در خود لینک، در بخش بعد از #، بسته‌بندی می‌کند. چیزی آپلود نمی‌شود. تصاویر، کلید شما و جزئیات آخرین اجرا حذف می‌شوند. هر کسی که لینک را باز کند گفتگو را به‌صورت یک گفتگوی جدید در playground خودش می‌گیرد.
  • گفتگویی که برای لینک خیلی بلند باشد با یک یادداشت رد می‌شود. به‌جای آن آن را به‌صورت JSON دانلود کنید.
  • دانلود JSON گفتگو گفتگو را همراه تنظیماتش در یک فایل ذخیره می‌کند. وارد کردن JSON در پنل گفتگوها چنین فایلی را باز می‌کند.
  • کپی به‌عنوان cURL درخواست فعلی را به‌صورت یک دستور cURL کپی می‌کند.

چه چیزی کجا نگه داشته می‌شود

چه چیزی کجا نگه داشته می‌شود
گفتگوها، ابزارهای ذخیره‌شده، مدل‌های اخیر، چیدمان پنل‌ها در همین مرورگر. به Shannon فرستاده نمی‌شوند و با شما به دستگاه دیگر نمی‌آیند.
کلید API در حافظه تب باز. کلید چسبانده‌شده با بارگذاری دوباره صفحه یا بسته شدن تب از بین می‌رود. اگر وارد شده باشید، کلید هر بار از حساب شما خوانده می‌شود.
رویدادهای stream، هدرها و درخواست آخرین نوبت در صفحه باز، تا وقتی دوباره بارگذاری شود.
درخواست‌ها از مرورگر شما با کلید شما به API فرستاده می‌شوند. مثل هر درخواست دیگر API از موجودی شما کسر می‌شوند.

صفحه‌کلید

کلیدها چه می‌کند
Enter ارسال پیام.
Shift + Enter شروع یک خط جدید.
Ctrl + K باز کردن پالت دستورات: تغییر endpoint یا مدل، تنظیم یک قالب system، شروع گفتگوی جدید، تغییر وضعیت streaming، ابزارها یا مقایسه. در Mac: ⌘ K.
Esc متوقف کردن پاسخی که نوشته می‌شود، یا بستن پنل باز در صفحه باریک.

اجرای Playground