Chat Completions

رابط سازگار با OpenAI برای گفت‌وگو با هما ("model": "homa"). خروجی هر پاسخ تا ۴٬۰۹۶ توکن است و ورودی و خروجی روی هم تا ۸٬۱۹۲ توکن.

POSThttps://api.dana.expert/v1/chat/completions

هدرها

  • Authorizationstringالزامی

    کلید API از کنسول دانا: Authorization: Bearer dn-live-...

  • x-api-keystring

    همان کلید، به‌جای هدر Authorization

  • Content-Typestringالزامی

    مقدار: "application/json"

بدنهٔ درخواست

  • modelstringالزامی

    شناسهٔ مدل: homa

  • messagesobject[]الزامی

    تاریخچهٔ گفت‌وگو

    فیلدهای هر عضو messages
    • rolestringالزامی

      مقدارها: "system""user""assistant""tool"

    • contentstring | object[]الزامی

      متن پیام یا فهرست بخش‌ها

  • max_tokensinteger

    سقف توکن خروجی؛ پیش‌فرض و حداکثر ۴٬۰۹۶. عدد بزرگ‌تر به ۴٬۰۹۶ کم می‌شود

    پیش‌فرض: 4096حداکثر ۴٬۰۹۶

  • temperaturenumber

    ۰ تا ۲

  • top_pnumber
  • streamboolean

    true یعنی پاسخ استریم با SSE

    پیش‌فرض: false

  • stopstring | string[]
  • toolsobject[]

    ابزارها با ساختار OpenAI

  • tool_choiceany

    انتخاب ابزار با ساختار OpenAI

پاسخ 200

پاسخ هما، با ساختار OpenAI

  • idstring
  • objectstring

    مقدار: "chat.completion"

  • createdinteger
  • modelstring
  • choicesobject[]
    فیلدهای هر عضو choices
    • indexinteger
    • messageobject
      فیلدهای message
      • rolestringالزامی

        مقدارها: "system""user""assistant""tool"

      • contentstring | object[]الزامی

        متن پیام یا فهرست بخش‌ها

    • finish_reasonstring
  • usageobject
    فیلدهای usage
    • prompt_tokensintegerالزامی

      توکن‌های ورودی

    • completion_tokensintegerالزامی

      توکن‌های خروجی

    • total_tokensintegerالزامی

      جمع دو عدد بالا

هدرهای پاسخ

  • x-dana-cold-startstring

    1 وقتی هما پیش از این جواب در حافظه بارگذاری شد؛ چنین پاسخی چند ثانیه بیشتر طول کشیده است. در بقیهٔ پاسخ‌ها نمی‌آید.

خطاها

کدیعنی
400بدنهٔ درخواست درست نیست؛ پیام می‌گوید کدام فیلد
401کلید نرسید یا شناخته نشد
429سقف درخواست، ظرفیت یا اعتبار؛ type و code علت را می‌گویند
503model_unavailable: هما همین حالا در دسترس نیست؛ چند دقیقه بعد دوباره بفرستید. coming_soon: شناسهٔ مدلی جز homa خواسته‌اید که هنوز باز نیست

همهٔ کدها، علت و راه‌حل هرکدام در خطاها آمده است.