Final add with doc and agent

docs/agents/createClassInstanceAgent.md

@@ -0,0 +1,44 @@
+# Create class instance agent
+
+This agent creates an instance of the entity class.
+
+**Action class:**
+
+`action_create_class_instance`
+
+**Parameters:**
+
+1. `messageAddr` -- an element of `concept_message`.
+2. `formLinkAddr` -- link with information from popup component.
+
+### Examples
+
+**Example of an input structure:**
+
+<img src="../images/createClassInstanceAgentInput.png"></img>
+
+**Examples of an output structure:**
+
+Output about the successful creation of structures.
+
+<img src="../images/createClassInstanceAgentOutput1.png"></img>
+
+Error output about invalid or existing parameters.
+
+<img src="../images/createClassInstanceAgentOutput2.png"></img>
+
+Output to notify when the user has completed an action.
+
+<img src="../images/createClassInstanceAgentOutput3.png"></img>
+
+The result of the agent's work depends on the data received from the component.If the received data is correct, the structures will be created. Otherwise, a corresponding error message will be displayed.
+
+### Agent implementation language
+C++
+
+### Result
+
+Possible result codes:
+
+* `SC_RESULT_OK` - the constructs (message class, phrase templates and logical response rule) were successfully created or formLinkAddr contains incorrect data.
+* `SC_RESULT_ERROR`- internal error.

docs/agents/createClassInstanceAgent.ru.md

@@ -0,0 +1,44 @@
+# Агент создания экземпляра класса сущностей
+
+Данный агент создает экземпляр класса сущностей.
+
+**Класс действий:**
+
+`action_create_class_instance`
+
+**Параметры:**
+
+1. `messageAddr` -- элемент класса `concept_message`.
+2. `formLinkAddr` -- ссылка на информацию из всплывающего компонента.
+
+### Пример
+
+**Пример входной структуры:**
+
+<img src="../images/createClassInstanceAgentInput.png"></img>
+
+**Примеры выходной конструкции:**
+
+Вывод об успешном создании структур.
+
+<img src="../images/createClassInstanceAgentOutput1.png"></img>
+
+Вывод ошибки о недопустимых или существующих параметрах.
+
+<img src="../images/createClassInstanceAgentOutput2.png"></img>
+
+Вывод для уведомления о завершении действия пользователем.
+
+<img src="../images/createClassInstanceAgentOutput3.png"></img>
+
+Результат работы агента зависит от данных, полученных от компонента. Если полученные данные верны, структуры будут созданы. В противном случае отобразится соответствующее сообщение об ошибке.
+
+### Язык реализации агента
+C++
+
+### Результат
+
+Возможные результаты:
+
+* `SC_RESULT_OK` - конструкции (класс сообщения, шаблоны фраз и правило логического ответа) были успешно созданы или formLinkAddr содержит неверные данные.
+* `SC_RESULT_ERROR`- внутренняя ошибка.

docs/changelog.md

@@ -57,3 +57,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add SD of intelligent studying systems
 - Add SD of dialogues
 - Add SD of messages
+
+## 14.04.2024
+
+### Added
+
+- Add popup components for creating an instances of the entity classes
+- Add help-functions for components
+- Add agent for creating constructions of instances of the entity classes

docs/index.md

@@ -20,6 +20,10 @@
     * [Change interface color agent](agents/changeInterfaceColorAgent.md)
     * [Find word in set by first letter agent](agents/findWordInSetByFirstLetter.md)
     * [Weather agent](agents/weatherAgent.md)
+    * [Create an instance of the entity class agent](agents/createClassInstanceAgent.md)
+
+- **User interface**
+    * [Popup component for creating an instance of the entity class](ui/popupComponentForCreatingClassInstance.md)
 
 - **Patterns**
     * [Knowledge base patterns](patterns/kb-patterns.md)

docs/index.ru.md

