خروجی ساخت‌یافته

بررسی محتوا

متن یا تصویر را از نظر محتوای نامناسب بررسی کنید و برای هر ورودی پرچم و امتیاز دسته‌های خشونت، نفرت، آزار و مانند آن بگیرید.

POST/v1/moderations

این مسیر با قالب OpenAI کار می‌کند و برای هر ورودی یک results[i] با flagged، categories و category_scores می‌دهد. دسته‌ها: harassment، harassment/threatening، hate، hate/threatening، illicit، illicit/violent، self-harm، self-harm/intent، self-harm/instructions، sexual، sexual/minors، violence و violence/graphic.

سه شکل ورودی دارید:

  • یک رشته: یک نتیجه.
  • آرایه‌ی رشته (تا ۲۵۶ مورد): برای هر رشته یک نتیجه.
  • آرایه‌ی بخش‌ها (تا ۳۲ بخش) از نوع text و image_url: کل آرایه یک ورودی چندرسانه‌ای است و یک نتیجه می‌گیرد.

اگر model را نفرستید، مدل پیش‌فرض بررسی محتوا به کار می‌رود.

برخی مدل‌های بررسی محتوا از نوع «گارد» هستند (مانند Llama Guard). برای آن‌ها هر ورودی جداگانه از مدل پرسیده می‌شود و حکم safe یا unsafe به دسته‌های بالا تبدیل می‌شود. در نتیجه‌ی این مدل‌ها categories و category_scores فقط از کدهای خطر ساخته می‌شوند، امتیازها صفر یا یک‌اند و فیلد اضافه‌ی guard: { verdict, codes } هم می‌آید. هر درخواست به مدل گارد حداکثر ۱۶ ورودی می‌پذیرد، وگرنه خطای ۴۰۰ می‌گیرید.

نمونه‌ها

curl https://1ai.ir/v1/moderations \
  -H "Authorization: Bearer $ONEAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "model": "openai/omni-moderation-latest",
  "input": "I will find you and hurt you."
}'
200پاسخ
{
  "id": "modr-req_example",
  "model": "openai/omni-moderation-latest",
  "results": [
    {
      "flagged": true,
      "categories": {
        "harassment": true,
        "harassment/threatening": true,
        "hate": false,
        "violence": true,
        "sexual": false
      },
      "category_scores": {
        "harassment": 0.71,
        "harassment/threatening": 0.64,
        "hate": 0.002,
        "violence": 0.93,
        "sexual": 0.0001
      }
    }
  ]
}

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

  • modelstring

    شناسه‌ی مدل بررسی محتوا. بدون آن مدل پیش‌فرض به کار می‌رود.

  • inputstring | arrayالزامی

    ورودی: یک رشته، آرایه‌ی رشته (تا ۲۵۶، هر کدام تا ۲۰۰٬۰۰۰ نویسه) یا آرایه‌ی بخش‌ها (تا ۳۲).

    ویژگی‌های داخلی
    • typestring

      نوع بخش، فقط در آرایه‌ی بخش‌ها.

      مقادیر مجاز:textimage_url
    • textstring

      متن بخش، برای type: text.

    • image_urlobject

      برای type: image_url، شیئی با فیلد url (نشانی یا data URL تصویر).

خطاها

  • invalid_request400

    بدنه معتبر نیست، یا مدل گارد بیش از ۱۶ ورودی گرفته است (param: input).

  • model_kind_mismatch400

    مدل از دسته‌ی بررسی محتوا نیست.

  • insufficient_credits402

    اعتبار برای این درخواست کافی نیست.

  • model_not_found404

    مدل وجود ندارد یا به آن دسترسی ندارید.

صفحه‌های مرتبط