Объект Message

Описание

Message — это объект, который хранит сообщение для модели и возвращает её ответ.

Все промпты, файлы и параметры для создания генерации нейронной модели хранятся в этом объекте. Пользователь отправляет модели только один Message, который служит телом POST-запроса.

Нейронная модель возвращает результат генерации, упакованый в отдельный объект Message.

Технически, объект Message представляет собой JSON-объект.

Ключи объекта Message

Ключи при отправке запроса

  • content: текстовый промпт (входные данные) для модели.

  • file: медиа-файл (изображение или документ (PDF, DOC/DOCX, XLSX), подгружаемый в качестве допольнительных входных данных для нейронной модели.

    В зависимости от конкретной генеративной модели, ключи content и file могут быть как взаимоисключающими, так и дополняющими друг друга. В подавляющем большинстве модели, поддерживаемые AIR, принимают на вход именно текстовый content.

  • info: вложенный JSON-объект, представляющий собой конфигурацию параметров для модели. Для каждой модели существует свой уникальный набор параметров. Подробнее о создании ключа info с параметрами можно узнать на вкладке Объект модели.

Ключи при получении ответа

  • uid: Уникальный идентификатор сообщения.

  • content: Текстовый ответ от модели. Либо строка, либо null.

  • file: Медиа-ответ от модели. Либо URL для скачивания, либо null.

  • created_at: Время создания сообщения в формате ISO 8601: YYYY-MM-DDThh-mm-ss.ms+TZ.

  • elapsed_time: Время, затраченное на генерацию ответа, в формате hh-mm-ss.ms.

  • info: Параметры, которые использовались при генерации ответа. По умолчанию - {}, пустой JSON.

Пример вида объекта Message

[
    {
        "uid": "c8328e54-e936-4015-9227-469b8925914c",
        "content": "Hello! How can I assist you today?",
        "file": null,
        "created_at": "2023-11-11T17:49:48.962314+03:00",
        "elapsed_time": "00:00:01.969683",
        "info": {}
    }
]