Skip to main content

AIImage

Этот класс серверного API содержит методы для создания изображений с участием ИИ по текстовому описанию через нексусы типа image в AIService.

AIImage(nexus, connectName)​

Инициализирует экземпляр класса AIImage для указанного нексуса и коннекта.

Параметры:

НазваниеТипОбязательноеЗначение по умолчанию
nexusStringНетПринимает значение, указанное в свойстве ain.api.image.default_nexus.
connectNameStringНетПринимает значение, указанное в свойстве ain.ai_connect.default.

generate(prompt, messageOptions, eventOptions, eventRejectOptions)​

Используйте этот метод отправки сообщения в AI сервис для создания медиафайла на основании текста.

Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
promptStringДаНет
messageOptionsObjectНет{}
eventOptionsObjectНет{}
eventRejectOptionsObjectНет{}
  • С помощью параметра messageOptions вы можете переопределить дефолтные и дополнить отсутствующие опции нексуса при отправке запроса к сервису.
  • При установке eventOptions в случае положительного ответа сервиса будет инициировано событие с указанными параметрами.
    • Ключ param_1 зарезервирован и всегда содержит sys_id созданного ain_ai_message.
    • Вы можете добавить местозаполнитель для подстановки атрибутов соответствующего ain_ai_message. Пример: param_1: "${message.completion}"

Ключи, которые могут быть обработаны:

ПолеТипОбязательноеЗначение по умолчанию
event_nameStringДаНет
table_nameStringНетain_ai_message
record_sys_idStringНетsys_id созданного ain_ai_message
process_started_atStringНетНет
param_2StringНетНет
param_3StringНетНет
param_4StringНетНет
param_5StringНетНет
  • Определите параметр eventRejectOptions, чтобы в случае отрицательного ответа сервиса было инициировано событие с указанными параметрами.
    • Ключ param_1 зарезервирован и всегда содержит sys_id созданного ain_ai_message.
    • Вы можете добавить местозаполнители для подстановки атрибутов соответствующего ain_ai_message. Пример: param_1: "${message.completion}"

Условия для инициирования события:

  • сервис сообщил об ошибке,
  • не удалось обработать ответ сервиса,
  • не удалось обработать eventOptions,
  • при превышении времени ожидания ответа от сервиса, если оно было задано с помощью метода setTimeout

Ключи, которые могут быть обработаны:

ПолеТипОбязательноЗначение по умолчанию
event_nameStringДаНет
table_nameStringНетain_ai_message
record_sys_idStringНетsys_id созданного ain_ai_message
process_started_atStringНетНет
param_2StringНетНет
param_3StringНетНет
param_4StringНетНет
param_5StringНетНет

Возвращаемое значение:

ТипОписание
StringМетод возвращает sys_id созданного AI Message. Если AI Message создать не удалось, метод возвращает 0.

Пример:

generate()
ss.importIncludeScript('AIImage');
const image = new AIImage();
const messageId = image.generate(
    'Нарисуй закат в Сыктывкаре',
    {
        size: "512x512",
        n: 2,
    },
    {
        event_name: "my_event",
        table_name: "task",
        record_sys_id: "170014704227406837",
        param_2: "${message.completion}"
    }
);
 
ss.info(messageId);

getErrors()​

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

ТипОписание
Array of StringsМетод возвращает список ошибок.

Пример:

getErrors()
ss.importIncludeScript('AIImage');
const image = new AIImage();
const messageId = image.generate(
    'Нарисуй закат в Сыктывкаре',
    {
        size: "512x512",
        n: 2,
    },
);
 
ss.info(image.getErrors());

setTimeout(duration)​

Используйте метод для того, чтобы установить максимальное время ожидания ответа от сервиса в секундах. Если установленное время будет превышено, сообщение будет переведено в статус Ошибка, а также будет инициировано reject событие, если оно было задано в eventRejectOptions.

Параметры:

НазваниеТипОбязательныйЗначение по умолчанию
durationIntegerДаНет

Возвращает:

ТипОписание
VoidМетод не возвращает значения.

Пример:

setTimeout()
ss.importIncludeScript('AIImage');
const image = new AIImage();
image.setTimeout(3600);
const messageId = image.generate(
    'Нарисуй закат в Сыктывкаре',
    {
        size: "512x512",
        n: 2,
    },
);
AIImage(nexus, connectName)
generate(prompt, messageOptions, eventConfig)
getErrors()