Gemini API

رابط برنامه‌نویسی کاربردی Gemini Interactions یک رابط برنامه‌نویسی کاربردی آزمایشی است که به توسعه‌دهندگان اجازه می‌دهد تا با استفاده از مدل‌های Gemini، برنامه‌های هوش مصنوعی مولد بسازند. Gemini توانمندترین مدل ما است که از پایه برای چندوجهی بودن ساخته شده است. این مدل می‌تواند انواع مختلف اطلاعات از جمله زبان، تصاویر، صدا، ویدئو و کد را تعمیم داده و به طور یکپارچه درک کند، در میان آنها عمل کند و ترکیب کند. می‌توانید از API Gemini برای موارد استفاده مانند استدلال در متن و تصاویر، تولید محتوا، عامل‌های گفتگو، سیستم‌های خلاصه‌سازی و طبقه‌بندی و موارد دیگر استفاده کنید.

ایجاد تعامل

ارسال به آدرس https://generativelanguage.googleapis.com/v1beta/interactions

یک تعامل جدید ایجاد می‌کند.

درخواست بدنه

بدنه درخواست شامل داده‌هایی با ساختار زیر است:

مدل ModelOption (اختیاری)

نام «مدل» مورد استفاده برای تولید تعامل.
در صورت عدم ارائه «عامل»، الزامی است.

مقادیر ممکن:

  • gemini-2.5-pro

    مدل چندمنظوره پیشرفته ما، که در کدنویسی و کارهای استدلالی پیچیده عالی عمل می‌کند.

  • gemini-2.5-flash

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

  • gemini-2.5-flash-preview-09-2025

    آخرین مدل مبتنی بر مدل فلش ۲.۵. پیش‌نمایش فلش ۲.۵ برای پردازش در مقیاس بزرگ، وظایف با تأخیر کم و حجم بالا که نیاز به تفکر دارند و موارد استفاده عامل‌محور بهترین گزینه است.

  • gemini-2.5-flash-lite

    کوچکترین و مقرون به صرفه ترین مدل ما، ساخته شده برای استفاده در مقیاس بزرگ.

  • gemini-2.5-flash-lite-preview-09-2025

    جدیدترین مدل مبتنی بر Gemini 2.5 Flash lite که برای صرفه‌جویی در هزینه، توان عملیاتی بالا و کیفیت بالا بهینه شده است.

  • gemini-2.5-flash-preview-native-audio-dialog

    مدل‌های صوتی بومی ما برای خروجی‌های صوتی با کیفیت بالاتر با ریتم بهتر، طبیعی بودن صدا، پرگویی و حس و حال بهتر بهینه شده‌اند.

  • gemini-2.5-flash-image-preview

    مدل تولید تصویر بومی ما، که برای سرعت، انعطاف‌پذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه می‌شود.

  • gemini-2.5-pro-preview-tts

    مدل صوتی متن به گفتار نسخه ۲.۵ پرو ما برای تولید گفتار قدرتمند و با تأخیر کم بهینه شده است تا خروجی‌های طبیعی‌تر و هدایت آسان‌تر دستورات را فراهم کند.

  • gemini-3-pro-preview

    هوشمندترین مدل ما با استدلال SOTA و درک چندوجهی، و قابلیت‌های قدرتمند کدگذاری عاملی و ارتعاشی.

