@seafteam/seaf-archtool-core-plugin-suite 2026.29.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (298) hide show
  1. package/LICENSE +201 -0
  2. package/NOTICE +27 -0
  3. package/documentation/arch/aspects.yaml +81 -0
  4. package/documentation/arch/components/browser.yaml +51 -0
  5. package/documentation/arch/components/examples/context.yaml +37 -0
  6. package/documentation/arch/components/examples/order.yaml +92 -0
  7. package/documentation/arch/components/examples/payment.yaml +92 -0
  8. package/documentation/arch/components/examples/root.yaml +42 -0
  9. package/documentation/arch/components/front.yaml +309 -0
  10. package/documentation/arch/components/gitlab.yaml +81 -0
  11. package/documentation/arch/components/plantuml.yaml +57 -0
  12. package/documentation/arch/components/root.yaml +36 -0
  13. package/documentation/arch/components/user.yaml +41 -0
  14. package/documentation/arch/components/web.yaml +39 -0
  15. package/documentation/arch/contexts.yaml +99 -0
  16. package/documentation/arch/forms.yaml +36 -0
  17. package/documentation/arch/namespaces.yaml +43 -0
  18. package/documentation/arch/root.yaml +43 -0
  19. package/documentation/arch/rules.yaml +91 -0
  20. package/documentation/arch/technologies.yaml +84 -0
  21. package/documentation/dochub.yaml +32 -0
  22. package/documentation/docs/conception/archdistrib.puml +38 -0
  23. package/documentation/docs/conception/archeco.puml +11 -0
  24. package/documentation/docs/conception/archeco_proc.puml +29 -0
  25. package/documentation/docs/conception/archver.puml +24 -0
  26. package/documentation/docs/conception/facade.puml +20 -0
  27. package/documentation/docs/conception/introduction.md +144 -0
  28. package/documentation/docs/conception/mindmap.puml +55 -0
  29. package/documentation/docs/conception/root.yaml +66 -0
  30. package/documentation/docs/manual/aspects.md +37 -0
  31. package/documentation/docs/manual/backend/api.yaml +664 -0
  32. package/documentation/docs/manual/backend/search-implementation.md +190 -0
  33. package/documentation/docs/manual/backend/search.yaml +495 -0
  34. package/documentation/docs/manual/clickstream-setup.md +50 -0
  35. package/documentation/docs/manual/components.md +45 -0
  36. package/documentation/docs/manual/config/deployment.md +337 -0
  37. package/documentation/docs/manual/context_source.puml +17 -0
  38. package/documentation/docs/manual/contexts.md +200 -0
  39. package/documentation/docs/manual/datasets.md +120 -0
  40. package/documentation/docs/manual/docs/AI_TABLE_INTEGRATION.md +81 -0
  41. package/documentation/docs/manual/docs/asyncapi.md +63 -0
  42. package/documentation/docs/manual/docs/bpmn.md +122 -0
  43. package/documentation/docs/manual/docs/charts.md +371 -0
  44. package/documentation/docs/manual/docs/docs.md +76 -0
  45. package/documentation/docs/manual/docs/drawio_intro.md +397 -0
  46. package/documentation/docs/manual/docs/editable_table/menu.yaml +5 -0
  47. package/documentation/docs/manual/docs/editable_table/root.yaml +9 -0
  48. package/documentation/docs/manual/docs/editable_table/step_0_base/menu.yaml +6 -0
  49. package/documentation/docs/manual/docs/editable_table/step_0_base/root.yaml +3 -0
  50. package/documentation/docs/manual/docs/editable_table/step_0_base/table.yaml +396 -0
  51. package/documentation/docs/manual/docs/editable_table/step_0_base/template.md +404 -0
  52. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/menu.yaml +5 -0
  53. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/root.yaml +3 -0
  54. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/table.yaml +136 -0
  55. package/documentation/docs/manual/docs/editable_table/step_1_acquaintance/template.md +247 -0
  56. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/pets.yaml +23 -0
  57. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/data/root.yaml +2 -0
  58. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/menu.yaml +34 -0
  59. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/root.yaml +4 -0
  60. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/table.yaml +36 -0
  61. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_root.md +110 -0
  62. package/documentation/docs/manual/docs/editable_table/step_2_parameterization/template_table.md +3 -0
  63. package/documentation/docs/manual/docs/editable_table/step_3_headers/menu.yaml +6 -0
  64. package/documentation/docs/manual/docs/editable_table/step_3_headers/root.yaml +2 -0
  65. package/documentation/docs/manual/docs/editable_table/step_3_headers/template.md +300 -0
  66. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/data.yaml +10 -0
  67. package/documentation/docs/manual/docs/editable_table/step_4_editing/data/root.yaml +2 -0
  68. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/data_column_1.yaml +3 -0
  69. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/data/root.yaml +2 -0
  70. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/menu.yaml +6 -0
  71. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/root.yaml +4 -0
  72. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/table.yaml +52 -0
  73. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/auto_imports/template.md +117 -0
  74. package/documentation/docs/manual/docs/editable_table/step_4_editing/examples/root.yaml +2 -0
  75. package/documentation/docs/manual/docs/editable_table/step_4_editing/menu.yaml +6 -0
  76. package/documentation/docs/manual/docs/editable_table/step_4_editing/root.yaml +5 -0
  77. package/documentation/docs/manual/docs/editable_table/step_4_editing/table.yaml +116 -0
  78. package/documentation/docs/manual/docs/editable_table/step_4_editing/template.md +231 -0
  79. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/data.yaml +30 -0
  80. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/menu.yaml +5 -0
  81. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/root.yaml +4 -0
  82. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/table.yaml +122 -0
  83. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/base_example/template.md +276 -0
  84. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/data.yaml +11 -0
  85. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/menu.yaml +5 -0
  86. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/root.yaml +4 -0
  87. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/table.yaml +40 -0
  88. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/hiding_columns/template.md +59 -0
  89. package/documentation/docs/manual/docs/editable_table/step_5_styles/examples/root.yaml +3 -0
  90. package/documentation/docs/manual/docs/editable_table/step_5_styles/menu.yaml +5 -0
  91. package/documentation/docs/manual/docs/editable_table/step_5_styles/root.yaml +4 -0
  92. package/documentation/docs/manual/docs/editable_table/step_5_styles/table.yaml +35 -0
  93. package/documentation/docs/manual/docs/editable_table/step_5_styles/template.md +142 -0
  94. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/data.yaml +40 -0
  95. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/menu.yaml +5 -0
  96. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/root.yaml +4 -0
  97. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/table.yaml +77 -0
  98. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/data_errors/template.md +146 -0
  99. package/documentation/docs/manual/docs/editable_table/step_6_errors/examples/root.yaml +2 -0
  100. package/documentation/docs/manual/docs/editable_table/step_6_errors/menu.yaml +5 -0
  101. package/documentation/docs/manual/docs/editable_table/step_6_errors/root.yaml +3 -0
  102. package/documentation/docs/manual/docs/editable_table/step_6_errors/template.md +3 -0
  103. package/documentation/docs/manual/docs/editable_table/template.md +24 -0
  104. package/documentation/docs/manual/docs/examples/asyncapi.yaml +77 -0
  105. package/documentation/docs/manual/docs/examples/asyncapi_template.json +11 -0
  106. package/documentation/docs/manual/docs/examples/autors.yaml +30 -0
  107. package/documentation/docs/manual/docs/examples/bpmn.xml +44 -0
  108. package/documentation/docs/manual/docs/examples/cat.jpg +0 -0
  109. package/documentation/docs/manual/docs/examples/charts-bar.yaml +61 -0
  110. package/documentation/docs/manual/docs/examples/charts-bubble.yaml +47 -0
  111. package/documentation/docs/manual/docs/examples/charts-doughnut.yaml +42 -0
  112. package/documentation/docs/manual/docs/examples/charts-line.yaml +55 -0
  113. package/documentation/docs/manual/docs/examples/charts-pie.yaml +37 -0
  114. package/documentation/docs/manual/docs/examples/charts-polararea.yaml +54 -0
  115. package/documentation/docs/manual/docs/examples/charts-radar.yaml +50 -0
  116. package/documentation/docs/manual/docs/examples/charts-scatter.yaml +48 -0
  117. package/documentation/docs/manual/docs/examples/charts.yaml +91 -0
  118. package/documentation/docs/manual/docs/examples/contexts.jsonata +8 -0
  119. package/documentation/docs/manual/docs/examples/date-picker-example.md +5 -0
  120. package/documentation/docs/manual/docs/examples/example.html +2 -0
  121. package/documentation/docs/manual/docs/examples/example.puml +17 -0
  122. package/documentation/docs/manual/docs/examples/example.yaml +53 -0
  123. package/documentation/docs/manual/docs/examples/ext-schema.yaml +3 -0
  124. package/documentation/docs/manual/docs/examples/inlinemeta.md +25 -0
  125. package/documentation/docs/manual/docs/examples/markaper.yaml +225 -0
  126. package/documentation/docs/manual/docs/examples/mermaid.mmd +32 -0
  127. package/documentation/docs/manual/docs/examples/openapi_template.json +16 -0
  128. package/documentation/docs/manual/docs/examples/pizza-collaboration.xml +383 -0
  129. package/documentation/docs/manual/docs/examples/sa-anim.yaml +209 -0
  130. package/documentation/docs/manual/docs/examples/sa-complex-hide-boundary.yaml +94 -0
  131. package/documentation/docs/manual/docs/examples/sa-complex-hide-leaves.yaml +94 -0
  132. package/documentation/docs/manual/docs/examples/sa-complex-hide-title.yaml +98 -0
  133. package/documentation/docs/manual/docs/examples/sa-complex.yaml +92 -0
  134. package/documentation/docs/manual/docs/examples/sa-gravity.yaml +104 -0
  135. package/documentation/docs/manual/docs/examples/sa-group.yaml +93 -0
  136. package/documentation/docs/manual/docs/examples/sa-physical-connection.yaml +79 -0
  137. package/documentation/docs/manual/docs/examples/sa-query.jsonata +74 -0
  138. package/documentation/docs/manual/docs/examples/sa-symbol.yaml +72 -0
  139. package/documentation/docs/manual/docs/examples/sa-through-objects.yaml +46 -0
  140. package/documentation/docs/manual/docs/examples/sa-without-tips.yaml +43 -0
  141. package/documentation/docs/manual/docs/examples/showcases.jsonata +5 -0
  142. package/documentation/docs/manual/docs/examples/smartants_.yaml +160 -0
  143. package/documentation/docs/manual/docs/examples/table.yaml +341 -0
  144. package/documentation/docs/manual/docs/examples/template.puml +6 -0
  145. package/documentation/docs/manual/docs/examples/test.jsonata +3 -0
  146. package/documentation/docs/manual/docs/examples/toc/2header.md +8 -0
  147. package/documentation/docs/manual/docs/examples/toc/custom-toc-place-dup.md +37 -0
  148. package/documentation/docs/manual/docs/examples/toc/custom-toc-place.md +35 -0
  149. package/documentation/docs/manual/docs/examples/toc/root.yaml +38 -0
  150. package/documentation/docs/manual/docs/examples/toc/test.md +160 -0
  151. package/documentation/docs/manual/docs/gigachat/agents/aigena/menu.yaml +5 -0
  152. package/documentation/docs/manual/docs/gigachat/agents/aigena/root.yaml +2 -0
  153. package/documentation/docs/manual/docs/gigachat/agents/aigena/template.md +25 -0
  154. package/documentation/docs/manual/docs/gigachat/agents/menu.yaml +5 -0
  155. package/documentation/docs/manual/docs/gigachat/agents/react/gigachat.yaml +59 -0
  156. package/documentation/docs/manual/docs/gigachat/agents/react/menu.yaml +5 -0
  157. package/documentation/docs/manual/docs/gigachat/agents/react/root.yaml +3 -0
  158. package/documentation/docs/manual/docs/gigachat/agents/react/template.md +138 -0
  159. package/documentation/docs/manual/docs/gigachat/agents/root.yaml +5 -0
  160. package/documentation/docs/manual/docs/gigachat/agents/simple/gigachat.yaml +14 -0
  161. package/documentation/docs/manual/docs/gigachat/agents/simple/menu.yaml +5 -0
  162. package/documentation/docs/manual/docs/gigachat/agents/simple/root.yaml +3 -0
  163. package/documentation/docs/manual/docs/gigachat/agents/simple/template.md +113 -0
  164. package/documentation/docs/manual/docs/gigachat/agents/template.md +62 -0
  165. package/documentation/docs/manual/docs/gigachat/menu.yaml +5 -0
  166. package/documentation/docs/manual/docs/gigachat/root.yaml +4 -0
  167. package/documentation/docs/manual/docs/gigachat/settings/menu.yaml +5 -0
  168. package/documentation/docs/manual/docs/gigachat/settings/root.yaml +2 -0
  169. package/documentation/docs/manual/docs/gigachat/settings/template.md +51 -0
  170. package/documentation/docs/manual/docs/gigachat/template.md +38 -0
  171. package/documentation/docs/manual/docs/images/cloud.png +0 -0
  172. package/documentation/docs/manual/docs/images/component.png +0 -0
  173. package/documentation/docs/manual/docs/images/system.png +0 -0
  174. package/documentation/docs/manual/docs/images/user.png +0 -0
  175. package/documentation/docs/manual/docs/markaper.md +278 -0
  176. package/documentation/docs/manual/docs/markdown.md +148 -0
  177. package/documentation/docs/manual/docs/mermaid.md +43 -0
  178. package/documentation/docs/manual/docs/network.md +117 -0
  179. package/documentation/docs/manual/docs/plantuml.md +28 -0
  180. package/documentation/docs/manual/docs/root.yaml +736 -0
  181. package/documentation/docs/manual/docs/seaf2drawio/examples/basic.yaml +13 -0
  182. package/documentation/docs/manual/docs/seaf2drawio/examples/diff.yaml +123 -0
  183. package/documentation/docs/manual/docs/seaf2drawio/examples/example_seaf_data.yaml +1689 -0
  184. package/documentation/docs/manual/docs/seaf2drawio/examples/root.yaml +5 -0
  185. package/documentation/docs/manual/docs/seaf2drawio/examples/templates.yaml +55 -0
  186. package/documentation/docs/manual/docs/seaf2drawio/examples/transformation.yaml +19 -0
  187. package/documentation/docs/manual/docs/seaf2drawio/object_description.md +35 -0
  188. package/documentation/docs/manual/docs/seaf2drawio/root.yaml +12 -0
  189. package/documentation/docs/manual/docs/seaf2drawio/seaf2drawio.md +118 -0
  190. package/documentation/docs/manual/docs/smartants.md +583 -0
  191. package/documentation/docs/manual/docs/svg_inline.md +66 -0
  192. package/documentation/docs/manual/docs/swagger.md +52 -0
  193. package/documentation/docs/manual/docs/tables.md +264 -0
  194. package/documentation/docs/manual/docs/templates/example.drawio +43 -0
  195. package/documentation/docs/manual/docs/templates/test.svg +79 -0
  196. package/documentation/docs/manual/docs/templates.md +361 -0
  197. package/documentation/docs/manual/docs/toc.md +137 -0
  198. package/documentation/docs/manual/entities/bstages.md +43 -0
  199. package/documentation/docs/manual/entities/bundle.md +105 -0
  200. package/documentation/docs/manual/entities/entities.md +727 -0
  201. package/documentation/docs/manual/entities/images/id_errors.png +0 -0
  202. package/documentation/docs/manual/entities/images/landspace.jpeg +0 -0
  203. package/documentation/docs/manual/entities/images/menu-single.jpeg +0 -0
  204. package/documentation/docs/manual/entities/images/menu-tree.jpeg +0 -0
  205. package/documentation/docs/manual/entities/images/object_select.png +0 -0
  206. package/documentation/docs/manual/entities/images/problems.png +0 -0
  207. package/documentation/docs/manual/entities/images/select_inter.png +0 -0
  208. package/documentation/docs/manual/entities/images/stages.jpg +0 -0
  209. package/documentation/docs/manual/entities/images/suggests.png +0 -0
  210. package/documentation/docs/manual/entities/intro.md +73 -0
  211. package/documentation/docs/manual/entities/rules.md +35 -0
  212. package/documentation/docs/manual/functions/example.yaml +50 -0
  213. package/documentation/docs/manual/functions/functions.md +51 -0
  214. package/documentation/docs/manual/functions/root.yaml +39 -0
  215. package/documentation/docs/manual/images/jbps1.1.png +0 -0
  216. package/documentation/docs/manual/images/jbps1.png +0 -0
  217. package/documentation/docs/manual/images/jbps2.png +0 -0
  218. package/documentation/docs/manual/images/vsc1.png +0 -0
  219. package/documentation/docs/manual/imports.md +59 -0
  220. package/documentation/docs/manual/introduction.md +38 -0
  221. package/documentation/docs/manual/jsonata.md +268 -0
  222. package/documentation/docs/manual/plugin-settings.md +134 -0
  223. package/documentation/docs/manual/plugins/interface.md +226 -0
  224. package/documentation/docs/manual/plugins/introduction.md +256 -0
  225. package/documentation/docs/manual/plugins/root.yaml +51 -0
  226. package/documentation/docs/manual/role-model.md +80 -0
  227. package/documentation/docs/manual/root-cluster-import.md +82 -0
  228. package/documentation/docs/manual/root.yaml +199 -0
  229. package/documentation/docs/manual/rules/exceptions.md +20 -0
  230. package/documentation/docs/manual/rules/exreason.md +3 -0
  231. package/documentation/docs/manual/rules/root.yaml +58 -0
  232. package/documentation/docs/manual/rules/rules.md +8 -0
  233. package/documentation/docs/manual/rules/standard.md +3 -0
  234. package/documentation/docs/manual/rules/validators.md +109 -0
  235. package/documentation/docs/manual/technologies.md +49 -0
  236. package/documentation/docs/root.yaml +32 -0
  237. package/documentation/docs/sequence.puml +48 -0
  238. package/documentation/docs/welcome.md +3 -0
  239. package/documentation/entities/extentions/entity.yaml +136 -0
  240. package/documentation/entities/extentions/templates/people.md +4 -0
  241. package/documentation/entities/interactions/entity.yaml +412 -0
  242. package/documentation/entities/interactions/templates/blank.puml +18 -0
  243. package/documentation/entities/interactions/templates/bpmn.xml +59 -0
  244. package/documentation/entities/interactions/templates/tree.puml +11 -0
  245. package/documentation/entities/root.yaml +33 -0
  246. package/documentation/root.yaml +37 -0
  247. package/metamodel/dochub/entities/aspects/base.yaml +73 -0
  248. package/metamodel/dochub/entities/aspects/blank.yaml +65 -0
  249. package/metamodel/dochub/entities/aspects/components.yaml +52 -0
  250. package/metamodel/dochub/entities/aspects/contexts.yaml +57 -0
  251. package/metamodel/dochub/entities/aspects/docs.yaml +51 -0
  252. package/metamodel/dochub/entities/aspects/hierarchy.yaml +80 -0
  253. package/metamodel/dochub/entities/aspects/root.yaml +9 -0
  254. package/metamodel/dochub/entities/aspects/summary.yaml +64 -0
  255. package/metamodel/dochub/entities/aspects/templates/components.md +5 -0
  256. package/metamodel/dochub/entities/aspects/templates/hierarchy.puml +5 -0
  257. package/metamodel/dochub/entities/aspects/templates/summary.md +9 -0
  258. package/metamodel/dochub/entities/aspects/templates/tree.puml +5 -0
  259. package/metamodel/dochub/entities/aspects/tree.yaml +37 -0
  260. package/metamodel/dochub/entities/components/base.yaml +97 -0
  261. package/metamodel/dochub/entities/components/blank.yaml +64 -0
  262. package/metamodel/dochub/entities/components/contexts.yaml +55 -0
  263. package/metamodel/dochub/entities/components/docs.yaml +50 -0
  264. package/metamodel/dochub/entities/components/hierarchy.yaml +84 -0
  265. package/metamodel/dochub/entities/components/index.yaml +17 -0
  266. package/metamodel/dochub/entities/components/root.yaml +8 -0
  267. package/metamodel/dochub/entities/components/summary.yaml +58 -0
  268. package/metamodel/dochub/entities/components/symbol.yaml +113 -0
  269. package/metamodel/dochub/entities/components/templates/hierarchy.puml +5 -0
  270. package/metamodel/dochub/entities/components/templates/summary.md +8 -0
  271. package/metamodel/dochub/entities/components/templates/tree.puml +5 -0
  272. package/metamodel/dochub/entities/components/tree.yaml +38 -0
  273. package/metamodel/dochub/entities/contexts/base.yaml +197 -0
  274. package/metamodel/dochub/entities/contexts/plantuml.yaml +241 -0
  275. package/metamodel/dochub/entities/contexts/root.yaml +5 -0
  276. package/metamodel/dochub/entities/contexts/smartants.yaml +177 -0
  277. package/metamodel/dochub/entities/contexts/templates/template.puml +183 -0
  278. package/metamodel/dochub/entities/contexts/templates/tree.puml +5 -0
  279. package/metamodel/dochub/entities/contexts/tree.yaml +39 -0
  280. package/metamodel/dochub/entities/documents/base.yaml +73 -0
  281. package/metamodel/dochub/entities/documents/blank.yaml +28 -0
  282. package/metamodel/dochub/entities/documents/root.yaml +3 -0
  283. package/metamodel/dochub/entities/root.yaml +5 -0
  284. package/metamodel/dochub/functions/root.yaml +2 -0
  285. package/metamodel/dochub/functions/tools.yaml +46 -0
  286. package/metamodel/dochub/root.yaml +24 -0
  287. package/metamodel/dochub/rules/root.yaml +2 -0
  288. package/metamodel/dochub/rules/validators.yaml +144 -0
  289. package/metamodel/dochub/samples/01_components.yaml +23 -0
  290. package/metamodel/dochub/samples/02_contexts.yaml +23 -0
  291. package/metamodel/dochub/samples/03_documents.yaml +10 -0
  292. package/metamodel/dochub/samples/root.yaml +4 -0
  293. package/metamodel/dochub/samples/test.puml +17 -0
  294. package/metamodel/dochub.yaml +5 -0
  295. package/metamodel/docs/welcome.md +39 -0
  296. package/metamodel/root.yaml +8 -0
  297. package/package.json +28 -0
  298. package/plugin.html +1963 -0
