مرجع توسعه‌دهندگان

EFARS API

Responses API

ساختار Responses برای مدل‌ها و ابزارهای سازگار با این عملیات.

راهنمای اتصال مشتریان
curl · Python · JavaScript

مسیر و شرایط استفاده

HTTP

POST https://efars.com/v1/responses
Authorization: Bearer YOUR_EFARS_API_KEY
Content-Type: application/json

Responses با Chat Completions متفاوت است. از مدل دارای پشتیبانی صریح این عملیات استفاده کنید؛ مدل Chat الزاماً Responses را پشتیبانی نمی‌کند. این مرجع نمونه ساختاری است و موفقیت مدل خاصی را ادعا نمی‌کند.

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

درخواست متنی

JSON

{
  "model": "RESPONSES_MODEL_NAME",
  "input": "سلام! لطفاً خودت را معرفی کن.",
  "max_output_tokens": 256,
  "stream": false
}
پارامترتوضیح
modelشناسه مدل سازگار و مجاز.
inputمتن یا ورودی ساختاری متناسب با قابلیت مدل.
max_output_tokensسقف توکن خروجی.
streamدریافت رویدادهای Responses در صورت پشتیبانی.

خواندن پاسخ

JSON

{
  "id": "resp-example",
  "object": "response",
  "status": "completed",
  "model": "RESPONSES_MODEL_NAME",
  "output": [
    {
      "type": "message",
      "role": "assistant",
      "content": [
        {
          "type": "output_text",
          "text": "سلام! چطور می‌توانم کمک کنم؟"
        }
      ]
    }
  ]
}

متن را از بلوک‌های output با type برابر message و content با type برابر output_text بخوانید. ابزارها و وضعیت incomplete را جدا مدیریت کنید. برای stream، رویدادهای Responses مانند response.output_text.delta و response.completed را پردازش کنید؛ parser مربوط به choices[].delta را به آن اعمال نکنید.

تاریخچه و سازگاری

وجود POST /v1/responses به معنی ارائه همه عملیات ذخیره، بازیابی، حذف پاسخ یا تمام ابزارهای hosted نیست. پیش از استفاده از قابلیت‌هایی مانند previous_response_id، ابزارها یا ورودی چندرسانه‌ای، پشتیبانی مدل و حساب را تأیید کنید. برای نمونه اتصال HTTP می‌توانید الگوی احراز هویت و مدیریت خطای صفحه Chat را با URL و بدنه همین صفحه به کار ببرید.