Chat Completions
مرجع درخواست و پاسخ OpenAI با مثالهای curl، Python و JavaScript.
آدرس و احراز هویت
HTTP
POST https://efars.com/v1/chat/completions
Authorization: Bearer YOUR_EFARS_API_KEY
Content-Type: application/jsonنمونهها آموزشیاند و حاصل اجرای زنده نیستند. YOUR_EFARS_API_KEY و نامهای ختمشونده به MODEL_NAME جاینگهدارند؛ پیش از اجرا، کلید ایفارس و مدل مجاز حساب خود را جایگزین کنید. مقادیر شناسه و مصرف در پاسخهای نمونه، گزارش مصرف واقعی نیستند.
پارامترهای درخواست
| پارامتر | نوع و الزام | توضیح |
|---|---|---|
| model | string · الزامی | شناسه دقیق مدل سازگار، از کاتالوگ حساب شما. |
| messages | array · الزامی | تاریخچه پیامها با role و content؛ برای متن ساده از system، user و assistant استفاده کنید. |
| stream | boolean · اختیاری | با true پاسخ بهصورت رویدادهای SSE ارسال میشود؛ پیشفرض false. |
| max_tokens | integer · اختیاری | سقف خروجی؛ پشتیبانی و نام پارامتر سقف خروجی را برای مدل انتخابی بررسی کنید. |
| temperature / top_p | number · اختیاری | کنترل نمونهگیری، در صورت پشتیبانی مدل. همه مدلها تمام پارامترها را نمیپذیرند. |
| tools / tool_choice | object / array · اختیاری | فراخوانی ابزار برای مدلهای دارای این قابلیت؛ برنامه شما مسئول اجرای ابزار است. |
ساختار درخواست
JSON
{
"model": "OPENAI_MODEL_NAME",
"messages": [
{
"role": "user",
"content": "سلام! لطفاً خودت را معرفی کن."
}
],
"max_tokens": 256,
"stream": false
}نمونه کد اتصال
این کدها برای محیط امن سمت سرور هستند. درخواست مصرفی را فقط پس از جایگزینی مدل و کلید و بررسی دسترسی و تعرفه ارسال کنید.
curl
# مدل جاینگهدار را با مدل مجاز حساب خود جایگزین کنید.
curl --fail-with-body 'https://efars.com/v1/chat/completions' \
-H "Authorization: Bearer ${EFARS_API_KEY}" \
-H "Content-Type: application/json" \
--data '{
"model": "OPENAI_MODEL_NAME",
"messages": [
{
"role": "user",
"content": "سلام! لطفاً خودت را معرفی کن."
}
],
"max_tokens": 256,
"stream": false
}'ساختار پاسخ
JSON
{
"id": "chatcmpl-example",
"object": "chat.completion",
"created": 0,
"model": "OPENAI_MODEL_NAME",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "سلام! من یک دستیار هوش مصنوعی هستم که از طریق API سازگار با OpenAI در ایفارس به درخواستهای شما پاسخ میدهم."
},
"finish_reason": "stop"
}
],
"usage": {
"prompt_tokens": 0,
"completion_tokens": 0,
"total_tokens": 0
}
}مسیر استخراج متن: choices[0].message.content. این نمونه فقط پاسخ متنی را نمایش میدهد؛ نوع بلوکها و علت پایان را پیش از خواندن متن بررسی کنید.
choices میتواند شامل پیام ابزار یا محتوای خالی باشد. finish_reason مانند stop، length یا tool_calls را پردازش کنید. usage آمار توکن را در صورت ارسال از سرویس نشان میدهد.