مرجع › مستندات Jev

مرجع HTTP API

مرجع کامل endpoint ارزیابی TypeSafe.

آخرین به‌روزرسانی: مدل: jev-1.13.0 منبع بازبینی‌شده در منبع انگلیسی

یک state را در برابر نگاشتی از questions تایپ‌شده ارزیابی کنید و answers ساختاریافته بگیرید؛ یکی برای هر پرسش.

Endpoint ارزیابی

POST https://api.typesafe.ai/v1/systemone
Authorization: Bearer <API_KEY>
Content-Type: application/json

بدنه‌ی درخواست

statestring | object | arrayالزامی

محتوای مورد ارزیابی. رشته‌ی ساده برای متن، یا داده‌ی ساختاریافته برای لاگ‌های چت، رکوردها یا وضعیت فعلی اپلیکیشن. State را ببینید.

modelstring

مدلی که درخواست را پردازش می‌کند. از "jev-latest" استفاده کنید. مدل‌ها را ببینید.

questionsmap<string, Question>الزامی

نگاشتی از اشیای Question تایپ‌شده. کلیدها را خودتان انتخاب می‌کنید و پاسخ‌ها زیر همان کلیدها برمی‌گردند. کلید به مدل فرستاده نمی‌شود و در استنتاج استفاده نمی‌شود.

انواع Question

همه‌ی انواع type و instructions مشترک دارند و هر کدام criteria خودش را اضافه می‌کند. instructions می‌تواند رشته، شیء یا آرایه باشد؛ پرسش را در یک فیلد و داده را در فیلدهای دیگر بگذارید و با نام در بک‌تیک به آن ارجاع دهید.

type"noul"

پرسش بله/خیر؛ احتمال «بله» را برمی‌گرداند.

instructionsstring | object | array

پرسش بله/خیر برای ارزیابی.

criteria.true / criteria.falsestring | object | arrayاختیاری

معنای بله (مقدار نزدیک ۱) و خیر (نزدیک ۰).

{
  "state": "Help! My payouts have been failing for 3 days.",
  "model": "jev-latest",
  "questions": {
    "is_urgent": {
      "type": "noul",
      "instructions": "Does this convey urgency?",
      "criteria": {
        "true": "Explicitly time-sensitive",
        "false": "No urgency expressed"
      }
    }
  }
}

type"choice"

یک گزینه از مجموعه‌ای که تعریف می‌کنید؛ گزینه‌ی انتخاب‌شده و توزیع کامل احتمال را برمی‌گرداند.

instructionsstring | object | array

آنچه مدل باید تصمیم بگیرد.

criteriamap<string, string | object | array | null>

نگاشت گزینه به توصیف روبریک؛ برای گزینه‌ی بی‌نیاز از توضیح null. حداکثر ۲۵۵ گزینه.

{
  "state": "Help! My payouts have been failing for 3 days.",
  "model": "jev-latest",
  "questions": {
    "department": {
      "type": "choice",
      "instructions": "Which team should handle this?",
      "criteria": {
        "billing": "Payments, invoicing, refunds",
        "technical": "Bugs, outages, integrations",
        "sales": "Pricing, upgrades, new accounts"
      }
    }
  }
}

type"score"

رتبه‌دهی state روی روبریکی که تعریف می‌کنید؛ مقداری وزن‌دار با احتمال روی سطوح برمی‌گرداند.

instructionsstring | object | array

آنچه مدل باید رتبه دهد.

criteriaarray<string | object | array>

آرایه‌ی مرتب توصیف سطوح؛ دست‌کم ۲ و حداکثر ۱۰.

{
  "state": "Help! My payouts have been failing for 3 days.",
  "model": "jev-latest",
  "questions": {
    "frustration": {
      "type": "score",
      "instructions": "How frustrated is the customer?",
      "criteria": ["Calm", "Frustrated", "Very angry"]
    }
  }
}

بدنه‌ی پاسخ

modelstring

مدلی که ارزیابی را انجام داده (شناسه‌ی نسخه‌دار).

answersmap<string, Answer>

یک Answer برای هر پرسش، با همان کلیدهای questions.

usage{ input_tokens, output_tokens }

مصرف توکن درخواست.

انواع Answer

هر پاسخ یک type متناظر با پرسشش دارد. پاسخ‌های Choice و Score همچنین confidence بین ۰ و ۱ دارند.

{
  "model": "jev-1.13.0",
  "answers": {
    "is_urgent": {
      "type": "noul",
      "noul": 0.95
    }
  },
  "usage": { "input_tokens": 307, "output_tokens": 20 }
}

{
  "model": "jev-1.13.0",
  "answers": {
    "department": {
      "type": "choice",
      "choice": "billing",
      "probabilities": { "billing": 0.88, "technical": 0.12, "sales": 0.0 },
      "confidence": 0.81
    }
  },
  "usage": { "input_tokens": 318, "output_tokens": 34 }
}

{
  "model": "jev-1.13.0",
  "answers": {
    "frustration": {
      "type": "score",
      "score": 1.05,
      "legend": { "0": "Calm", "1": "Frustrated", "2": "Very angry" },
      "probabilities": { "0": 0.0, "1": 0.95, "2": 0.05 },
      "confidence": 0.92
    }
  },
  "usage": { "input_tokens": 304, "output_tokens": 18 }
}