Флэш-память Gemini 3.7 теперь доступна. Попробуйте!

Эта страница переведена с помощью Cloud Translation API.

Gemini Interactions API

API взаимодействия Gemini позволяет разработчикам создавать приложения генеративного ИИ, используя модели Gemini. Gemini — наша самая мощная модель, разработанная с нуля для мультимодального взаимодействия. Она способна обобщать и беспрепятственно понимать, обрабатывать и комбинировать различные типы информации, включая язык, изображения, аудио, видео и код. Вы можете использовать API Gemini для таких задач, как рассуждения на основе текста и изображений, генерация контента, диалоговые агенты, системы суммирования и классификации и многое другое.

Просмотреть в формате Markdown Просмотреть спецификацию OpenAPI

Версия API: v1beta v1

Создание взаимодействия

публикация https://generativelanguage.googleapis.com/v1beta/interactions

Создает новое взаимодействие.

Путь / Параметры запроса
Текст запроса
Ответ

Путь / Параметры запроса

api_version строка (обязательно)

Какую версию API использовать?

Текст запроса

Тело запроса содержит данные следующей структуры:

модель ModelOption (необязательно)

Название модели, использованной для генерации взаимодействия.
Обязательно, если параметр `agent` не указан.

Возможные значения

models/gemini-2.5-flash-lite
Наша самая компактная и экономичная модель, предназначенная для масштабного использования.
models/gemini-2.5-flash-image
Наша собственная модель генерации изображений, оптимизированная для скорости, гибкости и контекстного понимания. Стоимость ввода и вывода текста такая же, как у 2,5-дюймовой версии Flash.
models/gemini-3.1-flash-lite
Наша наиболее экономичная модель, оптимизированная для выполнения больших объемов агентских задач, перевода и простой обработки данных.
models/gemini-3.1-flash-image
Профессиональный уровень визуального интеллекта с эффективностью, сравнимой со скоростью Flash, и возможностями генерации данных, основанных на реальных событиях.
models/gemini-3.5-flash
Наша наиболее интеллектуальная модель для достижения устойчиво высоких результатов в задачах, связанных с агентным программированием и кодированием.
models/gemini-3.6-flash
Наша наиболее интеллектуальная модель для достижения устойчиво высоких результатов в задачах, связанных с агентным программированием и кодированием.
models/gemini-3.7-flash
Наша наиболее интеллектуальная модель для достижения устойчиво высоких результатов в задачах, связанных с агентным программированием и кодированием.

агент AgentOption (необязательно)

Имя агента, использованного для генерации взаимодействия.
Обязательно, если параметр `model` не указан.

Возможные значения

deep-research-pro-preview-12-2025
Агент по глубоким исследованиям компании Gemini
deep-research-preview-04-2026
Агент по глубоким исследованиям компании Gemini
deep-research-max-preview-04-2026
Gemini Deep Research Max Agent
antigravity-preview-05-2026
Используйте управляемый агент Antigravity для выполнения многоэтапных задач, требующих логического мышления, работы с файлами и использования инструментов.

Входные данные: Content или array ( Content ) или array ( Step ) или string (обязательно)

Входные данные для взаимодействия (общие для модели и агента).

строка системной инструкции (необязательно)

Системная инструкция для взаимодействия.

массив инструментов ( Инструмент ) (необязательно)

Список объявлений инструментов, которые модель может вызывать во время взаимодействия.

response_format ResponseFormat или массив ( ResponseFormat ) (необязательно)

Обеспечивает, чтобы сгенерированный ответ представлял собой объект JSON, соответствующий схеме JSON, указанной в этом поле.

потоковое логическое значение (необязательно)

Только ввод данных. Будет ли взаимодействие передаваться в потоковом режиме.

хранить логическое значение (необязательно)

Только ввод. Следует ли сохранять ответ и запрос для последующего получения.

фоновое логическое значение (необязательно)

Только ввод данных. Следует ли запускать взаимодействие с моделью в фоновом режиме.

generation_config GenerationConfig (необязательно)

Конфигурация модели
Параметры конфигурации для взаимодействия модели.
Альтернатива `agent_config`. Применимо только при заданном `model`.

Поля

max_output_tokens — целое число (необязательно)

Максимальное количество токенов, которые можно включить в ответ.

Начальное целое число (необязательно)

Исходные данные используются при декодировании для обеспечения воспроизводимости.

speech_config SpeakerConfig или массив (SpeechConfig) (необязательно)

Дополнительно. Настройка речи и работы с несколькими говорящими.

массив stop_sequences (строка) (необязательно)

Список последовательностей символов, которые прекратят взаимодействие с выводом.

thinking_level ThinkingLevel (необязательно)

Уровень мыслительных токенов, которые должна генерировать модель.

Возможные значения

minimal
Практически никакого размышления.
low
Низкий уровень мышления.
medium
Средний уровень сложности мышления.
high
Высокий уровень мыслительных способностей.

thinking_summaries ThinkingSummaries (необязательно)

Стоит ли включать в ответ краткое изложение мыслей?

Возможные значения

auto
Краткие обзоры автоматического мышления.
none
Никаких кратких изложений мысли.

tool_choice ToolChoiceConfig или перечисление (строка) (необязательно)

Конфигурация выбора инструмента.

Возможные значения:

auto
Автоматический выбор инструмента.
any
Любой выбор инструмента.
none
Выбор инструментов отсутствует.
validated
Выбор инструмента подтвержден.

agent_config DynamicAgentConfig (необязательно)

Конфигурация агента
Настройки агента.
Альтернатива `generation_config`. Применимо только при заданном `agent`.

Поля

тип объекта (необязательно)

Описание отсутствует.

Всегда устанавливайте значение "dynamic" .

объект меток (необязательно)

Метки с заданными пользователем метаданными для запроса.

max_total_tokens строка (необязательно)

Максимальное общее количество токенов для выполнения задания агентом.

previous_interaction_id строка (необязательно)

Идентификатор предыдущего взаимодействия, если таковое имелось.

массив safety_settings (SafetySetting) (необязательно)

Настройки безопасности для взаимодействия.

Ответ

Возвращает ресурс " Взаимодействие" .

Простая просьба

Пример ответа

{
  "created": "2025-11-26T12:25:15Z",
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3.6-flash",
  "object": "interaction",
  "status": "completed",
  "steps": [
    {
      "type": "model_output",
      "content": [
        {
          "type": "text",
          "text": "Hello! I'm functioning perfectly and ready to assist you.\n\nHow are you doing today?"
        }
      ]
    }
  ],
  "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_thought_tokens": 22,
    "total_tokens": 49,
    "total_tool_use_tokens": 0
  }
}

Многооборотный

Пример ответа

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

Ввод изображения

Пример ответа

{
  "created": "2025-11-26T12:22:47Z",
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3.6-flash",
  "object": "interaction",
  "status": "completed",
  "steps": [
    {
      "type": "model_output",
      "content": [
        {
          "type": "text",
          "text": "A white humanoid robot with glowing blue eyes stands holding a red skateboard."
        }
      ]
    }
  ],
  "updated": "2025-11-26T12:22:47Z",
  "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_thought_tokens": 0,
    "total_tokens": 288,
    "total_tool_use_tokens": 0
  }
}

