تصمیم با سنجه

POSThttps://api.dana.expert/v1/decide

هدرها

Authorizationstringالزامی
کلید API از کنسول دانا: Authorization: Bearer dn-live-...
x-api-keystring
همان کلید، به‌جای هدر Authorization
Content-Typestringالزامی
مقدار: "application/json"

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

statestring | object | arrayالزامی
متنی که دربارهٔ آن تصمیم گرفته می‌شود: یک رشته، یا هر دادهٔ JSON؛ تا ۲۰٬۰۰۰ کاراکتر
questionsobjectالزامی
پرسش‌ها: هر کلید نامی است که خودتان می‌گذارید (مثل dept) و جواب با همین نام برمی‌گردد
۱ تا ۳۲ کلید
هر کلید در questions نامی است که خودتان می‌گذارید و مقدارش این فیلدها را دارد
- typestringالزامی
  نوع پرسش: choice یک گزینه از چند گزینه، noul بله یا خیر، score یک پله روی طیفی مرتب
  مقدارها: "choice""noul""score"
- instructionsstringالزامی
  متن پرسش؛ کوتاه و روشن، مثل «مربوط به کدام بخش است؟»
- criteriastring[] | object
  برای choice فهرست گزینه‌ها، یا شیئی از گزینه به توضیح آن؛ برای score پله‌ها از کم به زیاد؛ برای noul لازم نیست
modelstring
ghanari (قناری، سریع‌تر) یا kabootar (کبوتر، دقیق‌تر)
مقدارها: "ghanari""kabootar"پیش‌فرض: "ghanari"

پاسخ `200`

جواب هر پرسش

modelstringالزامی
مدلی که جواب داد: ghanari یا kabootar
model_versionstring
نسخهٔ همان مدل، مثل ghanari-ir-v0.1
answersobjectالزامی
جواب هر پرسش، با همان کلیدی که در questions فرستادید
هر کلید در answers نامی است که خودتان می‌گذارید و مقدارش این فیلدها را دارد
- typestringالزامی
  مقدارها: "choice""noul""score"
- choicestring
  برای choice: گزینهٔ برنده
- noulnumber
  برای noul: احتمال «بله»
  ۰ تا ۱
- scorenumber
  برای score: عددی از ۰ تا شمارهٔ آخرین پله
- legendobject
  برای score: نام هر پله
- probabilitiesobject
  احتمال هر گزینه یا پله
- confidencenumberالزامی
  اطمینان مدل به جوابش؛ تضمین درستی نیست
  ۰ تا ۱
usageobject
توکن‌هایی که خود مدل خواند؛ هزینه با شمارش gateway حساب می‌شود
فیلدهای usage
- input_tokensinteger
- output_tokensinteger
latency_msnumber
زمان پاسخ مدل به میلی‌ثانیه

خطاها

کد	یعنی
`400`	بدنهٔ درخواست درست نیست؛ پیام می‌گوید کدام فیلد
`401`	کلید نرسید یا شناخته نشد
`429`	سقف درخواست، ظرفیت یا اعتبار؛ `type` و `code` علت را می‌گویند
`503`	مدل همین حالا در دسترس نیست (`model_unavailable`)؛ چند دقیقه بعد دوباره بفرستید

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

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

curl -X POST https://api.dana.expert/v1/decide \
  -H "Authorization: Bearer $DANA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "سه روز است سفارشم را پرداخت کرده‌ام ولی هنوز ارسال نشده.",
    "questions": {
      "dept": {
        "type": "choice",
        "instructions": "مربوط به کدام بخش است؟",
        "criteria": [
          "مالی",
          "فنی",
          "ارسال کالا"
        ]
      },
      "complaint": {
        "type": "noul",
        "instructions": "آیا این پیام شکایت است؟"
      },
      "anger": {
        "type": "score",
        "instructions": "نویسنده چقدر عصبانی است؟",
        "criteria": [
          "آرام",
          "کمی ناراحت",
          "عصبانی"
        ]
      }
    }
  }'

import os

import requests

r = requests.post(
    "https://api.dana.expert/v1/decide",
    headers={"Authorization": f"Bearer {os.environ['DANA_API_KEY']}"},
    json={
        "state": "سه روز است سفارشم را پرداخت کرده‌ام ولی هنوز ارسال نشده.",
        "questions": {
            "dept": {
                "type": "choice",
                "instructions": "مربوط به کدام بخش است؟",
                "criteria": [
                    "مالی",
                    "فنی",
                    "ارسال کالا",
                ],
            },
            "complaint": {
                "type": "noul",
                "instructions": "آیا این پیام شکایت است؟",
            },
            "anger": {
                "type": "score",
                "instructions": "نویسنده چقدر عصبانی است؟",
                "criteria": [
                    "آرام",
                    "کمی ناراحت",
                    "عصبانی",
                ],
            },
        },
    },
    timeout=60,
)
print(r.json())

const r = await fetch("https://api.dana.expert/v1/decide", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.DANA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "state": "سه روز است سفارشم را پرداخت کرده‌ام ولی هنوز ارسال نشده.",
    "questions": {
      "dept": {
        "type": "choice",
        "instructions": "مربوط به کدام بخش است؟",
        "criteria": [
          "مالی",
          "فنی",
          "ارسال کالا"
        ]
      },
      "complaint": {
        "type": "noul",
        "instructions": "آیا این پیام شکایت است؟"
      },
      "anger": {
        "type": "score",
        "instructions": "نویسنده چقدر عصبانی است؟",
        "criteria": [
          "آرام",
          "کمی ناراحت",
          "عصبانی"
        ]
      }
    }
  }),
});
console.log(await r.json());

نمونهٔ پاسخ 200

{
  "model": "ghanari",
  "model_version": "ghanari-ir-v0.1",
  "answers": {
    "dept": {
      "type": "choice",
      "choice": "ارسال کالا",
      "probabilities": {
        "مالی": 0.0181,
        "فنی": 0.0203,
        "ارسال کالا": 0.9616
      },
      "confidence": 0.8278
    },
    "complaint": {
      "type": "noul",
      "noul": 0.9521,
      "confidence": 0.9521
    },
    "anger": {
      "type": "score",
      "score": 1.7202,
      "legend": {
        "0": "آرام",
        "1": "کمی ناراحت",
        "2": "عصبانی"
      },
      "probabilities": {
        "0": 0.0283,
        "1": 0.2232,
        "2": 0.7485
      },
      "confidence": 0.406
    }
  },
  "usage": {
    "input_tokens": 218,
    "output_tokens": 0
  },
  "latency_ms": 78.2
}

نمونهٔ خطا 401

{
  "error": {
    "message": "Invalid API key.",
    "type": "authentication_error",
    "param": null,
    "code": null
  }
}

تصمیم با سنجه

هدرها

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

پاسخ 200

خطاها

پاسخ `200`