مدلی که اعلان شما را تکمیل می‌کند.\n\nبرای جزئیات بیشتر به [models](https://ai.google.dev/gemini-api/docs/models) مراجعه کنید.

گزینه عامل (اختیاری)

نام «عامل» مورد استفاده برای ایجاد تعامل.
در صورت عدم ارائه «مدل»، الزامی است.

مقادیر ممکن:

  • deep-research-pro-preview-12-2025

    نماینده تحقیقات عمیق جمینی

عاملی که باید با آن تعامل داشت.

ورودی محتوا یا آرایه ( Content ) یا آرایه ( Turn ) یا رشته ( الزامی )

ورودی‌های تعامل (مشترک برای مدل و عامل).

رشته system_instruction (اختیاری)

دستورالعمل سیستم برای تعامل.

آرایه ابزارها ( ابزار ) (اختیاری)

فهرستی از اعلان‌های ابزار که مدل ممکن است در طول تعامل فراخوانی کند.

شیء response_format (اختیاری)

تأکید می‌کند که پاسخ تولید شده یک شیء JSON است که با طرحواره JSON مشخص شده در این فیلد مطابقت دارد.

رشته response_mime_type (اختیاری)

نوع MIME پاسخ. در صورت تنظیم response_format، این مورد الزامی است.

جریان بولی (اختیاری)

فقط ورودی. اینکه آیا تعامل پخش زنده خواهد شد یا خیر.

ذخیره بولی (اختیاری)

فقط ورودی. آیا پاسخ و درخواست برای بازیابی بعدی ذخیره شود یا خیر.

مقدار بولی پس‌زمینه (اختیاری)

اینکه آیا تعامل مدل در پس‌زمینه اجرا شود یا خیر.

generation_config GenerationConfig (اختیاری)

پیکربندی مدل
پارامترهای پیکربندی برای تعامل مدل.
جایگزینی برای `agent_config`. فقط زمانی قابل اجرا است که `model` تنظیم شده باشد.

پارامترهای پیکربندی برای تعاملات مدل.

فیلدها

عدد دما (اختیاری)

تصادفی بودن خروجی را کنترل می‌کند.

شماره top_p (اختیاری)

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

عدد صحیح اولیه (اختیاری)

بذر مورد استفاده در رمزگشایی برای تکرارپذیری.

آرایه stop_sequences (رشته) (اختیاری)

فهرستی از توالی‌های کاراکتری که تعامل خروجی را متوقف می‌کنند.

tool_choice انتخاب ابزار (اختیاری)

انتخاب ابزار برای تعامل.

پیکربندی برای انتخاب ابزار.

انواع ممکن

نوع انتخاب ابزار

این نوع فیلد خاصی ندارد.

پیکربندی انتخاب ابزار

ابزارهای مجاز (اختیاری)

هیچ توضیحی ارائه نشده است.

پیکربندی ابزارهای مجاز.

فیلدها

حالت انتخاب ابزار (اختیاری)

حالت انتخاب ابزار.

مقادیر ممکن:

  • auto
  • any
  • none
  • validated

آرایه ابزار (رشته) (اختیاری)

نام ابزارهای مجاز

سطح_فکریسطح_فکری ( اختیاری )

سطح توکن‌های فکری که مدل باید تولید کند.

مقادیر ممکن:

  • low
  • high

خلاصه‌های تفکر ( اختیاری)

اینکه آیا خلاصه نظرات در پاسخ گنجانده شود یا خیر.

مقادیر ممکن:

  • auto
  • none

عدد صحیح max_output_tokens (اختیاری)

حداکثر تعداد توکن‌هایی که باید در پاسخ گنجانده شوند.

speech_config SpeechConfig (اختیاری)

پیکربندی برای تعامل گفتاری.

پیکربندی برای تعامل گفتاری.

فیلدها

رشته صدا (اختیاری)

صدای گوینده.

رشته زبان (اختیاری)

زبان گفتار.

سیم بلندگو (اختیاری)

نام گوینده، باید با نام گوینده داده شده در سوال مطابقت داشته باشد.

شیء agent_config (اختیاری)

پیکربندی عامل
پیکربندی برای عامل.
جایگزینی برای `generation_config`. فقط زمانی قابل اجرا است که `agent` تنظیم شده باشد.

انواع ممکن

تفکیک‌کننده چندریختی: type

پیکربندی DynamicAgent

پیکربندی برای عامل‌های پویا

نوع رشته (اختیاری)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "dynamic" تنظیم شود.

پیکربندی DeepResearchAgent

پیکربندی برای عامل تحقیقات عمیق.

نوع رشته (اختیاری)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "deep-research" تنظیم شود.

خلاصه‌های تفکر ( اختیاری)

اینکه آیا خلاصه نظرات در پاسخ گنجانده شود یا خیر.

مقادیر ممکن:

  • auto
  • none

رشته‌ی previous_interaction_id (اختیاری)

شناسه‌ی تعامل قبلی، در صورت وجود.

روش_پاسخ ( اختیاری )

روش‌های درخواستی برای پاسخ (متن، تصویر، صدا).

مقادیر ممکن:

  • text
  • image
  • audio

پاسخ

یک منبع تعامل (Interaction) را برمی‌گرداند.

درخواست ساده

پاسخ نمونه

{
  "created": "2025-11-26T12:25:15Z",
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-2.5-flash",
  "object": "interaction",
  "outputs": [
    {
      "text": "Hello! I'm functioning perfectly and ready to assist you.\n\nHow are you doing today?",
      "type": "text"
    }
  ],
  "role": "model",
  "status": "completed",
  "updated": "2025-11-26T12:25:15Z",
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 7
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 7,
    "total_output_tokens": 20,
    "total_reasoning_tokens": 22,
    "total_tokens": 49,
    "total_tool_use_tokens": 0
  }
}

چند نوبتی

پاسخ نمونه

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-2.5-flash",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "The capital of France is Paris."
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 50
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 50,
    "total_output_tokens": 10,
    "total_reasoning_tokens": 0,
    "total_tokens": 60,
    "total_tool_use_tokens": 0
  }
}

ورودی تصویر

پاسخ نمونه

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-2.5-flash",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "A white humanoid robot with glowing blue eyes stands holding a red skateboard."
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 10
      },
      {
        "modality": "image",
        "tokens": 258
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 268,
    "total_output_tokens": 20,
    "total_reasoning_tokens": 0,
    "total_tokens": 288,
    "total_tool_use_tokens": 0
  }
}

فراخوانی تابع

پاسخ نمونه

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-2.5-flash",
  "status": "requires_action",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "function_call",
      "function_call": {
        "name": "get_weather",
        "arguments": {
          "location": "Boston, MA"
        }
      }
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 100
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 100,
    "total_output_tokens": 25,
    "total_reasoning_tokens": 0,
    "total_tokens": 125,
    "total_tool_use_tokens": 50
  }
}

تحقیقات عمیق

پاسخ نمونه

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "agent": "deep-research-pro-preview-12-2025",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:22:47Z",
  "updated": "2025-11-26T12:22:47Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "Here is a comprehensive research report on the current state of cancer research..."
    }
  ],
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 20
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 20,
    "total_output_tokens": 1000,
    "total_reasoning_tokens": 500,
    "total_tokens": 1520,
    "total_tool_use_tokens": 0
  }
}

بازیابی یک تعامل

دریافت کنید https://generativelanguage.googleapis.com/v1beta/interactions/{id}

جزئیات کامل یک تعامل واحد را بر اساس `Interaction.id` آن بازیابی می‌کند.

پارامترهای مسیر/پرس‌وجو

رشته شناسه (الزامی)

شناسه منحصر به فرد تعاملی که قرار است بازیابی شود.

جریان بولی (اختیاری)

اگر روی درست تنظیم شود، محتوای تولید شده به صورت تدریجی پخش می‌شود.

پیش‌فرض: False

رشته last_event_id (اختیاری)

اختیاری. در صورت تنظیم، جریان تعامل را از بخش بعدی پس از رویداد مشخص شده توسط شناسه رویداد از سر می‌گیرد. فقط در صورتی قابل استفاده است که `stream` برابر با true باشد.

رشته api_version (اختیاری)

از کدام نسخه API استفاده کنیم.

پاسخ

یک منبع تعامل (Interaction) را برمی‌گرداند.

تعامل دریافت کنید

پاسخ نمونه

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-2.5-flash",
  "status": "completed",
  "object": "interaction",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z",
  "role": "model",
  "outputs": [
    {
      "type": "text",
      "text": "I'm doing great, thank you for asking! How can I help you today?"
    }
  ]
}

حذف یک تعامل

https://generativelanguage.googleapis.com/v1beta/interactions/{id} را حذف کنید

تعامل را بر اساس شناسه حذف می‌کند.

پارامترهای مسیر/پرس‌وجو

رشته شناسه (الزامی)

شناسه منحصر به فرد تعاملی که باید حذف شود.

رشته api_version (اختیاری)