Вызов функции

Пример ответа

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

Отмена взаимодействия

post https://generativelanguage.googleapis.com/v1beta/interactions/{id}/cancel

Отменяет взаимодействие по идентификатору. Это относится только к фоновым взаимодействиям, которые все еще выполняются.

Путь / Параметры запроса
Ответ

Путь / Параметры запроса

api_version строка (обязательно)

Какую версию API использовать?

строковый идентификатор (обязательно)

Уникальный идентификатор взаимодействия, которое необходимо отменить.

Ответ

Возвращает ресурс " Взаимодействие" .

Отменить взаимодействие

Пример ответа

{
  "created": "2025-11-26T12:25:15Z",
  "id": "v1_ChdPU0F4YWFtNkFwS2kxZThQZ05lbXdROBIXT1NBeGFhbTZBcEtpMWU4UGdOZW13UTg",
  "model": "gemini-3.6-flash",
  "object": "interaction",
  "status": "cancelled",
  "updated": "2025-11-26T12:25:15Z"
}

Получение информации о взаимодействии

получить https://generativelanguage.googleapis.com/v1beta/interactions/{id}

Получает полную информацию об одном взаимодействии на основе его `Interaction.id`.

Путь / Параметры запроса
Ответ

Путь / Параметры запроса

api_version строка (обязательно)

Какую версию API использовать?

строковый идентификатор (обязательно)

Уникальный идентификатор взаимодействия, который необходимо получить.

last_event_id строка (необязательно)

Необязательный параметр. Если задан, возобновляет поток взаимодействия со следующего фрагмента после события, отмеченного идентификатором события. Может использоваться только в том случае, если `stream` имеет значение true.

потоковое логическое значение (необязательно)

Если установить значение true, сгенерированный контент будет передаваться потоком инкрементально.

Значение по умолчанию: False

Ответ

Возвращает ресурс " Взаимодействие" .

Получить взаимодействие

Пример ответа

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

Удаление взаимодействия

удалить https://generativelanguage.googleapis.com/v1beta/interactions/{id}

Удаляет взаимодействие по идентификатору.

Путь / Параметры запроса
Ответ

Путь / Параметры запроса

api_version строка (обязательно)

Какую версию API использовать?

строковый идентификатор (обязательно)

Уникальный идентификатор взаимодействия, которое необходимо удалить.

Ответ

В случае успеха ответ будет пустым.

Удалить

Ресурсы

Взаимодействие

Ресурс "Взаимодействие".

Поля

агент AgentOption (необязательно)

Имя агента, использованного для генерации взаимодействия.

Возможные значения

deep-research-pro-preview-12-2025
Агент по глубоким исследованиям компании Gemini
deep-research-preview-04-2026
Агент по глубоким исследованиям компании Gemini
deep-research-max-preview-04-2026
Gemini Deep Research Max Agent
antigravity-preview-05-2026
Используйте управляемый агент Antigravity для выполнения многоэтапных задач, требующих логического мышления, работы с файлами и использования инструментов.

agent_config DynamicAgentConfig (необязательно)

Параметры конфигурации для взаимодействия с агентом.

Поля

тип объекта (необязательно)

Описание отсутствует.

Всегда устанавливайте значение "dynamic" .

созданная строка (необязательно)

Только вывод. Время создания ответа в формате ISO 8601 (ГГГГ-ММ-ДДЧч:мм:ссЗ).

массив ошибок (Ошибка) (необязательно)

Только вывод. Диагностические ошибки / ошибки платформы, зафиксированные во время взаимодействия.

Поля

строка кода (необязательно)

URI, определяющий тип ошибки.

строка сообщения (необязательно)

Удобочитаемое сообщение об ошибке.

строка идентификатора (необязательно)

Обязательно. Только для вывода. Уникальный идентификатор завершения взаимодействия.

По умолчанию:

Входные данные: Content или массив ( Content ), массив ( Step ) или строка (необязательно).

Входные данные для взаимодействия.

объект меток (необязательно)

Метки с заданными пользователем метаданными для запроса.

max_total_tokens строка (необязательно)

Максимальное общее количество токенов для выполнения задания агентом.

модель ModelOption (необязательно)

Название модели, использованной для генерации взаимодействия.

Возможные значения

models/gemini-2.5-flash-lite
Наша самая компактная и экономичная модель, предназначенная для масштабного использования.
models/gemini-2.5-flash-image
Наша собственная модель генерации изображений, оптимизированная для скорости, гибкости и контекстного понимания. Стоимость ввода и вывода текста такая же, как у 2,5-дюймовой версии Flash.
models/gemini-3.1-flash-lite
Наша наиболее экономичная модель, оптимизированная для выполнения больших объемов агентских задач, перевода и простой обработки данных.
models/gemini-3.1-flash-image
Профессиональный уровень визуального интеллекта с эффективностью, сравнимой со скоростью Flash, и возможностями генерации данных, основанных на реальных событиях.
models/gemini-3.5-flash
Наша наиболее интеллектуальная модель для достижения устойчиво высоких результатов в задачах, связанных с агентным программированием и кодированием.
models/gemini-3.6-flash
Наша наиболее интеллектуальная модель для достижения устойчиво высоких результатов в задачах, связанных с агентным программированием и кодированием.
models/gemini-3.7-flash
Наша наиболее интеллектуальная модель для достижения устойчиво высоких результатов в задачах, связанных с агентным программированием и кодированием.

output_audio AudioContent (необязательно)

Последний аудиофайл, сгенерированный моделью в ответ на текущий запрос. Примечание: эта информация добавляется SDK.

Поля

каналы целое число (необязательно)

Количество аудиоканалов.

строка данных (необязательно)

Аудиоконтент.

перечисление mime_type (строка) (необязательно)

MIME-тип аудиофайла.

Возможные значения:

audio/wav
аудиоформат WAV
audio/mp3
аудиоформат MP3
audio/aiff
аудиоформат AIFF
audio/aac
аудиоформат AAC
audio/ogg
Аудиоформат OGG
audio/flac
аудиоформат FLAC
audio/mpeg
аудиоформат MPEG
audio/m4a
аудиоформат M4A
audio/l16
аудиоформат L16
audio/opus
Аудиоформат OPUS
audio/alaw
Аудиоформат ALAW
audio/mulaw
Аудиоформат MULAW

sample_rate — целое число (необязательно)

Частота дискретизации аудиосигнала.

тип объекта (необязательно)

Описание отсутствует.

Всегда устанавливайте значение "audio" .

строка URI (необязательно)

URI аудиофайла.

output_image ImageContent (необязательно)

Последнее изображение, сгенерированное моделью в ответ на текущий запрос. Примечание: оно добавляется SDK.

output_text строка (необязательно)

Конкатенированный текст из последнего результата работы модели в ответ на текущий запрос. Примечание: этот текст добавляется SDK.

previous_interaction_id строка (необязательно)

Идентификатор предыдущего взаимодействия, если таковое имелось.