@@ -20,6 +20,10 @@
     * [Агент смены цвета компонента интерфейса](agents/changeInterfaceColorAgent.ru.md)
     * [Агент поиска слова по первой букве](agents/findWordInSetByFirstLetter.ru.md)
     * [Агент прогноза погоды](agents/weatherAgent.ru.md)
+    * [Агент создания экземпляра класса сущностей](agents/createClassInstanceAgent.ru.md)
+
+- **Пользовательский интерфейс**
+    * [Всплывающее окно для создания экземпляра класса сущностей](ui/popupComponentForCreatingClassInstance.ru.md) 
 
 - **Шаблоны**
     * [Шаблоны для базы знаний](patterns/kb-patterns.ru.md)

docs/ui/popupComponentForCreatingClassInstance.md

@@ -0,0 +1,33 @@
+User interface component (pop-up window) for creating a class instance
+
+This component is used to create an instance of the entity class.
+
+**Phrase for calling the component**
+
+`Создай экземпляр класса`
+
+**Action Class:**
+
+`action_create_class_instance`
+
+### Description
+
+<img src="../images/messageClassInstancePopup1.png"></img>
+
+This state of the component is a form, by filling in which data about the system class identifier, about the class identifier in Russian and about the name of the intent in the wit.ai for further processing by the appropriate agent. To move to the next state of the component and save the form data, click the "Next" button.
+
+<img src="../images/messageClassInstancePopup2.png"></img>
+
+This state of the component is a form, by filling in which data is stored about the system identifier of the phrase template, about the identifier of the phrase template in Russian and about phrases for further processing by the appropriate agent. In this form, the chip component (compact elements representing input data) is used to add an arbitrary number of phrases. To save the form data and create structures, click the "Save" button.
+
+### Component implementation language
+
+TypeScript
+
+### Result
+
+Possible results:
+
+* `Экземпляр класса создан` - constructs have been successfully created.
+* `Вы ввели существующий в базе знаний системный идентификатор, либо не ввели основной идентификатор или определение.`- the data entered by the user already exists in the knowledge base or user has not entered all the data.
+* `Дейстиве прервано пользователем.` - the user has closed the component.

docs/ui/popupComponentForCreatingClassInstance.ru.md

@@ -0,0 +1,33 @@
+# Компонент пользовательского интерфейса (всплывающее окно) для создания экземпляра класса сущностей
+
+Данный компонент используется для создания экземпляра класса сущностей.
+
+**Фраза для вызова компонента**
+
+`Создай экземпляр класса`
+
+**Класс действий:**
+
+`action_create_class_instance`
+
+### Описание
+
+<img src="../images/messageClassInstancePopup1.png"></img>
+
+Данное состояние компонента представляет собой форму, посредством заполнения которой, сохраняются данные о системном идентификаторе экземпляра, об идентификаторе экземпляра на русском языке, об определении экземпляра и о классе, которому экземпляр принадлежит для дальнейшей обработки соответствующим агентом. Для добавления дополнительных отношений между другими сущностями необходимо нажать кнопку "Добавить отношения". Для сохранению данных формы и создания структур необходимо нажать кнопку "Сохранить".
+
+<img src="../images/messageClassInstancePopup2.png"></img>
+
+Данное состояние компонента представляет собой форму, посредством заполнения которой, сохраняются данные о сущности, с которой пользователь связывает создаваемый экземпляр и об отношении, которым понятия будут связаны. Для сохранения отношения необходимо нажать кнопку "Добавить". Для сохранения всех данных и создания структур необходимо нажать кнопку "Сохранить".
+
+### Язык реализации компонента
+
+TypeScript
+
+### Результат
+
+Возможные результаты:
+
+* `Экземпляр класса создан` - конструкции были успешно созданы.
+* `Вы ввели существующий в базе знаний системный идентификатор, либо не ввели основной идентификатор или определение.`- данные введённые пользователем уже существуют в базе знаний или пользователь не ввёл все данные.
+* `Дейстиве прервано пользователем.` - пользователь закрыл компонент.