از کدام نسخه API استفاده کنیم.

پاسخ

در صورت موفقیت، پاسخ خالی است.

حذف تعامل

لغو یک تعامل

ارسال https://generativelanguage.googleapis.com/v1beta/interactions/{id}/cancel

یک تعامل را بر اساس شناسه لغو می‌کند. این فقط برای تعاملات پس‌زمینه‌ای که هنوز در حال اجرا هستند، اعمال می‌شود.

پارامترهای مسیر/پرس‌وجو

رشته شناسه (الزامی)

شناسه منحصر به فرد تعاملی که قرار است بازیابی شود.

رشته api_version (اختیاری)

از کدام نسخه API استفاده کنیم.

پاسخ

یک منبع تعامل (Interaction) را برمی‌گرداند.

لغو تعامل

پاسخ نمونه

{
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "agent": "deep-research-pro-preview-12-2025",
  "status": "cancelled",
  "object": "interaction",
  "created": "2025-11-26T12:25:15Z",
  "updated": "2025-11-26T12:25:15Z",
  "role": "model"
}

منابع

تعامل

منبع تعامل.

فیلدها

مدل ModelOption (اختیاری)

نام «مدل» مورد استفاده برای تولید تعامل.

مقادیر ممکن:

  • gemini-2.5-pro

    مدل چندمنظوره پیشرفته ما، که در کدنویسی و کارهای استدلالی پیچیده عالی عمل می‌کند.

  • gemini-2.5-flash

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

  • gemini-2.5-flash-preview-09-2025

    آخرین مدل مبتنی بر مدل فلش ۲.۵. پیش‌نمایش فلش ۲.۵ برای پردازش در مقیاس بزرگ، وظایف با تأخیر کم و حجم بالا که نیاز به تفکر دارند و موارد استفاده عامل‌محور بهترین گزینه است.

  • gemini-2.5-flash-lite

    کوچکترین و مقرون به صرفه ترین مدل ما، ساخته شده برای استفاده در مقیاس بزرگ.

  • gemini-2.5-flash-lite-preview-09-2025

    جدیدترین مدل مبتنی بر Gemini 2.5 Flash lite که برای صرفه‌جویی در هزینه، توان عملیاتی بالا و کیفیت بالا بهینه شده است.

  • gemini-2.5-flash-preview-native-audio-dialog

    مدل‌های صوتی بومی ما برای خروجی‌های صوتی با کیفیت بالاتر با ریتم بهتر، طبیعی بودن صدا، پرگویی و حس و حال بهتر بهینه شده‌اند.

  • gemini-2.5-flash-image-preview

    مدل تولید تصویر بومی ما، که برای سرعت، انعطاف‌پذیری و درک متنی بهینه شده است. ورودی و خروجی متن با همان قیمت ۲.۵ فلش ارائه می‌شود.

  • gemini-2.5-pro-preview-tts

    مدل صوتی متن به گفتار نسخه ۲.۵ پرو ما برای تولید گفتار قدرتمند و با تأخیر کم بهینه شده است تا خروجی‌های طبیعی‌تر و هدایت آسان‌تر دستورات را فراهم کند.

  • gemini-3-pro-preview

    هوشمندترین مدل ما با استدلال SOTA و درک چندوجهی، و قابلیت‌های قدرتمند کدگذاری عاملی و ارتعاشی.

مدلی که اعلان شما را تکمیل می‌کند.\n\nبرای جزئیات بیشتر به [models](https://ai.google.dev/gemini-api/docs/models) مراجعه کنید.

گزینه عامل (اختیاری)

نام «عامل» مورد استفاده برای ایجاد تعامل.

مقادیر ممکن:

  • deep-research-pro-preview-12-2025

    نماینده تحقیقات عمیق جمینی

عاملی که باید با آن تعامل داشت.

رشته شناسه (اختیاری)

فقط خروجی. یک شناسه منحصر به فرد برای تکمیل تعامل.

شمارش وضعیت (رشته) (اختیاری)

فقط خروجی. وضعیت تعامل.

مقادیر ممکن:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
رشته ایجاد شده (اختیاری)

فقط خروجی. زمانی که پاسخ در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) ایجاد شده است.

رشته به‌روزرسانی‌شده (اختیاری)

فقط خروجی. زمانی که پاسخ آخرین بار در قالب ISO 8601 (YYYY-MM-DDThh:mm:ssZ) به‌روزرسانی شده است.

رشته نقش (اختیاری)

فقط خروجی. نقش تعامل.

خروجی آرایه ( محتوا ) (اختیاری)

فقط خروجی. پاسخ‌ها از مدل.

رشته شیء (اختیاری)

فقط خروجی. نوع شیء تعامل. همیشه روی `interaction` تنظیم شود.

همیشه روی "interaction" تنظیم شود.

کاربرد (اختیاری )

فقط خروجی. آمار مربوط به میزان استفاده از توکن درخواست تعامل.

آمار مربوط به میزان استفاده از توکن درخواست تعامل.

فیلدها

عدد صحیح total_input_tokens (اختیاری)

تعداد توکن‌ها در اعلان (زمینه).

ورودی_توکن‌ها_براساس_مودالیتی توکن‌های مودالیتی (اختیاری)

تفکیک استفاده از توکن ورودی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن:

  • text
  • image
  • audio

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

عدد صحیح total_cached_tokens (اختیاری)

تعداد توکن‌ها در بخش ذخیره‌شده‌ی اعلان (محتوای ذخیره‌شده).

cached_tokens_by_modality توکن‌های مودالیتی (اختیاری)

تفکیک میزان استفاده از توکن‌های ذخیره‌شده بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن:

  • text
  • image
  • audio

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

total_output_tokens عدد صحیح (اختیاری)

تعداد کل توکن‌ها در تمام پاسخ‌های تولید شده.

خروجی_توکن‌ها_براساس_مودالیتی توکن‌های مودالیتی (اختیاری)

تفکیک استفاده از توکن خروجی بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن:

  • text
  • image
  • audio

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

عدد صحیح total_tool_use_tokens (اختیاری)

تعداد توکن‌های موجود در اعلان(های) استفاده از ابزار.