response_format ResponseFormat или массив ( ResponseFormat ) (необязательно)

массив safety_settings (SafetySetting) (необязательно)

Настройки безопасности для взаимодействия.

перечисление статуса (строка) (необязательно)

Обязательный параметр. Только вывод. Статус взаимодействия.

Возможные значения:

in_progress
Взаимодействие продолжается.
requires_action
Для взаимодействия требуется действие/ввод данных от пользователя.
completed
Взаимодействие завершено.
failed
Взаимодействие не удалось.
cancelled
Встреча была отменена.
incomplete
Взаимодействие завершено, но результаты неполные (например, достигнуто значение max_tokens).

массив шагов ( Шаг ) (необязательно)

Только вывод. Этапы взаимодействия, если они включены в ответ.

строка системной инструкции (необязательно)

Системная инструкция для взаимодействия.

массив инструментов ( Инструмент ) (необязательно)

Список объявлений инструментов, которые модель может вызывать во время взаимодействия.

обновленная строка (необязательно)

Только вывод. Время последнего обновления ответа в формате ISO 8601 (ГГГГ-ММ-ДДТч:мм:ссЗ).

Использование (необязательно )

Только вывод. Статистика использования токенов в запросе на взаимодействие.

Поля

массив cached_tokens_by_modality (ModalityTokens) (необязательно)

Анализ использования кэшированных токенов по способам доступа.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

массив grounding_tool_count (GroundingToolCount) (необязательно)

Количество инструментов для заземления.

Поля

count целое число (необязательно)

Количество заземляющих инструментов подсчитывается.

тип перечисления (строка) (необязательно)

Тип заземляющего инструмента, связанный с подсчетом.

Возможные значения:

google_search
Интеграция веб-поиска Google и поиска изображений, а также интеграция веб-поиска с корпоративными приложениями.
google_maps
Определить местоположение с помощью Google Maps.

input_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования входных токенов в зависимости от модальности ввода.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

output_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования выходных токенов по видам модальностей.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

tool_use_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования токенов инструментов в зависимости от модальности.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

total_cached_tokens — целое число (необязательно)

Количество токенов в кэшированной части запроса (кэшированное содержимое).

total_input_tokens целое число (необязательно)

Количество токенов в подсказке (контексте).

total_output_tokens целое число (необязательно)

Общее количество токенов во всех сгенерированных ответах.

total_thought_tokens целое число (необязательно)

Количество токенов мыслей для моделей мышления.

total_tokens целое число (необязательно)

Общее количество токенов для запроса на взаимодействие (запрос + ответы + другие внутренние токены).

total_tool_use_tokens целое число (необязательно)

Количество токенов, присутствующих в подсказках использования инструмента.

Примеры

Пример

{
  "created": "2025-12-04T15:01:45Z",
  "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
  "model": "gemini-3.6-flash",
  "object": "interaction",
  "status": "completed",
  "steps": [
    {
      "type": "model_output",
      "content": [
        {
          "type": "text",
          "text": "Hello! I'm doing well, functioning as expected. Thank you for asking! How are you doing today?"
        }
      ]
    }
  ],
  "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_thought_tokens": 49,
    "total_tokens": 79,
    "total_tool_use_tokens": 0
  }
}

Модели данных

Содержание

Содержание ответа.

Возможные типы

Аудиоконтент

Блок аудиоконтента.

каналы целое число (необязательно)

Количество аудиоканалов.

строка данных (необязательно)

Аудиоконтент.

перечисление mime_type (строка) (необязательно)

MIME-тип аудиофайла.

Возможные значения:

audio/wav
аудиоформат WAV
audio/mp3
аудиоформат MP3
audio/aiff
аудиоформат AIFF
audio/aac
аудиоформат AAC
audio/ogg
Аудиоформат OGG
audio/flac
аудиоформат FLAC
audio/mpeg
аудиоформат MPEG
audio/m4a
аудиоформат M4A
audio/l16
аудиоформат L16
audio/opus
Аудиоформат OPUS
audio/alaw
Аудиоформат ALAW
audio/mulaw
Аудиоформат MULAW

sample_rate — целое число (необязательно)

Частота дискретизации аудиосигнала.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "audio" .

строка URI (необязательно)

URI аудиофайла.

Содержимое документа

Блок содержимого документа.

строка данных (необязательно)

Содержание документа.

перечисление mime_type (строка) (необязательно)

MIME-тип документа.

Возможные значения:

application/pdf
PDF-документ
text/csv
формат документа CSV

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "document" .

строка URI (необязательно)

URI документа.

ImageContent

Блок с графическим содержимым.

строка данных (необязательно)

Содержание изображения.

перечисление mime_type (строка) (необязательно)

MIME-тип изображения.

Возможные значения:

image/png
формат изображения PNG
image/jpeg
формат изображения JPEG
image/webp
формат изображений WebP
image/heic
формат изображения HEIC
image/heif
формат изображения HEIF
image/gif
формат изображения GIF
image/bmp
формат изображения BMP
image/tiff
формат изображения TIFF

разрешение MediaResolution (необязательно)

Разрешение средств массовой информации.

Возможные значения

low
Низкое разрешение.
medium
Среднее разрешение.
high
Высокое разрешение.
ultra_high
Сверхвысокое разрешение.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "image" .

строка URI (необязательно)

URI изображения.

Текстовое содержимое

Блок текстового содержимого.

массив аннотаций (Аннотация) (необязательно)

Информация об источниках для контента, сгенерированного моделью.

Возможные типы

FileCitation

Аннотация к файлу.

объект custom_metadata (необязательно)

Пользователь предоставил метаданные о полученном контексте.

document_uri строка (необязательно)

URI файла.

end_index целое число (необязательно)

Конец выделенного сегмента, без учета каких-либо ограничений.

file_name string (необязательно)

Название файла.

media_id строка (необязательно)

В случае цитирования изображений, пожалуйста, укажите идентификатор медиафайла (Media ID), если таковой имеется.

page_number целое число (необязательно)

Номер страницы цитируемого документа, если таковой имеется.

исходная строка (необязательно)

Источник указан для части текста.

start_index — целое число (необязательно)

Начало сегмента ответа, который относится к данному источнику. Индекс указывает начало сегмента, измеряемое в байтах.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "file_citation" .

PlaceCitation

Аннотация к географическому местоположению.

end_index целое число (необязательно)

Конец выделенного сегмента, без учета каких-либо ограничений.

строковое имя (необязательно)

Название места.

place_id строка (необязательно)

Идентификатор места в формате `places/{place_id}`.

массив review_snippets (ReviewSnippet) (необязательно)

Фрагменты отзывов, используемые для генерации ответов об особенностях того или иного места в Google Maps.

Поля

review_id строка (необязательно)

Идентификатор фрагмента отзыва.

заголовок (необязательно )

Заголовок рецензии.

строка URL (необязательно)

Ссылка, соответствующая отзыву пользователя на Google Maps.

start_index — целое число (необязательно)

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "place_citation" .

строка URL (необязательно)

URI-ссылка на это место.

URLCitation

Аннотация URL-адреса.

end_index целое число (необязательно)

