پاسخ API شامل یک آبجکت JSON با ساختار زیر است:
{
"object": "list",
"has_more": false,
"data": [
{
"id": "openai/gpt-4o",
"name": "GPT-4o",
"description": "مدل GPT-4o از OpenAI با قابلیت‌های متنی و تصویری و سرعت بالا.",
"pricing": {
"prompt": "5.00",
"completion": "15.00"
},
"context_length": 128000,
"architecture": "decoder",
"hosted_by": "openai",
"features": {
"tools": true,
"vision": true,
"json_mode": true,
"streaming": true
},
"tokenizer": "GPT",
"maxCompletionTokens": 4096,
"provider": {
"slug": "openai",
"name": "OpenAI"
},
"inputModalities": [
"text",
"image"
],
"huggingFaceId": null
},
{
"id": "anthropic/claude-3-opus",
"name": "Claude 3 Opus",
"description": "پیشرفته‌ترین مدل Claude 3 از Anthropic برای کارهای بسیار پیچیده.",
"pricing": {
"prompt": "15.00",
"completion": "75.00"
},
"context_length": 200000,
"architecture": "decoder",
"hosted_by": "anthropic",
"features": {
"tools": false,
"vision": true,
"json_mode": false,
"streaming": true
},
"tokenizer": "Anthropic",
"maxCompletionTokens": 4096,
"provider": {
"slug": "anthropic",
"name": "Anthropic"
},
"inputModalities": [
"text",
"image"
],
"huggingFaceId": null
}
]
}
فیلدهای اصلی پاسخ:
| فیلد | نوع | توضیحات |
|---|
| object | string | نوع آبجکت که همیشه `"list"` است. |
| has_more | boolean | نشان می‌دهد که آیا صفحات بیشتری از نتایج برای واکشی وجود دارد یا خیر (برای آینده در نظر گرفته شده و فعلاً معمولاً `false` است). |
| data | array | آرایه‌ای از آبجکت‌های مدل. هر آبجکت شامل جزئیات یک مدل خاص است. |
فیلدهای هر آبجکت مدل در آرایه :
| فیلد | نوع | توضیحات |
|---|
| id | string | شناسه منحصر به فرد جهانی مدل، معمولاً در فرمت `provider_slug/model_specific_slug`. مثال: `openai/gpt-4o` |
| name | string | نام قابل نمایش و کاربرپسند مدل. مثال: `GPT-4o` |
| description | string | توضیحات فارسی مدل که توسط ادمین پلتفرم راهیانا برای راهنمایی کاربران وارد شده است. |
| pricing.prompt | string | هزینه توکن‌های پرامپت (ورودی) به دلار آمریکا برای هر ۱ میلیون توکن. مثال: `"5.00"` |
| pricing.completion | string | هزینه توکن‌های تکمیل شده (خروجی) به دلار آمریکا برای هر ۱ میلیون توکن. مثال: `"15.00"` |
| context_length | integer | حداکثر طول زمینه (کانتکست) که مدل پشتیبانی می‌کند، بر حسب توکن. مثال: `128000` |
| architecture | string | معماری مدل (مثلاً `decoder`, `encoder-decoder`). مثال: `"decoder"` |
| hosted_by | string | اسلاگ ارائه‌دهنده اصلی مدل (مثلاً `openai`, `anthropic`). مثال: `"openai"` |
| features | object | آبجکتی شامل قابلیت‌های ویژه و پشتیبانی شده توسط مدل. |
| features.tools | boolean | آیا مدل از فراخوانی ابزار (tool calling / function calling) پشتیبانی می‌کند؟ |
| features.vision | boolean | آیا مدل از ورودی تصویر (vision capabilities) پشتیبانی می‌کند؟ |
| features.json_mode | boolean | آیا مدل از حالت JSON برای تضمین پاسخ‌دهی در فرمت JSON معتبر پشتیبانی می‌کند؟ |
| features.streaming | boolean | آیا مدل از استریمینگ پاسخ‌ها از طریق Server-Sent Events پشتیبانی می‌کند؟ |
| tokenizer | string | نوع توکنایزر استفاده شده توسط مدل (اطلاعاتی). مثال: `"GPT"`, `"Anthropic"` |
| maxCompletionTokens | integer | حداکثر تعداد توکن‌های تکمیلی که پلتفرم راهیانا اجازه تولید برای این مدل را می‌دهد (ممکن است با مقدار پیش‌فرض مدل متفاوت باشد). |
| provider | object | آبجکت شامل جزئیات ارائه‌دهنده مدل آنطور که در پلتفرم راهیانا تعریف شده است. |
| provider.slug | string | اسلاگ منحصر به فرد ارائه‌دهنده در راهیانا. مثال: `"openai"` |
| provider.name | string | نام نمایشی ارائه‌دهنده در راهیانا. مثال: `"OpenAI"` |
| inputModalities | array<string> | آرایه‌ای از انواع ورودی‌های پشتیبانی شده توسط مدل. مثال: `["text"]`, `["text", "image"]` |
| huggingFaceId | string | null | شناسه مدل در Hugging Face، در صورت وجود و مرتبط بودن (اختیاری). |