ابزار_استفاده_از_توکن‌ها_توسط_مودالیتی توکن‌های مودالیتی (اختیاری)

تفکیک میزان استفاده از توکن‌های ابزار بر اساس روش.

تعداد توکن‌ها برای یک روش پاسخ واحد.

فیلدها

روش پاسخ (اختیاری)

روش مرتبط با شمارش توکن‌ها.

مقادیر ممکن:

  • text
  • image
  • audio

عدد صحیح توکن (اختیاری)

تعداد توکن‌ها برای روش.

total_reasoning_tokens عدد صحیح (اختیاری)

تعداد توکن‌های افکار برای مدل‌های تفکر.

عدد صحیح total_tokens (اختیاری)

تعداد کل توکن‌ها برای درخواست تعامل (درخواست + پاسخ‌ها + سایر توکن‌های داخلی).

رشته‌ی previous_interaction_id (اختیاری)

شناسه‌ی تعامل قبلی، در صورت وجود.

مثال‌ها

مثال

{
  "created": "2025-12-04T15:01:45Z",
  "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
  "model": "gemini-2.5-flash",
  "object": "interaction",
  "outputs": [
    {
      "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?",
      "type": "text"
    }
  ],
  "role": "model",
  "status": "completed",
  "updated": "2025-12-04T15:01:45Z",
  "usage": {
    "input_tokens_by_modality": [
      {
        "modality": "text",
        "tokens": 7
      }
    ],
    "total_cached_tokens": 0,
    "total_input_tokens": 7,
    "total_output_tokens": 23,
    "total_reasoning_tokens": 49,
    "total_tokens": 79,
    "total_tool_use_tokens": 0
  }
}

مدل‌های داده

محتوا

محتوای پاسخ.

انواع ممکن

تفکیک‌کننده چندریختی: type

محتوای متن

یک بلوک محتوای متنی.

رشته متن (اختیاری)

محتوای متن.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "text" تنظیم شود.

حاشیه‌نویسی‌ها ( اختیاری )

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

فیلدها

عدد صحیح start_index (اختیاری)

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

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته منبع (اختیاری)

منبعی که برای بخشی از متن ذکر شده است. می‌تواند یک URL، عنوان یا شناسه دیگری باشد.

محتوای تصویر

یک بلوک محتوای تصویر.

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