Конец выделенного сегмента, без учета каких-либо ограничений.

start_index — целое число (необязательно)

заголовок (необязательно )

Заголовок URL-адреса.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "url_citation" .

строка URL (необязательно)

URL.

текстовая строка (обязательно)

Обязательно. Текстовое содержимое.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "text" .

Примеры

Аудио

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

Документ

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

Изображение

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

Текст

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

Инструмент

Инструмент, который может быть использован моделью.

Возможные типы

Выполнение кода

Инструмент, который может использоваться моделью для выполнения кода.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "code_execution" .

Поиск файлов

Инструмент, который может использоваться моделью для поиска файлов.

массив file_search_store_names (строка) (необязательно)

Названия хранилищ файлов для поиска.

metadata_filter строка (необязательно)

Фильтр метаданных, применяемый к документам и фрагментам, полученным в результате семантического поиска.

top_k целое число (необязательно)

Количество фрагментов семантического поиска, которые необходимо извлечь.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "file_search" .

Функция

Инструмент, который может быть использован моделью.

строка описания (необязательно)

Описание функции.

строковое имя (необязательно)

Название функции.

объект параметров (необязательно)

JSON-схема для параметров функции.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "function" .

Google Карты

Инструмент, который модель может использовать для вызова Google Maps.

enable_widget boolean (необязательно)

Следует ли возвращать токен контекста виджета в результате вызова инструмента в ответе.

широта ( необязательно )

Широта местоположения пользователя.

Номер долготы (необязательно)

Долгота местоположения пользователя.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "google_maps" .

GoogleПоиск

Инструмент, который модель может использовать для поиска в Google.

массив search_types (перечисление (строка)) (необязательно)

Типы поиска, которые необходимо включить.

Возможные значения:

web_search
Включение этого поля активирует веб-поиск. Возвращаются только текстовые результаты.
image_search
Установив это поле, можно включить поиск изображений. Возвращаются байты изображения.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "google_search" .

UrlContext

Инструмент, который может использоваться моделью для получения контекста URL-адреса.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "url_context" .

Примеры

Выполнение кода

Поиск файлов

Функция

Google Карты

GoogleПоиск

UrlContext

InteractionSseEvent

Возможные типы

Полиморфный дискриминатор: event_type

ErrorEvent

ошибка Ошибка (необязательно)

Описание отсутствует.

Поля

строка кода (необязательно)

URI, определяющий тип ошибки.

строка сообщения (необязательно)

Удобочитаемое сообщение об ошибке.

event_id строка (необязательно)

Токен event_id, который будет использоваться для возобновления потока взаимодействия с этого события.

