Felo API PlatformFelo API Platform
v0.4.0
OpenAPI 3.1.0

ارسال تصمیم‌های ساختاریافته

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

ارسال تصمیم‌های ساختاریافته

​

درخواست حالت/پرسش بدون جریان‌سازی؛ پاسخ‌ها شکل Decisions را حفظ می‌کنند.

هدرها
  • X-Felo-Channel
    نوع: string

    کدهای کانال عمومی جداشده با کاما و مرتب‌شده. برای استفاده از default این هدر را حذف کنید؛ default باید به‌تنهایی استفاده شود. در حالت کیف پول، default ترتیب مؤثر کانال‌های عمومی مدل را به‌صورت معکوس بررسی می‌کند، کانال‌های منتشرنشده یا در دسترس نبودن را رد می‌کند و ارائه‌دهنده اولین کانال در دسترس را انتخاب می‌کند. نقاط پایانی در دسترس آن ارائه‌دهنده با همان شناسه مدل بالادست و سطح سرویس را شامل می‌شود. کانال‌های صریح به ترتیب مشخص‌شده توسط کلاینت اعتبارسنجی می‌شوند؛ فقط گروه ارائه‌دهنده اولین کانال ارسال می‌شود. هیچ بازگشت خودکار به ارائه‌دهندگان دیگر وجود ندارد. هدرهای ارائه‌دهنده قدیمی نمی‌توانند مسیریابی کانال را بازنویسی کنند.

بدنه·DecisionsRequest
الزامی
application/json

Decisions بدون جریان‌سازی؛ تعریف‌های پرسش بدون تغییر عبور می‌کنند.

  • model
    نوع: string
    الزامی
  • questions
    نوع: object
    الزامی
    • propertyName
      نوع: object
  • state
    الزامی
  • service_tier
    نوع: string | null

    در حال حاضر فقط default (استاندارد) پشتیبانی می‌شود. مقادیر حذف‌شده، null، نام‌های مستعار و رشته‌های پشتیبانی‌نشده به default بازمی‌گردند؛ انواع دیگر HTTP 400 برمی‌گردانند. کانال‌ها و قیمت‌های پیکربندی‌شده بدون تغییر می‌مانند. APIهای متنی مقدار استاندارد ارائه‌دهنده را ارسال می‌کنند؛ APIهای Decisions و تولید فیلد بالادست را حذف می‌کنند.

  • stream
    نوع: const
    مقدار ثابت:  
    false
  • propertyName
    نوع: anything
پاسخ‌ها
  • 200
    نوع: object · DecisionsResponse

    پاسخ‌های تصمیم

    • answers
      نوع: object
      • propertyName
        نوع: anything
    • id
      نوع: string
    • usage
      نوع: object
      • propertyName
        نوع: anything
    • propertyName
      نوع: anything
    application/json
  • 400
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
  • 401
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
  • 402
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
  • 403
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
  • 429
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
  • 502
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
  • 503
    نوع: object · DecisionsErrorResponse

    درخواست رد شد یا بالادست در دسترس نیست

    • error
      نوع: object
      الزامی
      • code
        نوع: integer
        الزامی

        Integer numbers.

      • message
        نوع: string
        الزامی
    application/json
Request Example for post/api/v1/decisions
curl https://openapi.felo.ai/api/v1/decisions \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "model": "configured-decisions-model",
  "state": "A payout failed.",
  "questions": {
    "urgent": {
      "type": "noul",
      "instructions": "Is it urgent?",
      "criteria": {
        "true": "Urgent",
        "false": "No"
      }
    }
  }
}'
{
  "id": "string",
  "answers": {
    "additionalProperty": "anything"
  },
  "usage": {
    "additionalProperty": "anything"
  },
  "additionalProperty": "anything"
}
Submit structured decisions