@@ -0,0 +1,59 @@
1
+ docs:
2
+ archtool.plugins.gigachat.agents:
3
+ type: ai-chat
4
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat/3. Пример
5
+ scenarios:
6
+ calculator:
7
+ title: Калькулятор
8
+ type: react
9
+ temperature: 0
10
+ top_p: 2
11
+ model: GigaChat-2
12
+ system_prompt: |
13
+ Ты калькулятор осуществляющий расчет по следующей функции:
14
+ x + y - z.
15
+
16
+ Значение [z] ты получаешь от пользователя.
17
+ Если пользователь передал не число - верни ответ: "Пожалуйста, введите число"
18
+
19
+ Для получения прочих значений:
20
+ - Используй инструмент get_x для получения значения [x]
21
+ - Используй инструмент get_y для получения значения [y]
22
+ - Используй инструмент calculate для расчета функции
23
+
24
+ Верни в ответ полученное число.
25
+ На каждый новый запрос пользователя получай значения [x] и [y] повторно, используя соответсвующие инструменты.
26
+
27
+ tools:
28
+ - name: get_x
29
+ description: Получает значение x.
30
+ schema:
31
+ query: >
32
+ (
33
+ 100
34
+ )
35
+ - name: get_y
36
+ description: Получает значение y.
37
+ schema:
38
+ query: >
39
+ (
40
+ 50
41
+ )
42
+ - name: calculate
43
+ description: Выполняет расчет.
44
+ schema:
45
+ type: object
46
+ properties:
47
+ x:
48
+ title: Значение переменной x
49
+ type: number
50
+ y:
51
+ title: Значение переменной y
52
+ type: number
53
+ z:
54
+ title: Значение переменной z
55
+ type: number
56
+ query: >
57
+ (
58
+ $number('${x}') + $number('${y}') - $number('${z}')
59
+ )
@@ -0,0 +1,5 @@
1
+ docs:
2
+ archtool.plugins.gigachat.agents.react.menu:
3
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat/2. Агенты/2. ReAct
4
+ type: markdown
5
+ source: template.md
@@ -0,0 +1,3 @@
1
+ imports:
2
+ - menu.yaml
3
+ - gigachat.yaml
@@ -0,0 +1,138 @@
1
+ # `ReAct` - агент
2
+
3
+ # Описание
4
+
5
+ Агент позволяет взаимодействовать с GigaChat с использованием дополнительных инструментов/тулов (tool).
6
+
7
+ # ⚠️ Доступность ⚠️
8
+
9
+ Агент доступен в:
10
+
11
+ - `backend`-mode
12
+
13
+ # Знакомство
14
+
15
+ Познакомимся с агентом, опишем структуру документа:
16
+
17
+ ```yaml
18
+ docs:
19
+ archtool.plugins.gigachat.agents:
20
+ type: ai-chat
21
+ scenarios:
22
+ calculator:
23
+ title: Калькулятор
24
+ type: react
25
+ model: GigaChat-2
26
+ system_prompt: |
27
+ Ты калькулятор осуществляющий расчет по следующей функции:
28
+ x + y - z.
29
+
30
+ Значение [z] ты получаешь от пользователя.
31
+ Если пользователь передал не число - верни ответ: "Пожалуйста, введите число"
32
+
33
+ Для получения прочих значений:
34
+ - Используй инструмент get_x для получения значения [x]
35
+ - Используй инструмент get_y для получения значения [y]
36
+ - Используй инструмент calculate для расчета функции
37
+
38
+ Верни в ответ полученное число.
39
+ На каждый новый запрос пользователя получай значения [x] и [y] повторно, используя соответсвующие инструменты.
40
+
41
+ tools:
42
+ - name: get_x
43
+ description: Получает значение x.
44
+ query: >
45
+ (
46
+ 100
47
+ )
48
+ - name: get_y
49
+ description: Получает значение y.
50
+ query: >
51
+ (
52
+ 50
53
+ )
54
+ - name: calculate
55
+ description: Выполняет расчет.
56
+ schema:
57
+ type: object
58
+ properties:
59
+ x:
60
+ title: Значение переменной x
61
+ type: number
62
+ y:
63
+ title: Значение переменной y
64
+ type: number
65
+ z:
66
+ title: Значение переменной z
67
+ type: number
68
+ query: >
69
+ (
70
+ $number('${x}') + $number('${y}') - $number('${z}')
71
+ )
72
+ ```
73
+
74
+ # Базовое описание
75
+
76
+ ## `system_prompt`
77
+
78
+ Основной промпт
79
+
80
+ ## `model`
81
+
82
+ Название модели, от которой нужно получить ответ
83
+
84
+ ## `temperature`
85
+
86
+ Необязательный параметр.
87
+
88
+ Температура выборки в диапазоне от ноля до двух (число).
89
+
90
+ ## `topP`
91
+
92
+ Необязательный параметр.
93
+
94
+ Альтернатива параметру температуры (число).
95
+
96
+ ## `tools`
97
+
98
+ Список тулов
99
+
100
+ Рассмотрим описание тула
101
+
102
+ ### `name`
103
+
104
+ Идентификатор тула
105
+
106
+ ### `description`
107
+
108
+ Описание тула для llm. Должен содержать информацию о способе применения, в контексте общей задачи.
109
+
110
+ ### `schema`
111
+
112
+ Описание json-схемы.
113
+ Если описана схема - будет произведена подстановка описанных значений в JSONata-выражение описанное `query`.
114
+
115
+ ### `query`
116
+
117
+ JSONata-выражение, выполняемое для исполнения тула
118
+
119
+ JSONata выражение, применится к озеру данных. Добавляет результат выполнения выражения, в качестве контекста, к основному промпту.
120
+
121
+ # Пример формирования запроса
122
+
123
+ Рассмотрим механику формирования запроса и работы тулов на примере.
124
+
125
+ В качестве системного промпта используется значение переданное в поле `system_prompt`.
126
+ Исходя из задачи в промпте, ассистент определит необходимые шаги для ее достижения.
127
+ Выполнит необходимые тулы и предоставит ответ.
128
+
129
+ В нашем примере ассистент:
130
+
131
+ - Инициирует и подготовит все тулы.
132
+ - Подготовит системный промпт из поля `system_prompt`.
133
+ - Воспользуется тулом `get_x` для получения значения `x`.
134
+ - Воспользуется тулом `get_y` для получения значения `y`.
135
+ - Воспользуется тулом `calculate` для выполнения расчета. В туле указана json-схема, т.о.:
136
+ - - в выражение описанное в `query` будут подставлены указанные параметры.
137
+ - - ассистент выполнит JSONata-выражение с обновленным значением.
138
+ - После получения всех значений ассистент подготовит ответ и вернет пользователю.
@@ -0,0 +1,5 @@
1
+ imports:
2
+ - menu.yaml
3
+ - simple/root.yaml
4
+ - react/root.yaml
5
+ - aigena/root.yaml
@@ -0,0 +1,14 @@
1
+ docs:
2
+ archtool.plugins.gigachat.agents:
3
+ type: ai-chat
4
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat/3. Пример
5
+ scenarios:
6
+ consultant:
7
+ title: Консультант
8
+ type: simple
9
+ system_prompt: Ты архитектор ИТ инфраструктуры, консультируй пользователя по решениям.
10
+ model: GigaChat-2
11
+ query: >
12
+ (
13
+ $.docs."archtool.plugins.gigachat.agents"."scenarios"."consultant"
14
+ )
@@ -0,0 +1,5 @@
1
+ docs:
2
+ archtool.plugins.gigachat.agents.simple.menu:
3
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat/2. Агенты/1. Simple
4
+ type: markdown
5
+ source: template.md
@@ -0,0 +1,3 @@
1
+ imports:
2
+ - menu.yaml
3
+ - gigachat.yaml
@@ -0,0 +1,113 @@
1
+ # `Simple` - агент
2
+
3
+ # Описание
4
+
5
+ Агент позволяет взаимодействовать с GigaChat по [API](https://developers.sber.ru/docs/ru/gigachat/api/overview).
6
+
7
+ # ⚠️ Доступность ⚠️
8
+
9
+ Агент доступен в:
10
+
11
+ - `plugin`-mode
12
+ - `backend`-mode
13
+
14
+ # Знакомство
15
+
16
+ Познакомимся с первым агентом, опишем структуру документа:
17
+
18
+ ```yaml
19
+ docs:
20
+ archtool.plugins.gigachat.agents:
21
+ type: ai-chat
22
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat/3. Пример
23
+ scenarios:
24
+ consultant:
25
+ title: Консультант
26
+ type: simple
27
+ system_prompt: Ты архитектор ИТ инфраструктуры, консультируй пользователя по решениям.
28
+ model: GigaChat-2
29
+ query: >
30
+ (
31
+ $.docs."archtool.plugins.gigachat.agents"."scenarios"."consultant"
32
+ )
33
+ ```
34
+
35
+ # Базовое описание
36
+
37
+ ## `system_prompt`
38
+
39
+ Основной промпт
40
+
41
+ ## `model`
42
+
43
+ Название модели, от которой нужно получить ответ
44
+
45
+ ## `query`
46
+
47
+ JSONata выражение, применится к озеру данных. Добавляет результат выполнения выражения, в качестве контекста, к основному промпту.
48
+
49
+ ## `temperature`
50
+
51
+ Необязательный параметр.
52
+
53
+ Температура выборки в диапазоне от ноля до двух (число).
54
+
55
+ ## `topP`
56
+
57
+ Необязательный параметр.
58
+
59
+ Альтернатива параметру температуры (число).
60
+
61
+ ## `maxTokens`
62
+
63
+ Необязательный параметр.
64
+
65
+ Максимальное количество токенов, которые будут использованы для создания ответов (число).
66
+
67
+ # Пример формирования запроса
68
+
69
+ Рассмотрим механнику запроса детально.
70
+
71
+ В нашем примере:
72
+
73
+ `system_prompt`:
74
+
75
+ ```
76
+ Ты архитектор ИТ инфраструктуры, консультируй пользователя по решениям.
77
+ ```
78
+
79
+ `query`:
80
+
81
+ ```yaml
82
+ query: >
83
+ (
84
+ $.docs."archtool.plugins.gigachat.agents"."scenarios"."consultant"
85
+ )
86
+ ```
87
+
88
+ Выполнение данного выражение вернет нам сам документ:
89
+
90
+ ```json
91
+ {
92
+ "title": "Консультант",
93
+ "type": "simple",
94
+ "system_prompt": "Ты архитектор ИТ инфраструктуры, консультируй пользователя по решениям.",
95
+ "model": "GigaChat-2",
96
+ "query": "(\n $.docs.\"archtool.plugins.gigachat.agents\".\"scenarios\".\"consultant\"\n)\n"
97
+ }
98
+ ```
99
+
100
+ В результате, будет сформирован системный промпт для llm:
101
+
102
+ ```
103
+ Ты архитектор ИТ инфраструктуры, консультируй пользователя по решениям.
104
+
105
+ Контекст, полученный из базы знаний:
106
+ {
107
+ "title": "Консультант",
108
+ "type": "simple",
109
+ "system_prompt": "Ты архитектор ИТ инфраструктуры, консультируй пользователя по решениям.",
110
+ "model": "GigaChat-2",
111
+ "query": "(\n $.docs.\"archtool.plugins.gigachat.agents\".\"scenarios\".\"consultant\"\n)\n"
112
+ }
113
+ ```
@@ -0,0 +1,62 @@
1
+ # Агенты (scenarios)
2
+
3
+ Свойство `scenarios` содежит описание подключаемых агентов
4
+
5
+ # Общие свойства описания агентов
6
+
7
+ Перед тем как рассмотреть каждый агент детально, рассмотрим общие свойства описания агентов:
8
+
9
+ ```yaml
10
+ archtool.plugins.gigachat.example:
11
+ type: ai-chat
12
+ scenarios:
13
+ scenario_id:
14
+ title: Консультант
15
+ type: simple
16
+ history: true
17
+ # ... other props
18
+ ```
19
+
20
+ ## `title`
21
+
22
+ **Описание**: Имя (placeholder) агента, отражаемое в меню в нижней части экрана.
23
+
24
+ **Допустимые значения**: строка.
25
+
26
+ **Обязательное**: да.
27
+
28
+ ## `type`
29
+
30
+ **Описание**: Идентификатор типа агента.
31
+
32
+ **Допустимые значения**: [Описаны ниже](#доступные-типы-агентов).
33
+
34
+ **Обязательное**: да.
35
+
36
+ ## `history`
37
+
38
+ **Описание**: Флаг, позволяет отключить передачу истории сообщений между запросами, уменьшив потребление токенов.
39
+ Отключение будет полезно на больших текстовых объемах, где нет необходимости в контексте всех ранее отправленных сообщений в диалоге.
40
+
41
+ **Допустимые значения**: Boolean.
42
+
43
+ **Значение по умолчанию**: `true`.
44
+
45
+ **Обязательное**: нет.
46
+
47
+ # Доступные типы агентов:
48
+
49
+ ## [`simple`](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.agents.simple.menu)
50
+
51
+ Взаимодействует c API GigaChat.
52
+ Позволяет описать промпт и добавить в него результат выполнения JSONata-выражения в качестве контекста.
53
+
54
+ ## [`react`](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.agents.react.menu)
55
+
56
+ Взаимодействует c API GigaChat.
57
+ Позволяет использовать тулы (function-calling инструменты) для предоставления ответа.
58
+
59
+ ## [`aigena`](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.agents.aigena.menu)
60
+
61
+ Взаимодействует с API AiGenA.
62
+ Позволяет получить консультацию по стандартам ДЗО.
@@ -0,0 +1,5 @@
1
+ docs:
2
+ archtool.plugins.gigachat.menu:
3
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat
4
+ type: markdown
5
+ source: template.md
@@ -0,0 +1,4 @@
1
+ imports:
2
+ - menu.yaml
3
+ - settings/root.yaml
4
+ - agents/root.yaml
@@ -0,0 +1,5 @@
1
+ docs:
2
+ archtool.plugins.gigachat.settings.menu:
3
+ location: SEAF.ArchTool/Руководство/Документы/GigaChat/1. Настройка
4
+ type: markdown
5
+ source: template.md
@@ -0,0 +1,2 @@
1
+ imports:
2
+ - menu.yaml
@@ -0,0 +1,51 @@
1
+ # Настройка
2
+
3
+ Рассмотрим основные параметры и настройки.
4
+
5
+ # Сертификаты
6
+
7
+ Обязательные параметры.
8
+
9
+ Для корректной работы требуется установить сертификаты Минцифры и указать путь к ним в параметрах:
10
+
11
+ - `VUE_APP_GIGACHAT_CA_BUNDLE_FILE`
12
+ - `VUE_APP_GIGACHAT_CERT_FILE`
13
+ - `VUE_APP_GIGACHAT_KEY_FILE`
14
+
15
+ Информация о сертификатах содержится в статье: [Использование сертификатов Минцифры в GigaChat](https://developers.sber.ru/docs/ru/gigachat/certificates)
16
+
17
+ # `VUE_APP_GIGACHAT_BASE_URL`
18
+
19
+ Обязательный параметр.
20
+
21
+ URL к API GigaChat.
22
+
23
+ # `VUE_APP_GIGACHAT_AUTH_URL`
24
+
25
+ Обязательный параметр для режима Банк, указывается URL IDP банка.
26
+
27
+ URL для получения токена доступа для авторизации запросов к API.
28
+
29
+ # `VUE_APP_GIGACHAT_CREDENTIAL`
30
+
31
+ Обязательный параметр.
32
+
33
+ Токен доступа для авторизации запросов к API.
34
+
35
+ Токен можно получить в [личном кабинете GigaChat](https://developers.sber.ru/).
36
+
37
+ # `VUE_APP_GIGACHAT_SCOPE`
38
+
39
+ Обязательный параметр.
40
+
41
+ Версия API.
42
+
43
+ Возможные значения перечислены в [документации](https://developers.sber.ru/docs/ru/gigachat/api/reference/rest/post-token).
44
+
45
+ # `VUE_APP_GIGACHAT_DEFAULT_MODEL`
46
+
47
+ Используемая по умолчанию модель.
48
+
49
+ # `VUE_APP_GIGACHAT_TIMEOUT`
50
+
51
+ `timeout` соединения - максимальное время поддержания соединения в `ms`.
@@ -0,0 +1,38 @@
1
+ # Описание
2
+
3
+ Чат для взаимодействия с ИИ-агентом
4
+
5
+ # Начинающим пользователям
6
+
7
+ Рекомендуем ознакомиться с основными концепциями:
8
+
9
+ - [1. Настройка](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.settings.menu)
10
+ - [2. Агенты](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.agents.menu)
11
+
12
+ # Базовое описание
13
+
14
+ Рассмотрим основные свойства документа:
15
+
16
+ ```yaml
17
+ archtool.plugins.gigachat.example:
18
+ type: ai-chat
19
+ scenarios:
20
+ scenarios_id_1:
21
+ title: Сценарий 1
22
+ type: simple
23
+ # описание агента, с ними мы познакомимся позже
24
+ scenarios_id_2:
25
+ title: Сценарий 2
26
+ type: react
27
+ # ...
28
+ ```
29
+
30
+ Рассмотрим свойства детально:
31
+
32
+ `type: ai-chat` - идентификатор документа `ai-chat`
33
+
34
+ `scenarios` - подключаемые к документу сценарии (агенты)
35
+
36
+ Таким образом, мы получим интерфейс чата, с возможностью переключения между сценариями.
37
+
38
+ Познакомимся с [агентами](/entities/docs/blank?dh-doc-id=archtool.plugins.gigachat.agents.menu)