این راهنما تفاوت‌های کلیدی بین Chat Completions API و Responses API جدیدتر را توضیح می‌دهد.

چرا Responses API؟

Responses API جدیدترین API اصلی AvalAI است که سادگی Chat Completions را با توانایی انجام وظایف عامل‌محور (agentic) بیشتر ترکیب می‌کند. این API برای ساخت برنامه‌های کاربردی اقدام‌محور با ابزارهای داخلی مانند جستجوی وب، جستجوی فایل و استفاده از کامپیوتر طراحی شده است. اگر کاربر جدیدی هستید، استفاده از Responses API توصیه می‌شود.

Chat Completions API از بین نمی‌رود

Chat Completions API یک استاندارد صنعتی باقی می‌ماند و پشتیبانی از آن ادامه خواهد داشت. Responses API برای ساده‌سازی گردش‌کارهای مربوط به استفاده از ابزار، اجرای کد و مدیریت وضعیت مکالمه معرفی شده است.

تفاوت‌های کلیدی در کد و پاسخ

• ورودی: Chat Completions به آرایه `messages` نیاز دارد، Responses به `input` (رشته یا آرایه).
• خروجی: Chat Completions آرایه `choices` با شیء `message` را برمی‌گرداند. Responses یک شیء `response` تایپ‌شده با فیلد `output_text` یا `output` برمی‌گرداند.
• خروجی ساختاریافته: در Chat Completions از `response_format` استفاده می‌شود. در Responses از `text.format`.
• وضعیت مکالمه: در Chat Completions باید وضعیت را خودتان مدیریت کنید. Responses دارای `previous_response_id` است.
• جریان (Streaming): هر دو پشتیبانی می‌کنند، اما Responses API رویدادهای معنایی واضح‌تری دارد.

کدام API را انتخاب کنیم؟

• Chat Completions: برای تولید متن ساده، بدون نیاز به ابزارهای داخلی، کنترل کامل بر وضعیت.
• Responses API: برای ساخت عامل‌ها، استفاده از ابزارهای داخلی، گردش‌کارهای پیچیده، مدیریت آسان‌تر وضعیت.

برای جزئیات بیشتر به مستندات رسمی AvalAI مراجعه کنید.