event_type object (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "error" .

InteractionCompletedEvent

event_id строка (необязательно)

Токен event_id, который будет использоваться для возобновления потока взаимодействия с этого события.

event_type object (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "interaction.completed" .

interaction InteractionSseEventInteraction (required)

Частично завершенный ресурс взаимодействия выдается в конце потока.

Поля

Строка агента (необязательно)

Агент, с которым необходимо взаимодействовать.

созданная строка (необязательно)

Только выходные данные. Время создания ответа в формате ISO 8601.

строка идентификатора (необязательно)

Обязательно. Только для вывода. Уникальный идентификатор завершения взаимодействия.

строка модели (необязательно)

Модель, которая поможет выполнить ваше задание.

строковый объект (необязательно)

Только вывод. Тип ресурса.

перечисление статуса (строка) (необязательно)

Обязательный параметр. Только вывод. Статус взаимодействия.

Возможные значения:

in_progress
Взаимодействие продолжается.
requires_action
Для взаимодействия требуется действие/ввод данных от пользователя.
completed
Взаимодействие завершено.
failed
Взаимодействие не удалось.
cancelled
Встреча была отменена.
incomplete
Взаимодействие завершено, но результаты неполные (например, достигнуто значение max_tokens).

массив шагов ( Шаг ) (необязательно)

Только вывод. Этапы взаимодействия, если они включены в это событие.

обновленная строка (необязательно)

Только выходные данные. Время последнего обновления ответа в формате ISO 8601.

Использование (необязательно )

Только вывод. Статистика использования токенов в запросе на взаимодействие.

Поля

массив cached_tokens_by_modality (ModalityTokens) (необязательно)

Анализ использования кэшированных токенов по способам доступа.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

массив grounding_tool_count (GroundingToolCount) (необязательно)

Количество инструментов для заземления.

Поля

count целое число (необязательно)

Количество заземляющих инструментов подсчитывается.

тип перечисления (строка) (необязательно)

Тип заземляющего инструмента, связанный с подсчетом.

Возможные значения:

google_search
Интеграция веб-поиска Google и поиска изображений, а также интеграция веб-поиска с корпоративными приложениями.
google_maps
Определить местоположение с помощью Google Maps.

input_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования входных токенов в зависимости от модальности ввода.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

output_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования выходных токенов по видам модальностей.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

tool_use_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования токенов инструментов в зависимости от модальности.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

total_cached_tokens — целое число (необязательно)

Количество токенов в кэшированной части запроса (кэшированное содержимое).

total_input_tokens целое число (необязательно)

Количество токенов в подсказке (контексте).

total_output_tokens целое число (необязательно)

Общее количество токенов во всех сгенерированных ответах.

total_thought_tokens целое число (необязательно)

Количество токенов мыслей для моделей мышления.

total_tokens целое число (необязательно)

Общее количество токенов для запроса на взаимодействие (запрос + ответы + другие внутренние токены).

total_tool_use_tokens целое число (необязательно)

Количество токенов, присутствующих в подсказках использования инструмента.

InteractionCreatedEvent

event_id строка (необязательно)

Токен event_id, который будет использоваться для возобновления потока взаимодействия с этого события.

event_type object (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "interaction.created" .

interaction InteractionSseEventInteraction (required)

Ресурс частичного взаимодействия, генерируемый при создании потока.

Поля

Строка агента (необязательно)

Агент, с которым необходимо взаимодействовать.

созданная строка (необязательно)

Только выходные данные. Время создания ответа в формате ISO 8601.

строка идентификатора (необязательно)

Обязательно. Только для вывода. Уникальный идентификатор завершения взаимодействия.

строка модели (необязательно)

Модель, которая поможет выполнить ваше задание.

строковый объект (необязательно)

Только вывод. Тип ресурса.

перечисление статуса (строка) (необязательно)

Обязательный параметр. Только вывод. Статус взаимодействия.

Возможные значения:

in_progress
Взаимодействие продолжается.
requires_action
Для взаимодействия требуется действие/ввод данных от пользователя.
completed
Взаимодействие завершено.
failed
Взаимодействие не удалось.
cancelled
Встреча была отменена.
incomplete
Взаимодействие завершено, но результаты неполные (например, достигнуто значение max_tokens).

массив шагов ( Шаг ) (необязательно)

Только вывод. Этапы взаимодействия, если они включены в это событие.

обновленная строка (необязательно)

Только выходные данные. Время последнего обновления ответа в формате ISO 8601.

Использование (необязательно )

Только вывод. Статистика использования токенов в запросе на взаимодействие.

Поля

массив cached_tokens_by_modality (ModalityTokens) (необязательно)

Анализ использования кэшированных токенов по способам доступа.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

массив grounding_tool_count (GroundingToolCount) (необязательно)

Количество инструментов для заземления.

Поля

count целое число (необязательно)

Количество заземляющих инструментов подсчитывается.

тип перечисления (строка) (необязательно)

Тип заземляющего инструмента, связанный с подсчетом.

Возможные значения:

google_search
Интеграция веб-поиска Google и поиска изображений, а также интеграция веб-поиска с корпоративными приложениями.
google_maps
Определить местоположение с помощью Google Maps.

input_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования входных токенов в зависимости от модальности ввода.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

output_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования выходных токенов по видам модальностей.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

tool_use_tokens_by_modality array (ModalityTokens) (optional)

Анализ использования токенов инструментов в зависимости от модальности.

Поля

модальность ResponseModality (необязательно)

Способ отображения количества токенов.

Возможные значения

text
Указывает, что модель должна возвращать текст.
image
Указывает, что модель должна возвращать изображения.
audio
Указывает, что модель должна возвращать аудиоданные.
video
Указывает, что модель должна возвращать видео.
document
Указывает, что модель должна возвращать документы.

токены целое число (необязательно)

Количество токенов для данного режима.

total_cached_tokens — целое число (необязательно)

Количество токенов в кэшированной части запроса (кэшированное содержимое).

total_input_tokens целое число (необязательно)

Количество токенов в подсказке (контексте).

total_output_tokens целое число (необязательно)

Общее количество токенов во всех сгенерированных ответах.

total_thought_tokens целое число (необязательно)

Количество токенов мыслей для моделей мышления.

total_tokens целое число (необязательно)

Общее количество токенов для запроса на взаимодействие (запрос + ответы + другие внутренние токены).

total_tool_use_tokens целое число (необязательно)

Количество токенов, присутствующих в подсказках использования инструмента.

InteractionStatusUpdate

event_id строка (необязательно)

Токен event_id, который будет использоваться для возобновления потока взаимодействия с этого события.

event_type object (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "interaction.status_update" .

interaction_id — строка (обязательно)

Описание отсутствует.

перечисление статуса (строка) (обязательно)

Описание отсутствует.

Возможные значения:

in_progress
Взаимодействие продолжается.
requires_action
Для взаимодействия требуется действие/ввод данных от пользователя.
completed
Взаимодействие завершено.
failed
Взаимодействие не удалось.
cancelled
Встреча была отменена.
incomplete
Взаимодействие завершено, но результаты неполные (например, достигнуто значение max_tokens).

StepDelta

delta StepDeltaData (обязательно)

Описание отсутствует.

Возможные типы

АргументыДельта

строка аргументов (необязательно)

Описание отсутствует.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "arguments_delta" .

AudioDelta

каналы целое число (необязательно)

Количество аудиоканалов.

строка данных (необязательно)

Описание отсутствует.

перечисление mime_type (строка) (необязательно)

Описание отсутствует.

Возможные значения:

audio/wav
аудиоформат WAV
audio/mp3
аудиоформат MP3
audio/aiff
аудиоформат AIFF
audio/aac
аудиоформат AAC
audio/ogg
Аудиоформат OGG
audio/flac
аудиоформат FLAC
audio/mpeg
аудиоформат MPEG
audio/m4a
аудиоформат M4A
audio/l16
аудиоформат L16
audio/opus
Аудиоформат OPUS
audio/alaw
Аудиоформат ALAW
audio/mulaw
Аудиоформат MULAW

sample_rate — целое число (необязательно)

Частота дискретизации аудиосигнала.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "audio" .

строка URI (необязательно)

Описание отсутствует.

CodeExecutionCallDelta

аргументы CodeExecutionCallArguments (обязательно)

Описание отсутствует.

Поля

строка кода (необязательно)

Код, который необходимо выполнить.

языковой перечисление (строка) (необязательно)

Язык программирования кода.

Возможные значения:

python
Python >= 3.10, с доступными библиотеками numpy и simpy.

строка подписи (необязательно)

Хэш подписи для проверки данных на стороне бэкэнда.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "code_execution_call" .

CodeExecutionResultDelta

is_error логическое значение (необязательно)

Описание отсутствует.

строка результата (обязательно)

Описание отсутствует.

строка подписи (необязательно)

Хэш подписи для проверки данных на стороне бэкэнда.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "code_execution_result" .

ДокументДельта

строка данных (необязательно)

Описание отсутствует.

перечисление mime_type (строка) (необязательно)

Описание отсутствует.

Возможные значения:

application/pdf
PDF-документ
text/csv
формат документа CSV

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "document" .

строка URI (необязательно)

Описание отсутствует.

FileSearchCallDelta

строка подписи (необязательно)

Хэш подписи для проверки данных на стороне бэкэнда.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "file_search_call" .

FileSearchResultDelta

массив результатов (FileSearchResult) (обязательно)

Описание отсутствует.

строка подписи (необязательно)

Хэш подписи для проверки данных на стороне бэкэнда.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "file_search_result" .

FunctionResultDelta

call_id — строка (обязательно)

Обязательно. Идентификатор, соответствующий идентификатору из блока вызова функции.

is_error логическое значение (необязательно)

Описание отсутствует.

строковое имя (необязательно)

Описание отсутствует.

результирующий массив ( ImageContent или TextContent ) или объект, или строка (обязательно)

Описание отсутствует.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "function_result" .

GoogleMapsCallDelta

arguments GoogleMapsCallArguments (необязательно)

Аргументы, передаваемые инструменту Google Maps.

Поля

массив запросов (строка) (необязательно)

Запросы, подлежащие выполнению.

строка подписи (необязательно)

Хэш подписи для проверки данных на стороне бэкэнда.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "google_maps_call" .

GoogleMapsResultDelta

массив результатов (GoogleMapsResult) (необязательно)

Результаты поиска в Google Maps.

Поля

массив мест (Места) (необязательно)

Места, которые были найдены.

Поля

строковое имя (необязательно)

Название места.

place_id строка (необязательно)

Идентификатор места в формате `places/{place_id}`.

массив review_snippets (ReviewSnippet) (необязательно)

Фрагменты отзывов, используемые для генерации ответов об особенностях того или иного места в Google Maps.

Поля

review_id строка (необязательно)

Идентификатор фрагмента отзыва.

заголовок (необязательно )

Заголовок рецензии.

строка URL (необязательно)

Ссылка, соответствующая отзыву пользователя на Google Maps.

строка URL (необязательно)

URI-ссылка на это место.

widget_context_token строка (необязательно)

Имя ресурса контекстного токена виджета Google Maps.

строка подписи (необязательно)

Хэш подписи для проверки данных на стороне бэкэнда.

тип объекта (обязательно)

Описание отсутствует.

Всегда устанавливайте значение "google_maps_result" .

GoogleSearchCallDelta

arguments GoogleSearchCallArguments (обязательно)

Описание отсутствует.

Поля

queries array (string) (optional)

Web search queries for the following-up web search.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "google_search_call" .

GoogleSearchResultDelta

is_error boolean (optional)

Описание отсутствует.

result array (GoogleSearchResult) (required)

Описание отсутствует.

Поля

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "google_search_result" .

ImageDelta

data string (optional)

Описание отсутствует.

mime_type enum (string) (optional)

Описание отсутствует.

Возможные значения:

image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format

resolution MediaResolution (optional)

The resolution of the media.

Возможные значения

low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.

type object (required)

Описание отсутствует.

Always set to "image" .

uri string (optional)

Описание отсутствует.

TextAnnotationDelta

annotations array (Annotation) (optional)

Citation information for model-generated content.

Возможные типы

FileCitation

A file citation annotation.

custom_metadata object (optional)

User provided metadata about the retrieved context.

document_uri string (optional)

The URI of the file.

end_index integer (optional)

End of the attributed segment, exclusive.

file_name string (optional)

The name of the file.

media_id string (optional)

Media ID in-case of image citations, if applicable.

page_number integer (optional)

Page number of the cited document, if applicable.

исходная строка (необязательно)

Source attributed for a portion of the text.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object (required)

Описание отсутствует.

Always set to "file_citation" .

PlaceCitation

A place citation annotation.

end_index integer (optional)

End of the attributed segment, exclusive.

строковое имя (необязательно)

Title of the place.

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets array (ReviewSnippet) (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Поля

review_id string (optional)

The ID of the review snippet.

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object (required)

Описание отсутствует.

Always set to "place_citation" .

url string (optional)

URI reference of the place.

UrlCitation

A URL citation annotation.

end_index integer (optional)

End of the attributed segment, exclusive.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string (optional)

The title of the URL.

type object (required)

Описание отсутствует.

Always set to "url_citation" .

url string (optional)

The URL.

type object (required)

Описание отсутствует.

Always set to "text_annotation_delta" .

TextDelta

text string (required)

Описание отсутствует.

type object (required)

Описание отсутствует.

Always set to "text" .

ThoughtSignatureDelta

signature string (optional)

Signature to match the backend source to be part of the generation.

type object (required)

Описание отсутствует.

Always set to "thought_signature" .

ThoughtSummaryDelta

content Content (optional)

A new summary item to be added to the thought.

type object (required)

Описание отсутствует.

Always set to "thought_summary" .

UrlContextCallDelta

arguments UrlContextCallArguments (required)

Описание отсутствует.

Поля

urls array (string) (optional)

The URLs to fetch.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "url_context_call" .

UrlContextResultDelta

is_error boolean (optional)

Описание отсутствует.

result array (UrlContextResult) (required)

Описание отсутствует.

Поля

перечисление статуса (строка) (необязательно)

The status of the URL retrieval.

Возможные значения:

success
Url retrieval is successful.
error
Url retrieval is failed due to error.
paywall
Url retrieval is failed because the content is behind paywall.
unsafe
Url retrieval is failed because the content is unsafe.

url string (optional)

The URL that was fetched.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "url_context_result" .

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object (required)

Описание отсутствует.

Always set to "step.delta" .

index integer (required)

Описание отсутствует.

metadata StepDeltaMetadata (optional)

Описание отсутствует.

Поля

total_usage Usage (optional)

Statistics on the interaction request's token usage.

Поля

cached_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of cached token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

grounding_tool_count array (GroundingToolCount) (optional)

Grounding tool count.

Поля

count integer (optional)

The number of grounding tool counts.

тип перечисления (строка) (необязательно)

The grounding tool type associated with the count.

Возможные значения:

google_search
Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.
google_maps
Grounding with Google Maps.

input_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of input token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

output_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of output token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of tool-use token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

total_cached_tokens integer (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer (optional)

Number of tokens in the prompt (context).

total_output_tokens integer (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer (optional)

Number of tokens present in tool-use prompt(s).

StepStart

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object (required)

Описание отсутствует.

Always set to "step.start" .

index integer (required)

Описание отсутствует.

step Step (required)

Описание отсутствует.

StepStop

event_id string (optional)

The event_id token to be used to resume the interaction stream, from this event.

event_type object (required)

Описание отсутствует.

Always set to "step.stop" .

index integer (required)

Описание отсутствует.

step_usage Usage (optional)

Model usage stats for this specific step.

Поля

cached_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of cached token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

grounding_tool_count array (GroundingToolCount) (optional)

Grounding tool count.

Поля

count integer (optional)

The number of grounding tool counts.

тип перечисления (строка) (необязательно)

The grounding tool type associated with the count.

Возможные значения:

google_search
Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.
google_maps
Grounding with Google Maps.

input_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of input token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

output_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of output token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of tool-use token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

total_cached_tokens integer (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer (optional)

Number of tokens in the prompt (context).

total_output_tokens integer (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer (optional)

Number of tokens present in tool-use prompt(s).

usage Usage (optional)

Cumulative model usage stats from the start of the session.

Поля

cached_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of cached token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

grounding_tool_count array (GroundingToolCount) (optional)

Grounding tool count.

Поля

count integer (optional)

The number of grounding tool counts.

тип перечисления (строка) (необязательно)

The grounding tool type associated with the count.

Возможные значения:

google_search
Grounding with Google Web Search and Image Search, & Web Grounding for Enterprise.
google_maps
Grounding with Google Maps.

input_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of input token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

output_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of output token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

tool_use_tokens_by_modality array (ModalityTokens) (optional)

A breakdown of tool-use token usage by modality.

Поля

modality ResponseModality (optional)

The modality associated with the token count.

Возможные значения

text
Indicates the model should return text.
image
Indicates the model should return images.
audio
Indicates the model should return audio.
video
Indicates the model should return video.
document
Indicates the model should return documents.

tokens integer (optional)

Number of tokens for the modality.

total_cached_tokens integer (optional)

Number of tokens in the cached part of the prompt (the cached content).

total_input_tokens integer (optional)

Number of tokens in the prompt (context).

total_output_tokens integer (optional)

Total number of tokens across all the generated responses.

total_thought_tokens integer (optional)

Number of tokens of thoughts for thinking models.

total_tokens integer (optional)

Total token count for the interaction request (prompt + responses + other internal tokens).

total_tool_use_tokens integer (optional)

Number of tokens present in tool-use prompt(s).

Примеры

Error Event

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

Interaction Completed

{
  "event_id": "evt_123",
  "event_type": "interaction.completed",
  "interaction": {
    "created": "2025-12-04T15:01:45Z",
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "status": "completed",
    "updated": "2025-12-04T15:01:45Z"
  }
}

Interaction Completed

{
  "event_id": "evt_123",
  "event_type": "interaction.completed",
  "interaction": {
    "created": "2025-12-04T15:01:45Z",
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "object": "interaction",
    "status": "completed",
    "updated": "2025-12-04T15:01:45Z"
  }
}

Interaction Created

{
  "event_id": "evt_123",
  "event_type": "interaction.created",
  "interaction": {
    "created": "2025-12-04T15:01:45Z",
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3.6-flash",
    "status": "in_progress",
    "updated": "2025-12-04T15:01:45Z"
  }
}

Interaction Created

{
  "event_id": "evt_123",
  "event_type": "interaction.created",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "object": "interaction",
    "status": "in_progress"
  }
}

Interaction Status Update

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

Step Delta

{
  "delta": {
    "type": "text",
    "text": "Hello"
  },
  "event_type": "step.delta",
  "index": 0
}

Step Start

{
  "event_type": "step.start",
  "index": 0,
  "step": {
    "type": "model_output"
  }
}

Step Stop

{
  "event_type": "step.stop",
  "index": 0
}

ResponseFormat

Возможные типы

AudioResponseFormat

Configuration for audio output format.

bit_rate integer (optional)

Bit rate in bits per second (bps). Only applicable for compressed formats (MP3, Opus).

delivery enum (string) (optional)

The delivery mode for the audio output.

Возможные значения:

inline
Audio data is returned inline in the response.
uri
Audio data is returned as a URI.

mime_type enum (string) (optional)

The MIME type of the audio output.

Возможные значения:

audio/mp3
MP3 audio format.
audio/ogg_opus
OGG Opus audio format.
audio/l16
Raw PCM (L16) audio format.
audio/wav
WAV audio format.
audio/alaw
A-law audio format.
audio/mulaw
Mu-law audio format.

sample_rate integer (optional)

Sample rate in Hz.

type object (required)

Описание отсутствует.

Always set to "audio" .

ImageResponseFormat

Configuration for image output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the image output.

Возможные значения:

1:1
1:1 aspect ratio.
2:3
2:3 aspect ratio.
3:2
3:2 aspect ratio.
3:4
3:4 aspect ratio.
4:3
Соотношение сторон 4:3.
4:5
4:5 aspect ratio.
5:4
5:4 aspect ratio.
9:16
9:16 aspect ratio.
16:9
16:9 aspect ratio.
21:9
21:9 aspect ratio.
1:8
1:8 aspect ratio.
8:1
8:1 aspect ratio.
1:4
1:4 aspect ratio.
4:1
4:1 aspect ratio.

delivery enum (string) (optional)

The delivery mode for the image output.

Возможные значения:

inline
Image data is returned inline in the response.
uri
Image data is returned as a URI.

image_size enum (string) (optional)

The size of the image output.

Возможные значения:

512
512px image size.
1K
1K image size.
2K
2K image size.
4K
4K image size.

mime_type enum (string) (optional)

The MIME type of the image output.

Возможные значения:

image/jpeg
JPEG image format.

type object (required)

Описание отсутствует.

Always set to "image" .

TextResponseFormat

Configuration for text output format.

mime_type enum (string) (optional)

The MIME type of the text output.

Возможные значения:

application/json
JSON output format.
text/plain
Plain text output format.

schema object (optional)

The JSON schema that the output should conform to. Only applicable when mime_type is application/json.

type object (required)

Описание отсутствует.

Always set to "text" .

VideoResponseFormat

Configuration for video output format.

aspect_ratio enum (string) (optional)

The aspect ratio for the video output.

Возможные значения:

16:9
16:9 aspect ratio.
9:16
9:16 aspect ratio.

delivery enum (string) (optional)

The delivery mode for the video output.

Возможные значения:

inline
Video data is returned inline in the response.
uri
Video data is returned as a URI.

duration string (optional)

The duration for the video output.

resolution enum (string) (optional)

The video output resolution. Defaults to 720p.

Возможные значения:

360p
360p resolution.
720p
720p resolution.
1080p
1080p resolution.
4k
Разрешение 4K.

type object (required)

Описание отсутствует.

Always set to "video" .

Примеры

Аудиовыход

{
  "type": "audio",
  "sample_rate": 24000
}

Вывод изображения

{
  "type": "image",
  "aspect_ratio": "16:9",
  "image_size": "1K",
  "mime_type": "image/jpeg"
}

Text Output (JSON Schema)

{
  "type": "text",
  "mime_type": "application/json",
  "schema": {
    "type": "object",
    "properties": {
      "ingredients": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "recipe_name": {
        "type": "string"
      }
    },
    "required": [
      "ingredients",
      "recipe_name"
    ]
  }
}

VideoResponseFormat

No examples available for this type.

Шаг

A step in the interaction.

Возможные типы

CodeExecutionCallStep

Code execution call step.

arguments CodeExecutionCallStepArguments (optional)

The arguments to pass to the code execution.

Поля

code string (optional)

The code to be executed.

language enum (string) (optional)

Programming language of the `code`.

Возможные значения:

python
Python >= 3.10, with numpy and simpy available.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "code_execution_call" .

CodeExecutionResultStep

Code execution result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error boolean (optional)

Whether the code execution resulted in an error.

result string (optional)

The output of the code execution.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "code_execution_result" .

FileSearchCallStep

File Search call step.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "file_search_call" .

FileSearchResultStep

File Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "file_search_result" .

FunctionCallStep

A function tool call step.

arguments object (required)

Required. The arguments to pass to the function.

id string (required)

Required. A unique ID for this specific tool call.

name string (required)

Required. The name of the tool to call.

type object (required)

Описание отсутствует.

Always set to "function_call" .

FunctionResultStep

Result of a function tool call.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error boolean (optional)

Whether the tool call resulted in an error.

строковое имя (необязательно)

The name of the tool that was called.

result array ( ImageContent or TextContent ) or object or string (required)

Required. The result of the tool call.

type object (required)

Описание отсутствует.

Always set to "function_result" .

GoogleMapsCallStep

Google Maps call step.

arguments GoogleMapsCallStepArguments (optional)

The arguments to pass to the Google Maps tool.

Поля

queries array (string) (optional)

The queries to be executed.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "google_maps_call" .

GoogleMapsResultStep

Google Maps result step.

call_id string (required)

Required. ID to match the ID from the function call block.

result array (GoogleMapsResultItem) (optional)

Описание отсутствует.

Поля

places array (GoogleMapsResultPlaces) (optional)

Описание отсутствует.

Поля

строковое имя (необязательно)

Описание отсутствует.

place_id string (optional)

Описание отсутствует.

review_snippets array (ReviewSnippet) (optional)

Описание отсутствует.

Поля

review_id string (optional)

The ID of the review snippet.

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

url string (optional)

Описание отсутствует.

widget_context_token string (optional)

Описание отсутствует.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "google_maps_result" .

GoogleSearchCallStep

Google Search call step.

arguments GoogleSearchCallStepArguments (optional)

The arguments to pass to Google Search.

Поля

queries array (string) (optional)

Web search queries for the following-up web search.

id string (required)

Required. A unique ID for this specific tool call.

search_type enum (string) (optional)

The type of search grounding enabled.

Возможные значения:

web_search
Setting this field enables web search. Only text results are returned.
image_search
Setting this field enables image search. Image bytes are returned.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "google_search_call" .

GoogleSearchResultStep

Google Search result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error boolean (optional)

Whether the Google Search resulted in an error.

result array (GoogleSearchResultItem) (optional)

The results of the Google Search.

Поля

search_suggestions string (optional)

Web content snippet that can be embedded in a web page or an app webview.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "google_search_result" .

ModelOutputStep

Output generated by the model.

content array ( Content ) (optional)

Описание отсутствует.

type object (required)

Описание отсутствует.

Always set to "model_output" .

ThoughtStep

A thought step.

signature string (optional)

A signature hash for backend validation.

summary array ( Content ) (optional)

A summary of the thought.

type object (required)

Описание отсутствует.

Always set to "thought" .

UrlContextCallStep

URL context call step.

arguments UrlContextCallArguments (optional)

The arguments to pass to the URL context.

Поля

urls array (string) (optional)

The URLs to fetch.

id string (required)

Required. A unique ID for this specific tool call.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "url_context_call" .

UrlContextResultStep

URL context result step.

call_id string (required)

Required. ID to match the ID from the function call block.

is_error boolean (optional)

Whether the URL context resulted in an error.

result array (UrlContextResult) (optional)

The results of the URL context.

Поля

перечисление статуса (строка) (необязательно)

The status of the URL retrieval.

Возможные значения:

success
Url retrieval is successful.
error
Url retrieval is failed due to error.
paywall
Url retrieval is failed because the content is behind paywall.
unsafe
Url retrieval is failed because the content is unsafe.

url string (optional)

The URL that was fetched.

signature string (optional)

A signature hash for backend validation.

type object (required)

Описание отсутствует.

Always set to "url_context_result" .

UserInputStep

Input provided by the user.

content array ( Content ) (optional)

Описание отсутствует.

type object (required)

Описание отсутствует.

Always set to "user_input" .

Примеры

CodeExecutionCallStep

{
  "type": "code_execution_call",
  "arguments": {
    "code": "print(sum(range(1, 11)))"
  },
  "id": "code_call_71021"
}

CodeExecutionResultStep

{
  "type": "code_execution_result",
  "call_id": "code_call_71021",
  "result": "55\n"
}

FileSearchCallStep

{
  "type": "file_search_call",
  "id": "file_call_88192"
}

FileSearchResultStep

{
  "type": "file_search_result",
  "call_id": "file_call_88192"
}

FunctionCallStep

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

FunctionResultStep

{
  "name": "get_weather",
  "type": "function_result",
  "call_id": "call_98231",
  "result": [
    {
      "type": "text",
      "text": "{\"weather\":\"sunny\"}"
    }
  ]
}

GoogleMapsCallStep

{
  "type": "google_maps_call",
  "arguments": {
    "latitude": 37.7749,
    "longitude": -122.4194
  },
  "id": "maps_call_39201"
}

GoogleMapsResultStep

{
  "type": "google_maps_result",
  "call_id": "maps_call_39201",
  "result": [
    {
      "name": "Golden Gate Park",
      "place_id": "ChIJIQBpAG2ahYAR9R7bNdTLg8M",
      "rating": 4.8
    }
  ]
}

GoogleSearchCallStep

{
  "type": "google_search_call",
  "arguments": {
    "query": "Who won the men's 100m in Paris 2024?"
  },
  "id": "search_call_19201"
}

GoogleSearchResultStep

{
  "type": "google_search_result",
  "call_id": "search_call_19201",
  "result": [
    {
      "title": "Paris 2024 Olympics: Noah Lyles wins men's 100m gold",
      "url": "https://olympics.com/en/news/paris-2024-noah-lyles-wins-mens-100m-gold",
      "snippet": "American Noah Lyles won the Olympic men's 100m gold medal in a photo finish."
    }
  ]
}

ModelOutputStep

{
  "type": "model_output",
  "content": [
    {
      "type": "text",
      "text": "The capital of France is Paris."
    }
  ]
}

ThoughtStep

{
  "type": "thought",
  "signature": "thought_sig_abcd1234",
  "summary": [
    {
      "type": "text",
      "text": "The model is searching Google for the capital of France."
    }
  ]
}

UrlContextCallStep

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

UrlContextResultStep

{
  "type": "url_context_result",
  "call_id": "url_call_10219",
  "result": [
    {
      "title": "Example Domain",
      "url": "https://www.example.com",
      "snippet": "This domain is for use in illustrative examples in documents."
    }
  ]
}

UserInputStep

{
  "type": "user_input",
  "content": [
    {
      "type": "text",
      "text": "What is the capital of France?"
    }
  ]
}

ToolChoiceConfig

The tool choice configuration containing allowed tools.

Поля

allowed_tools AllowedTools (optional)

The allowed tools.

Поля

mode enum (string) (optional)

The mode of the tool choice.

Возможные значения:

auto
Auto tool choice.
any
Any tool choice.
none
No tool choice.
validated
Validated tool choice.

tools array (string) (optional)

The names of the allowed tools.

Примеры

Пример

{
  "allowed_tools": {
    "mode": "any",
    "tools": [
      "my_tool"
    ]
  }
}

ImageContent

An image content block.

Поля

data string (optional)

The image content.

mime_type enum (string) (optional)

The mime type of the image.

Возможные значения:

image/png
PNG image format
image/jpeg
JPEG image format
image/webp
WebP image format
image/heic
HEIC image format
image/heif
HEIF image format
image/gif
GIF image format
image/bmp
BMP image format
image/tiff
TIFF image format

resolution MediaResolution (optional)

The resolution of the media.

Возможные значения

low
Low resolution.
medium
Medium resolution.
high
High resolution.
ultra_high
Ultra high resolution.

type object (optional)

Описание отсутствует.

Always set to "image" .

uri string (optional)

The URI of the image.

Примеры

Изображение

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

TextContent

A text content block.

Поля

annotations array (Annotation) (optional)

Citation information for model-generated content.

Возможные типы

FileCitation

A file citation annotation.

custom_metadata object (optional)

User provided metadata about the retrieved context.

document_uri string (optional)

The URI of the file.

end_index integer (optional)

End of the attributed segment, exclusive.

file_name string (optional)

The name of the file.

media_id string (optional)

Media ID in-case of image citations, if applicable.

page_number integer (optional)

Page number of the cited document, if applicable.

исходная строка (необязательно)

Source attributed for a portion of the text.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object (required)

Описание отсутствует.

Always set to "file_citation" .

PlaceCitation

A place citation annotation.

end_index integer (optional)

End of the attributed segment, exclusive.

строковое имя (необязательно)

Title of the place.

place_id string (optional)

The ID of the place, in `places/{place_id}` format.

review_snippets array (ReviewSnippet) (optional)

Snippets of reviews that are used to generate answers about the features of a given place in Google Maps.

Поля

review_id string (optional)

The ID of the review snippet.

title string (optional)

Title of the review.

url string (optional)

A link that corresponds to the user review on Google Maps.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

type object (required)

Описание отсутствует.

Always set to "place_citation" .

url string (optional)

URI reference of the place.

UrlCitation

A URL citation annotation.

end_index integer (optional)

End of the attributed segment, exclusive.

start_index integer (optional)

Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.

title string (optional)

The title of the URL.

type object (required)

Описание отсутствует.

Always set to "url_citation" .

url string (optional)

The URL.

text string (optional)

Required. The text content.

type object (optional)

Описание отсутствует.

Always set to "text" .

Примеры

Текст

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