AIImage

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

AIImage(nexus, connectName)

---

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

Параметры:

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

generate(prompt, messageOptions, eventOptions, eventRejectOptions)

---

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

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
prompt	String	Да	Нет
messageOptions	Object	Нет	{}
eventOptions	Object	Нет	{}
eventRejectOptions	Object	Нет	{}

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

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

Поле	Тип	Обязательное	Значение по умолчанию
event_name	String	Да	Нет
table_name	String	Нет	ain_ai_message
record_sys_id	String	Нет	sys_id созданного ain_ai_message
process_started_at	String	Нет	Нет
param_2	String	Нет	Нет
param_3	String	Нет	Нет
param_4	String	Нет	Нет
param_5	String	Нет	Нет

• Определите параметр eventRejectOptions, чтобы в случае отрицательного ответа сервиса было инициировано событие с указанными параметрами.
  • Ключ param_1 зарезервирован и всегда содержит sys_id созданного ain_ai_message.
  • Вы можете добавить местозаполнители для подстановки атрибутов соответствующего ain_ai_message. Пример: param_1: "${message.completion}"

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

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

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

Поле	Тип	Обязательно	Значение по умолчанию
event_name	String	Да	Нет
table_name	String	Нет	ain_ai_message
record_sys_id	String	Нет	sys_id созданного ain_ai_message
process_started_at	String	Нет	Нет
param_2	String	Нет	Нет
param_3	String	Нет	Нет
param_4	String	Нет	Нет
param_5	String	Нет	Нет

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

Тип	Описание
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());

setTag(tagName)

---

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

Параметры:

Название	Тип	Обязательный	Описание
tagName	String	Да	Значение тега, который будет присвоен механизму.

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

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

Пример:

  const AI_ASSISTANT_ID = '170510242421430374';
  
ss.importIncludeScript('AIChat');
const chat= new AIChat();
chat.setUser(AI_ASSISTANT_ID); 
chat.setTag('UserQueryAnalysis');
const messageId = chat.completion(
    'Сколько звезд в небе?',
    { temperature: 0.6 },
    {
        event_name: "my_event",
        table_name: "task",
        record_sys_id: "170014704227406837",
    }
);
 
ss.info(messageId);

setTimeout(duration)

---

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

Параметры:

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

Возвращает:

Тип	Описание
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()

setUser(userID)

---

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

Параметры:

Название	Тип	Обязательный	Описание
userID	String	Да	ID пользователя, от имени которого будет запущен ИИ.

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

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

Пример:

  const AI_ASSISTANT_ID = '170510242421430374';
  
ss.importIncludeScript('AIChat');
const chat= new AIChat();
chat.setUser(AI_ASSISTANT_ID); 
chat.setTag('UserQueryAnalysis');
const messageId = chat.completion(
    'Сколько звезд в небе?',
    { temperature: 0.6 },
    {
        event_name: "my_event",
        table_name: "task",
        record_sys_id: "170014704227406837",
    }
);
 
ss.info(messageId);