API ماڈلز

Rivya ماڈلز کی فہرست اور عوامی API کے لیے ان کی تیاری دیکھنے کے لیے GET /api/v1/models استعمال کریں۔

curl https://rivya.ai/api/v1/models

یہ نقطۂ اتصال عوامی اور صرف مطالعے کے لیے ہے۔ یہ وہی عوامی ماڈل تہہ لوٹاتا ہے جسے API دستاویزات اور آن لائن ڈیبگر استعمال کرتے ہیں۔

جواب کی ساخت

جواب کی ساخت یہ ہے:

{
  "object": "list",
  "data": [
    {
      "id": "z-image",
      "display_name": "Z-Image",
      "category": "image",
      "runtime": "async_task",
      "base_credits": 1,
      "billing_type": "FIXED",
      "supported_modes": ["text-to-image"],
      "max_prompt_length": 1000,
      "reference_media": null,
      "params": [],
      "api_status": "available",
      "api_input_status": "available_text",
      "supported_api_inputs": ["text"],
      "requires_files_api": false,
      "requires_upload_for_modes": [],
      "url_input_supported": false,
      "file_kinds": [],
      "chat_capabilities": null,
      "notices": []
    }
  ]
}

غیر ہم وقت تخلیقی ماڈلز کے لیے id کو POST /api/v1/generations میں model کی قدر کے طور پر استعمال کریں۔ چیٹ ماڈلز کے لیے Chat API استعمال کریں۔

دستیابی کی حالتیں

ماڈل حوالہ یہ عوامی حالتیں استعمال کرتا ہے:

• available: کم از کم ایک عوامی API تخلیقی راستہ دستیاب ہے

• temporarily_unavailable: ماڈل عارضی طور پر دستیاب نہیں اور فی الحال Public API v1 کے ذریعے استعمال نہیں کیا جا سکتا

• studio_only: ماڈل Studio یا مصنوعات کے کسی دوسرے حصے میں دستیاب ہے، Public API v1 کے ذریعے نہیں

ابتدائی مواد کی تیاری کا خانہ زیادہ مخصوص ہے:

• available_text: پرامپٹ پر مبنی درخواستیں براہ راست آزمائی جا سکتی ہیں

• available_url_input: عوامی URL یا عددی و متنی params براہ راست آزمائے جا سکتے ہیں

• partial_requires_files: کچھ طریقے اپ لوڈ کے بغیر استعمال ہو سکتے ہیں؛ حوالہ جاتی میڈیا والے طریقوں کو فائلز API استعمال کرنی چاہیے

• requires_files_api: ماڈل /api/v1/files سے آنے والے اپ لوڈ شدہ حوالہ جاتی میڈیا پر منحصر ہے

اپ لوڈ شدہ تصویر، ویڈیو یا آڈیو حوالہ مانگنے والے طریقے استعمال کرنے سے پہلے فائلز API استعمال کریں۔

گفتگویی ماڈلز کے لیے chat_capabilities بتاتا ہے کہ Chat API غیر مسلسل جوابات، مسلسل جوابات، ویب تلاش، تصویر کی file_id منسلکات، خیالات اور استدلال کی سطح کی معاونت کرتی ہے یا نہیں۔

ماڈلز کی تعداد کی پالیسی

عوامی ماڈلز کی فہرست بدلتی رہتی ہے کیونکہ Rivya ماڈل شامل، خارج یا محدود کرتا ہے۔

اپنے انضمام میں ہاتھ سے مقرر کی گئی ماڈلز کی تعداد پر انحصار نہ کریں۔ ہمیشہ /api/v1/models یا متحرک ماڈل API حوالہ پڑھیں۔

متعلقہ صفحات

• ماڈل API حوالہ

• تخلیقی درخواست بھیجیں

• Chat API

• Rivya میں ماڈل چننے کی رہنما

• Rivya میں ماڈل کی دستیابی

صرف پڑھنے کے لیے جلد آنے والی اندراجات

• coming_soon: ماڈل صرف دریافت کے لیے دکھایا جاتا ہے اور تخلیق یا Chat API کو نہیں بھیجا جا سکتا۔ یہ supports_direct_generation: false، عملی ماحول، بلنگ اور قیمت کے لیے null اور خالی supported_modes و params لوٹاتا ہے۔ درخواست کے لیے api_status: available منتخب کریں۔