AIChat
Этот класс серверного API содержит методы для отправки сообщений, через нексусы типа "чат" в AIService.
AIChat(nexus, connectName)
Используйте этот метод, чтобы инициализировать класс AIChat для указанного нексуса и коннекта.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
nexus | String | Нет | Принимает значение, указанное в свойстве ain.api.chat.default_nexus. |
connectName | String | Нет | Принимает значение, указанное в свойстве ain.ai_connect.default. |
Возвращаемое значение:
Тип | Описание |
---|---|
Void | Метод не возвращает значение. |
completion(prompt, messageOptions, eventOptions, eventRejectOptions)
Используйте этот метод для отправки сообщения в AI сервис чата.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
prompt | String, Array или Object | Да | Нет |
messageOptions | Object | Нет | |
eventOptions | Object | Нет | |
eventRejectOptions | Object | Нет |
-
Параметр prompt может обрабатывать:
- произвольную строку.
- объект формата -
{content: "example", role: "user"}
- массив объектов формата, указанных выше.
-
Параметр messageOptions позволяет переопределить дефолтные и дополнить отсутствующие опции нексуса при отправке запроса к сервису.
-
Параметр eventOptions позволяет создать событие при условии положительного ответа сервиса.
- Ключ param_1 зарезервирован и всегда содержит sys_id созданного ain_ai_message.
- Вы можете добавить местозаполнитель для подстановки атрибутов соответствующего ain_ai_message.
Пример: param_1:
"${message.complition}"
Ключи, которые могут быть обработаны:
Поле | Тип | Обязательное | Значение |
---|---|---|---|
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.complition}"
Условия для инициирования события:
- сервис сообщил об ошибке.
- не удалось обработать ответ сервиса.
- не удалось обработать eventOptions.
- при превышении времени ожидания ответа от сервиса, если оно было задано с помощью метода (setTimeout).