mime_type ImageMimeTypeOption (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif

نوع مایم تصویر.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "image" تنظیم شود.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن:

  • low
  • medium
  • high

محتوای صوتی

یک بلوک محتوای صوتی.

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

گزینه mime_type AudioMimeType (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac

نوع مایم صدا.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "audio" تنظیم شود.

محتوای سند

یک بلوک محتوای سند.

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته mime_type (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "document" تنظیم شود.

محتوای ویدیویی

یک بلوک محتوای ویدیویی.

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

mime_type گزینه VideoMimeType (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • video/mp4
  • video/mpeg
  • video/mov
  • video/avi
  • video/x-flv
  • video/mpg
  • video/webm
  • video/wmv
  • video/3gpp

نوع میم (شبیه‌سازی) ویدیو.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "video" تنظیم شود.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن:

  • low
  • medium
  • high

محتوای فکری

یک بلوک محتوای فکری.

رشته امضا (اختیاری)

امضا برای مطابقت با منبع backend تا بخشی از نسل باشد.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "thought" تنظیم شود.

خلاصه افکار (اختیاری)

خلاصه‌ای از اندیشه.

خلاصه‌ای از اندیشه.

محتوای فراخوانی تابع

یک بلوک محتوای فراخوانی ابزار تابع.

رشته نام (الزامی)

نام ابزاری که باید فراخوانی شود.

شیء آرگومان‌ها (الزامی)

آرگومان‌هایی که باید به تابع ارسال شوند.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "function_call" تنظیم شود.

رشته شناسه (الزامی)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

محتوای نتیجه تابع

یک بلوک محتوای نتیجه ابزار تابع.

رشته نام (اختیاری)

نام ابزاری که نامیده شد.

is_error نوع داده بولی (اختیاری)

اینکه آیا فراخوانی ابزار منجر به خطا شده است یا خیر.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "function_result" تنظیم شود.

شیء یا رشته نتیجه (الزامی)

نتیجه فراخوانی ابزار.

رشته call_id (الزامی)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت دارد.

اجرای کدفراخوانی محتوا

محتوای اجرای کد.

آرگومان‌های CodeExecutionCallArguments (اختیاری)

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

فیلدها

شمارش زبان (رشته) (اختیاری)

زبان برنامه‌نویسی «کد».

مقادیر ممکن:

  • python
رشته کد (اختیاری)

کدی که قرار است اجرا شود.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "code_execution_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

محتوای نتیجه اجرای کد

محتوای نتیجه اجرای کد.

رشته نتیجه (اختیاری)

خروجی اجرای کد.

is_error نوع داده بولی (اختیاری)

اینکه آیا اجرای کد منجر به خطا شده است یا خیر.

رشته امضا (اختیاری)

یک هش امضا برای اعتبارسنجی backend.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "code_execution_result" تنظیم شود.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی اجرای کد مطابقت دارد.

محتوا

محتوای زمینه URL.

آرگومان‌های UrlContextCallArguments (اختیاری)

آرگومان‌هایی که باید به متن URL ارسال شوند.

آرگومان‌هایی که باید به متن URL ارسال شوند.

فیلدها

آرایه آدرس‌های اینترنتی (رشته‌ای) (اختیاری)

آدرس‌های اینترنتی (URL) برای دریافت.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "url_context_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

محتوای نتیجه‌ی URL

محتوای نتیجه‌ی زمینه‌ی URL.

رشته امضا (اختیاری)

امضای نتیجه‌ی زمینه‌ی URL.

نتیجه UrlContextResult (اختیاری)

نتایج حاصل از متن URL.

نتیجه‌ی زمینه‌ی URL.

فیلدها

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL) که دریافت شده است.

شمارش وضعیت (رشته) (اختیاری)

وضعیت بازیابی URL.

مقادیر ممکن:

  • success
  • error
  • paywall
  • unsafe
is_error نوع داده بولی (اختیاری)

اینکه آیا زمینه URL منجر به خطا شده است یا خیر.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "url_context_result" تنظیم شود.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی زمینه‌ی url مطابقت دارد.

جستجوی گوگل، محتوای تماس

محتوای جستجوی گوگل

آرگومان‌های GoogleSearchCallArguments (اختیاری)

آرگومان‌هایی که باید به جستجوی گوگل ارسال شوند.

آرگومان‌هایی که باید به جستجوی گوگل ارسال شوند.

فیلدها

آرایه کوئری‌ها (رشته) (اختیاری)

عبارت‌های جستجوی وب برای جستجوی وب بعدی.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "google_search_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

محتوای نتایج جستجوی گوگل

محتوای نتایج جستجوی گوگل

رشته امضا (اختیاری)

امضای نتیجه جستجوی گوگل.

نتیجه جستجوی گوگل (اختیاری)

نتایج جستجوی گوگل.

نتیجه جستجوی گوگل.

فیلدها

رشته آدرس اینترنتی (اختیاری)

مرجع URI نتیجه جستجو.

رشته عنوان (اختیاری)

عنوان نتیجه جستجو.

رشته rendered_content (اختیاری)

قطعه محتوای وب که می‌تواند در یک صفحه وب یا نمای وب یک برنامه تعبیه شود.

is_error نوع داده بولی (اختیاری)

اینکه آیا جستجوی گوگل منجر به خطا شده است یا خیر.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "google_search_result" تنظیم شود.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک تماس جستجوی گوگل مطابقت دارد.

McpServerToolCallContent

محتوای فراخوانی ابزار MCPServer.

رشته نام (الزامی)

نام ابزاری که نامگذاری شده است.

رشته نام سرور (الزامی)

نام سرور MCP مورد استفاده.

شیء آرگومان‌ها (الزامی)

شیء JSON آرگومان‌های تابع.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "mcp_server_tool_call" تنظیم شود.

رشته شناسه (الزامی)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

محتوای نتیجه ابزار McpServerTool

محتوای نتایج ابزار MCPServer.

رشته نام (اختیاری)

نام ابزاری که برای این فراخوانی ابزار خاص فراخوانی می‌شود.

رشته server_name (اختیاری)

نام سرور MCP مورد استفاده.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "mcp_server_tool_result" تنظیم شود.

شیء یا رشته نتیجه (الزامی)

نتیجه فراخوانی ابزار.

رشته call_id (الزامی)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی ابزار سرور MCP مطابقت دارد.

محتوای نتیجه جستجوی فایل

محتوای نتیجه جستجوی فایل.

نتیجه FileSearchResult (اختیاری)

نتایج جستجوی فایل

نتیجه جستجوی فایل

فیلدها

رشته عنوان (اختیاری)

عنوان نتیجه جستجو.

رشته متن (اختیاری)

متن نتیجه جستجو.

رشته file_search_store (اختیاری)

نام فروشگاه جستجوی فایل.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "file_search_result" تنظیم شود.

مثال‌ها

متن

{
  "type": "text",
  "text": "Hello, how are you?"
}

تصویر

{
  "type": "image",
  "data": "BASE64_ENCODED_IMAGE",
  "mime_type": "image/png"
}

صوتی

{
  "type": "audio",
  "data": "BASE64_ENCODED_AUDIO",
  "mime_type": "audio/wav"
}

سند

{
  "type": "document",
  "data": "BASE64_ENCODED_DOCUMENT",
  "mime_type": "application/pdf"
}

ویدئو

{
  "type": "video",
  "uri": "https://www.youtube.com/watch?v=9hE5-98ZeCg"
}

فکر

{
  "type": "thought",
  "summary": [
    {
      "type": "text",
      "text": "The user is asking about the weather. I should use the get_weather tool."
    }
  ],
  "signature": "CoMDAXLI2nynRYojJIy6B1Jh9os2crpWLfB0+19xcLsGG46bd8wjkF/6RNlRUdvHrXyjsHkG0BZFcuO/bPOyA6Xh5jANNgx82wPHjGExN8A4ZQn56FlMwyZoqFVQz0QyY1lfibFJ2zU3J87uw26OewzcuVX0KEcs+GIsZa3EA6WwqhbsOd3wtZB3Ua2Qf98VAWZTS5y/tWpql7jnU3/CU7pouxQr/Bwft3hwnJNesQ9/dDJTuaQ8Zprh9VRWf1aFFjpIueOjBRrlT3oW6/y/eRl/Gt9BQXCYTqg/38vHFUU4Wo/d9dUpvfCe/a3o97t2Jgxp34oFKcsVb4S5WJrykIkw+14DzVnTpCpbQNFckqvFLuqnJCkL0EQFtunBXI03FJpPu3T1XU6id8S7ojoJQZSauGUCgmaLqUGdMrd08oo81ecoJSLs51Re9N/lISGmjWFPGpqJLoGq6uo4FHz58hmeyXCgHG742BHz2P3MiH1CXHUT2J8mF6zLhf3SR9Qb3lkrobAh"
}

فراخوانی تابع

{
  "type": "function_call",
  "name": "get_weather",
  "id": "gth23981",
  "arguments": {
    "location": "Boston, MA"
  }
}

نتیجه تابع

{
  "type": "function_result",
  "name": "get_weather",
  "call_id": "gth23981",
  "result": {
    "weather": "sunny"
  }
}

فراخوانی اجرای کد

{
  "type": "code_execution_call",
  "id": "call_123456",
  "arguments": {
    "language": "python",
    "code": "print('hello world')"
  }
}

نتیجه اجرای کد

{
  "type": "code_execution_result",
  "call_id": "call_123456",
  "result": "hello world\n"
}

فراخوانی متن URL

{
  "type": "url_context_call",
  "id": "call_123456",
  "arguments": {
    "urls": [
      "https://www.example.com"
    ]
  }
}

نتیجه متن URL

{
  "type": "url_context_result",
  "call_id": "call_123456",
  "result": [
    {
      "url": "https://www.example.com",
      "status": "SUCCESS"
    }
  ]
}

تماس جستجوی گوگل

{
  "type": "google_search_call",
  "id": "call_123456",
  "arguments": {
    "queries": [
      "weather in Boston"
    ]
  }
}

نتیجه جستجوی گوگل

{
  "type": "google_search_result",
  "call_id": "call_123456",
  "result": [
    {
      "url": "https://www.google.com/search?q=weather+in+Boston",
      "title": "Weather in Boston"
    }
  ]
}

ابزار سرور مک‌پد

{
  "type": "mcp_server_tool_call",
  "id": "call_123456",
  "name": "get_forecast",
  "server_name": "weather_server",
  "arguments": {
    "city": "London"
  }
}

نتیجه ابزار سرور مک‌پد

{
  "type": "mcp_server_tool_result",
  "name": "get_forecast",
  "server_name": "weather_server",
  "call_id": "call_123456",
  "result": "sunny"
}

نتیجه جستجوی فایل

{
  "type": "file_search_result",
  "result": [
    {
      "text": "search result chunk",
      "file_search_store": "file_search_store"
    }
  ]
}

ابزار

انواع ممکن

تفکیک‌کننده چندریختی: type

عملکرد

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

رشته نام (اختیاری)

نام تابع.

رشته توضیحات (اختیاری)

شرحی از تابع.

پارامتر شیء (اختیاری)

طرحواره JSON برای پارامترهای تابع.

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "function" تنظیم شود.

جستجوی گوگل

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

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "google_search" تنظیم شود.

اجرای کد

ابزاری که می‌تواند توسط مدل برای اجرای کد استفاده شود.

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "code_execution" تنظیم شود.

متن آدرس

ابزاری که می‌تواند توسط مدل برای دریافت متن URL استفاده شود.

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "url_context" تنظیم شود.

استفاده از کامپیوتر

ابزاری که می‌تواند توسط مدل برای تعامل با کامپیوتر استفاده شود.

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "computer_use" تنظیم شود.

enum محیطی (رشته‌ای) (اختیاری)

محیطی که در حال اجرا است.

مقادیر ممکن:

  • browser
آرایه excludePredefinedFunctions (رشته) (اختیاری)

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

مک‌پ‌سرور

MCPServer سروری است که می‌تواند توسط مدل برای انجام اقدامات فراخوانی شود.

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "mcp_server" تنظیم شود.

رشته نام (اختیاری)

نام سرور MCP.

رشته آدرس اینترنتی (اختیاری)

آدرس کامل URL برای نقطه پایانی MCPServer. مثال: "https://api.example.com/mcp"

شیء هدر (اختیاری)

اختیاری: در صورت نیاز، فیلدهایی برای هدرهای احراز هویت، زمان‌های انقضا و غیره.

ابزارهای مجاز (اختیاری)

ابزارهای مجاز.

پیکربندی ابزارهای مجاز.

فیلدها

حالت انتخاب ابزار (اختیاری)

حالت انتخاب ابزار.

مقادیر ممکن:

  • auto
  • any
  • none
  • validated

آرایه ابزار (رشته) (اختیاری)

نام ابزارهای مجاز

جستجوی فایل

ابزاری که می‌تواند توسط مدل برای جستجوی فایل‌ها استفاده شود.

آرایه file_search_store_names (رشته‌ای) (اختیاری)

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

عدد صحیح top_k (اختیاری)

تعداد تکه‌های بازیابی معنایی که باید بازیابی شوند.

رشته metadata_filter (اختیاری)

فیلتر فراداده برای اعمال روی اسناد و تکه‌های بازیابی معنایی.

نوع رشته (الزامی)

هیچ توضیحی ارائه نشده است.

همیشه روی "file_search" تنظیم شود.

مثال‌ها

عملکرد

جستجوی گوگل

اجرای کد

متن آدرس

استفاده از کامپیوتر

مک‌پ‌سرور

جستجوی فایل

نوبت

فیلدها

رشته نقش (اختیاری)

آغازگر این نوبت. باید برای ورودی کاربر یا برای خروجی مدل مدل باشد.

آرایه محتوا ( Content ) یا رشته (اختیاری)

محتوای نوبت.

مثال‌ها

نوبت کاربر

{
  "role": "user",
  "content": [
    {
      "type": "text",
      "text": "user turn"
    }
  ]
}

مدل چرخش

{
  "role": "model",
  "content": [
    {
      "type": "text",
      "text": "model turn"
    }
  ]
}

رویداد تعامل

انواع ممکن

تفکیک‌کننده چندریختی: event_type

رویداد تعاملی

event_type enum (رشته) (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • interaction.start
  • interaction.complete
تعامل تعامل (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته event_id (اختیاری)

توکن event_id که برای از سرگیری جریان تعامل، از این رویداد، استفاده می‌شود.

به‌روزرسانی وضعیت تعامل

رشته‌ی interaction_id (اختیاری)

هیچ توضیحی ارائه نشده است.

شمارش وضعیت (رشته) (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
رشته event_type (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "interaction.status_update" تنظیم شود.

رشته event_id (اختیاری)

توکن event_id که برای از سرگیری جریان تعامل، از این رویداد، استفاده می‌شود.

شروع محتوا

عدد صحیح شاخص (اختیاری)

هیچ توضیحی ارائه نشده است.

محتوا ( اختیاری)

هیچ توضیحی ارائه نشده است.

رشته event_type (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "content.start" تنظیم شود.

رشته event_id (اختیاری)

توکن event_id که برای از سرگیری جریان تعامل، از این رویداد، استفاده می‌شود.

کانتنت‌دلتا

عدد صحیح شاخص (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته event_type (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "content.delta" تنظیم شود.

رشته event_id (اختیاری)

توکن event_id که برای از سرگیری جریان تعامل، از این رویداد، استفاده می‌شود.

شیء دلتا (اختیاری)

هیچ توضیحی ارائه نشده است.

انواع ممکن

تفکیک‌کننده چندریختی: type

متن دلتا

رشته متن (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "text" تنظیم شود.

حاشیه‌نویسی‌ها ( اختیاری )

اطلاعات استناد برای محتوای تولید شده توسط مدل.

اطلاعات استناد برای محتوای تولید شده توسط مدل.

فیلدها

عدد صحیح start_index (اختیاری)

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

عدد صحیح end_index (اختیاری)

پایان بخش منسوب، منحصر به فرد.

رشته منبع (اختیاری)

منبعی که برای بخشی از متن ذکر شده است. می‌تواند یک URL، عنوان یا شناسه دیگری باشد.

ایمیج‌دلتا

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

mime_type ImageMimeTypeOption (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif

نوع مایم تصویر.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "image" تنظیم شود.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن:

  • low
  • medium
  • high

آدیودلتا

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

گزینه mime_type AudioMimeType (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac

نوع مایم صدا.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "audio" تنظیم شود.

سند دلتا

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته mime_type (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "document" تنظیم شود.

ویدیودلتا

رشته داده (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته uri (اختیاری)

هیچ توضیحی ارائه نشده است.

mime_type گزینه VideoMimeType (اختیاری)

هیچ توضیحی ارائه نشده است.

مقادیر ممکن:

  • video/mp4
  • video/mpeg
  • video/mov
  • video/avi
  • video/x-flv
  • video/mpg
  • video/webm
  • video/wmv
  • video/3gpp

نوع میم (شبیه‌سازی) ویدیو.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "video" تنظیم شود.

وضوح تصویر MediaResolution (اختیاری)

قطعنامه رسانه‌ها.

مقادیر ممکن:

  • low
  • medium
  • high

خلاصه افکار دلتا

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "thought_summary" تنظیم شود.

محتوای تصویر یا محتوای متن (اختیاری)

هیچ توضیحی ارائه نشده است.

ThoughtSignatureDelta

رشته امضا (اختیاری)

امضا برای مطابقت با منبع backend تا بخشی از نسل باشد.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "thought_signature" تنظیم شود.

تابعCallDelta

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

شیء آرگومان‌ها (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "function_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

تابعنتیجهدلتا

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

is_error نوع داده بولی (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "function_result" تنظیم شود.

شیء یا رشته نتیجه (اختیاری)

دلتای نتیجه فراخوانی ابزار.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت دارد.

اجرای کدCallDelta

آرگومان‌های CodeExecutionCallArguments (اختیاری)

هیچ توضیحی ارائه نشده است.

آرگومان‌هایی که باید به اجرای کد ارسال شوند.

فیلدها

شمارش زبان (رشته) (اختیاری)

زبان برنامه‌نویسی «کد».

مقادیر ممکن:

  • python
رشته کد (اختیاری)

کدی که قرار است اجرا شود.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "code_execution_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

دلتای نتیجه اجرای کد

رشته نتیجه (اختیاری)

هیچ توضیحی ارائه نشده است.

is_error نوع داده بولی (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته امضا (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "code_execution_result" تنظیم شود.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت دارد.

UrlContextCallDelta

آرگومان‌های UrlContextCallArguments (اختیاری)

هیچ توضیحی ارائه نشده است.

آرگومان‌هایی که باید به متن URL ارسال شوند.

فیلدها

آرایه آدرس‌های اینترنتی (رشته‌ای) (اختیاری)

آدرس‌های اینترنتی (URL) برای دریافت.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "url_context_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

UrlContextResultDelta

رشته امضا (اختیاری)

هیچ توضیحی ارائه نشده است.

نتیجه UrlContextResult (اختیاری)

هیچ توضیحی ارائه نشده است.

نتیجه‌ی زمینه‌ی URL.

فیلدها

رشته آدرس اینترنتی (اختیاری)

آدرس اینترنتی (URL) که دریافت شده است.

شمارش وضعیت (رشته) (اختیاری)

وضعیت بازیابی URL.

مقادیر ممکن:

  • success
  • error
  • paywall
  • unsafe
is_error نوع داده بولی (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "url_context_result" تنظیم شود.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت دارد.

جستجوی گوگل، تماس با دلتا

آرگومان‌های GoogleSearchCallArguments (اختیاری)

هیچ توضیحی ارائه نشده است.

آرگومان‌هایی که باید به جستجوی گوگل ارسال شوند.

فیلدها

آرایه کوئری‌ها (رشته) (اختیاری)

عبارت‌های جستجوی وب برای جستجوی وب بعدی.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "google_search_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

نتایج جستجوی گوگل (GoogleSearchResultDelta)

رشته امضا (اختیاری)

هیچ توضیحی ارائه نشده است.

نتیجه جستجوی گوگل (اختیاری)

هیچ توضیحی ارائه نشده است.

نتیجه جستجوی گوگل.

فیلدها

رشته آدرس اینترنتی (اختیاری)

مرجع URI نتیجه جستجو.

رشته عنوان (اختیاری)

عنوان نتیجه جستجو.

رشته rendered_content (اختیاری)

قطعه محتوای وب که می‌تواند در یک صفحه وب یا نمای وب یک برنامه تعبیه شود.

is_error نوع داده بولی (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "google_search_result" تنظیم شود.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت دارد.

ابزار McpServerCallDelta

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته server_name (اختیاری)

هیچ توضیحی ارائه نشده است.

شیء آرگومان‌ها (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "mcp_server_tool_call" تنظیم شود.

رشته شناسه (اختیاری)

یک شناسه منحصر به فرد برای این فراخوانی ابزار خاص.

McpServerToolResultDelta

رشته نام (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته server_name (اختیاری)

هیچ توضیحی ارائه نشده است.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "mcp_server_tool_result" تنظیم شود.

شیء یا رشته نتیجه (اختیاری)

دلتای نتیجه فراخوانی ابزار.

رشته‌ی call_id (اختیاری)

شناسه‌ای که با شناسه‌ی بلوک فراخوانی تابع مطابقت دارد.

جستجوی فایلنتیجهدلتا

نتیجه FileSearchResult (اختیاری)

هیچ توضیحی ارائه نشده است.

نتیجه جستجوی فایل

فیلدها

رشته عنوان (اختیاری)

عنوان نتیجه جستجو.

رشته متن (اختیاری)

متن نتیجه جستجو.

رشته file_search_store (اختیاری)

نام فروشگاه جستجوی فایل.

نوع رشته (الزامی)

به عنوان تفکیک‌کننده نوع OpenAPI برای محتوای oneof استفاده می‌شود.

همیشه روی "file_search_result" تنظیم شود.

توقف محتوا

عدد صحیح شاخص (اختیاری)

هیچ توضیحی ارائه نشده است.

رشته event_type (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "content.stop" تنظیم شود.

رشته event_id (اختیاری)

توکن event_id که برای از سرگیری جریان تعامل، از این رویداد، استفاده می‌شود.

رویداد خطا

رشته event_type (اختیاری)

هیچ توضیحی ارائه نشده است.

همیشه روی "error" تنظیم شود.

خطا ( اختیاری )

هیچ توضیحی ارائه نشده است.

پیام خطا از یک تعامل.

فیلدها

رشته کد (اختیاری)

یک URI که نوع خطا را مشخص می‌کند.

رشته پیام (اختیاری)

یک پیام خطا که برای انسان قابل خواندن باشد.

رشته event_id (اختیاری)

توکن event_id که برای از سرگیری جریان تعامل، از این رویداد، استفاده می‌شود.

مثال‌ها

شروع تعامل

{
  "event_type": "interaction.start",
  "interaction": {
    "id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
    "model": "gemini-2.5-flash",
    "object": "interaction",
    "status": "in_progress"
  }
}

تعامل کامل شد

{
  "event_type": "interaction.complete",
  "interaction": {
    "created": "2025-12-09T18:45:40Z",
    "id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
    "model": "gemini-2.5-flash",
    "object": "interaction",
    "outputs": [
      {
        "signature": "CoMDAXLI2nynRYojJIy6B1Jh9os2crpWLfB0+19xcLsGG46bd8wjkF/6RNlRUdvHrXyjsHkG0BZFcuO/bPOyA6Xh5jANNgx82wPHjGExN8A4ZQn56FlMwyZoqFVQz0QyY1lfibFJ2zU3J87uw26OewzcuVX0KEcs+GIsZa3EA6WwqhbsOd3wtZB3Ua2Qf98VAWZTS5y/tWpql7jnU3/CU7pouxQr/Bwft3hwnJNesQ9/dDJTuaQ8Zprh9VRWf1aFFjpIueOjBRrlT3oW6/y/eRl/Gt9BQXCYTqg/38vHFUU4Wo/d9dUpvfCe/a3o97t2Jgxp34oFKcsVb4S5WJrykIkw+14DzVnTpCpbQNFckqvFLuqnJCkL0EQFtunBXI03FJpPu3T1XU6id8S7ojoJQZSauGUCgmaLqUGdMrd08oo81ecoJSLs51Re9N/lISGmjWFPGpqJLoGq6uo4FHz58hmeyXCgHG742BHz2P3MiH1CXHUT2J8mF6zLhf3SR9Qb3lkrobAh",
        "type": "thought"
      },
      {
        "text": "Elara\u2019s life was a symphony of quiet moments. A librarian, she found solace in the hushed aisles, the scent of aged paper, and the predictable rhythm of her days. Her small apartment, meticulously ordered, reflected this internal calm, save",
        "type": "text"
      },
      {
        "text": " for one beloved anomaly: a chipped porcelain teacup, inherited from her grandmother, which held her morning Earl Grey.\n\nOne Tuesday, stirring her tea, Elara paused. At the bottom, nestled against the porcelain, was a star.",
        "type": "text"
      },
      {
        "text": " Not a star-shaped tea leaf, but a miniature, perfectly formed celestial body, radiating a faint, cool luminescence. Before she could gasp, it dissolved, leaving only the amber swirl of her brew. She dismissed it as a trick of",
        "type": "text"
      },
      {
        "text": " tired eyes.\n\nBut the next morning, a gossamer-thin feather, smaller than an eyelash and shimmering with iridescent hues, floated on the surface. It vanished the moment she tried to touch it. A week later, a single,",
        "type": "text"
      },
      {
        "text": " impossibly delicate bloom, like spun moonbeam, unfolded in her cup before fading into nothingness.\n\nThese weren't illusions. Each day, Elara\u2019s chipped teacup offered a fleeting, exquisite secret. A tiny, perfect",
        "type": "text"
      },
      {
        "text": " crystal, a miniature spiral nebula, a fragment of rainbow caught in liquid form. They never lingered, never accumulated, simply *were* and then *weren't*, leaving behind a residue of quiet wonder.\n\nElara never spoke",
        "type": "text"
      },
      {
        "text": " of it. It was her private wellspring, a daily reminder that magic could exist in the smallest, most overlooked corners of the world. Her routine remained unchanged, her external life a picture of calm, but inside, a secret garden blo",
        "type": "text"
      },
      {
        "text": "omed. Each dawn brought not just tea, but the silent promise of extraordinary beauty, waiting patiently in a chipped teacup.",
        "type": "text"
      }
    ],
    "role": "model",
    "status": "completed",
    "updated": "2025-12-09T18:45:40Z",
    "usage": {
      "input_tokens_by_modality": [
        {
          "modality": "text",
          "tokens": 11
        }
      ],
      "total_cached_tokens": 0,
      "total_input_tokens": 11,
      "total_output_tokens": 364,
      "total_reasoning_tokens": 1120,
      "total_tokens": 1495,
      "total_tool_use_tokens": 0
    }
  }
}

به‌روزرسانی وضعیت تعامل

{
  "event_type": "interaction.status_update",
  "interaction_id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
  "status": "in_progress"
}

شروع محتوا

{
  "event_type": "content.start",
  "content": {
    "type": "text"
  },
  "index": 1
}

دلتای محتوا

{
  "event_type": "content.delta",
  "delta": {
    "type": "text",
    "text": "Elara\u2019s life was a symphony of quiet moments. A librarian, she found solace in the hushed aisles, the scent of aged paper, and the predictable rhythm of her days. Her small apartment, meticulously ordered, reflected this internal calm, save"
  },
  "index": 1
}

توقف محتوا

{
  "event_type": "content.stop",
  "index": 1
}

رویداد خطا

{
  "event_type": "error",
  "error": {
    "message": "Failed to get completed interaction: Result not found.",
    "code": "not_found"
  }
}