@agentica/core 0.44.0-dev.20260313-2 → 0.44.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 (154) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +218 -218
  3. package/lib/context/internal/__IChatInitialApplication.d.ts +1 -2
  4. package/lib/errors/AgenticaJsonParseError.js +6 -6
  5. package/lib/index.mjs +47 -7
  6. package/lib/index.mjs.map +1 -1
  7. package/lib/orchestrate/call.js +16 -16
  8. package/lib/orchestrate/cancel.js +1 -1
  9. package/lib/orchestrate/cancel.js.map +1 -1
  10. package/lib/orchestrate/initialize.js +44 -2
  11. package/lib/orchestrate/initialize.js.map +1 -1
  12. package/lib/orchestrate/select.js +1 -1
  13. package/lib/orchestrate/select.js.map +1 -1
  14. package/lib/structures/IAgenticaController.d.ts +143 -143
  15. package/lib/utils/ChatGptCompletionMessageUtil.js +6 -6
  16. package/package.json +6 -6
  17. package/prompts/cancel.md +5 -5
  18. package/prompts/common.md +3 -3
  19. package/prompts/describe.md +7 -7
  20. package/prompts/execute.md +122 -122
  21. package/prompts/initialize.md +3 -3
  22. package/prompts/json_parse_error.md +35 -35
  23. package/prompts/select.md +7 -7
  24. package/prompts/validate.md +123 -123
  25. package/prompts/validate_repeated.md +31 -31
  26. package/src/Agentica.ts +367 -367
  27. package/src/MicroAgentica.ts +357 -357
  28. package/src/constants/AgenticaConstant.ts +4 -4
  29. package/src/constants/AgenticaDefaultPrompt.ts +44 -44
  30. package/src/constants/index.ts +2 -2
  31. package/src/context/AgenticaContext.ts +136 -136
  32. package/src/context/AgenticaContextRequestResult.ts +14 -14
  33. package/src/context/AgenticaOperation.ts +73 -73
  34. package/src/context/AgenticaOperationCollection.ts +49 -49
  35. package/src/context/AgenticaOperationSelection.ts +9 -9
  36. package/src/context/AgenticaTokenUsage.ts +186 -186
  37. package/src/context/MicroAgenticaContext.ts +99 -99
  38. package/src/context/index.ts +5 -5
  39. package/src/context/internal/AgenticaOperationComposer.ts +177 -177
  40. package/src/context/internal/AgenticaTokenUsageAggregator.ts +66 -66
  41. package/src/context/internal/__IChatCancelFunctionsApplication.ts +23 -23
  42. package/src/context/internal/__IChatFunctionReference.ts +21 -21
  43. package/src/context/internal/__IChatInitialApplication.ts +13 -15
  44. package/src/context/internal/__IChatSelectFunctionsApplication.ts +24 -24
  45. package/src/context/internal/isAgenticaContext.ts +11 -11
  46. package/src/errors/AgenticaJsonParseError.ts +52 -52
  47. package/src/errors/AgenticaValidationError.ts +49 -49
  48. package/src/errors/index.ts +2 -2
  49. package/src/events/AgenticaAssistantMessageEvent.ts +12 -12
  50. package/src/events/AgenticaCallEvent.ts +27 -27
  51. package/src/events/AgenticaCancelEvent.ts +9 -9
  52. package/src/events/AgenticaDescribeEvent.ts +14 -14
  53. package/src/events/AgenticaEvent.ts +59 -59
  54. package/src/events/AgenticaEvent.type.ts +19 -19
  55. package/src/events/AgenticaEventBase.ts +18 -18
  56. package/src/events/AgenticaEventSource.ts +6 -6
  57. package/src/events/AgenticaExecuteEvent.ts +45 -45
  58. package/src/events/AgenticaInitializeEvent.ts +7 -7
  59. package/src/events/AgenticaJsonParseErrorEvent.ts +16 -16
  60. package/src/events/AgenticaRequestEvent.ts +27 -27
  61. package/src/events/AgenticaResponseEvent.ts +32 -32
  62. package/src/events/AgenticaSelectEvent.ts +11 -11
  63. package/src/events/AgenticaUserMessageEvent.ts +12 -12
  64. package/src/events/AgenticaValidateEvent.ts +32 -32
  65. package/src/events/MicroAgenticaEvent.ts +45 -45
  66. package/src/events/index.ts +15 -15
  67. package/src/factory/events.ts +357 -357
  68. package/src/factory/histories.ts +348 -348
  69. package/src/factory/index.ts +3 -3
  70. package/src/factory/operations.ts +16 -16
  71. package/src/functional/assertHttpController.ts +106 -106
  72. package/src/functional/assertHttpLlmApplication.ts +52 -52
  73. package/src/functional/assertMcpController.ts +47 -47
  74. package/src/functional/createMcpLlmApplication.ts +72 -72
  75. package/src/functional/index.ts +7 -7
  76. package/src/functional/validateHttpController.ts +113 -113
  77. package/src/functional/validateHttpLlmApplication.ts +65 -65
  78. package/src/functional/validateMcpController.ts +53 -53
  79. package/src/histories/AgenticaAssistantMessageHistory.ts +10 -10
  80. package/src/histories/AgenticaCancelHistory.ts +8 -8
  81. package/src/histories/AgenticaDescribeHistory.ts +18 -18
  82. package/src/histories/AgenticaExecuteHistory.ts +64 -64
  83. package/src/histories/AgenticaHistory.ts +28 -28
  84. package/src/histories/AgenticaHistoryBase.ts +35 -35
  85. package/src/histories/AgenticaSelectHistory.ts +8 -8
  86. package/src/histories/AgenticaSystemMessageHistory.ts +10 -10
  87. package/src/histories/AgenticaUserMessageHistory.ts +11 -11
  88. package/src/histories/MicroAgenticaHistory.ts +19 -19
  89. package/src/histories/contents/AgenticaUserMessageAudioContent.ts +21 -21
  90. package/src/histories/contents/AgenticaUserMessageContent.ts +19 -19
  91. package/src/histories/contents/AgenticaUserMessageContentBase.ts +6 -6
  92. package/src/histories/contents/AgenticaUserMessageFileContent.ts +25 -25
  93. package/src/histories/contents/AgenticaUserMessageImageContent.ts +33 -33
  94. package/src/histories/contents/AgenticaUserMessageTextContent.ts +15 -15
  95. package/src/histories/contents/index.ts +5 -5
  96. package/src/histories/index.ts +10 -10
  97. package/src/index.ts +15 -15
  98. package/src/json/IAgenticaEventJson.ts +265 -265
  99. package/src/json/IAgenticaEventJson.type.ts +19 -19
  100. package/src/json/IAgenticaHistoryJson.ts +165 -165
  101. package/src/json/IAgenticaHistoryJson.type.ts +19 -19
  102. package/src/json/IAgenticaOperationJson.ts +36 -36
  103. package/src/json/IAgenticaOperationSelectionJson.ts +26 -26
  104. package/src/json/IAgenticaTokenUsageJson.ts +107 -107
  105. package/src/json/IMicroAgenticaEventJson.ts +22 -22
  106. package/src/json/IMicroAgenticaHistoryJson.ts +25 -25
  107. package/src/json/index.ts +7 -7
  108. package/src/orchestrate/call.ts +542 -542
  109. package/src/orchestrate/cancel.ts +265 -265
  110. package/src/orchestrate/describe.ts +66 -66
  111. package/src/orchestrate/execute.ts +61 -61
  112. package/src/orchestrate/index.ts +6 -6
  113. package/src/orchestrate/initialize.ts +102 -102
  114. package/src/orchestrate/internal/cancelFunctionFromContext.ts +33 -33
  115. package/src/orchestrate/internal/selectFunctionFromContext.ts +34 -34
  116. package/src/orchestrate/select.ts +320 -320
  117. package/src/structures/IAgenticaConfig.ts +83 -83
  118. package/src/structures/IAgenticaConfigBase.ts +87 -87
  119. package/src/structures/IAgenticaController.ts +143 -143
  120. package/src/structures/IAgenticaExecutor.ts +167 -167
  121. package/src/structures/IAgenticaProps.ts +78 -78
  122. package/src/structures/IAgenticaSystemPrompt.ts +236 -236
  123. package/src/structures/IAgenticaVendor.ts +54 -54
  124. package/src/structures/IMcpTool.ts +60 -60
  125. package/src/structures/IMicroAgenticaConfig.ts +56 -56
  126. package/src/structures/IMicroAgenticaExecutor.ts +67 -67
  127. package/src/structures/IMicroAgenticaProps.ts +77 -77
  128. package/src/structures/IMicroAgenticaSystemPrompt.ts +169 -169
  129. package/src/structures/index.ts +10 -10
  130. package/src/transformers/transformHistory.ts +172 -172
  131. package/src/utils/AssistantMessageEmptyError.ts +20 -20
  132. package/src/utils/AsyncQueue.spec.ts +355 -355
  133. package/src/utils/AsyncQueue.ts +95 -95
  134. package/src/utils/ByteArrayUtil.ts +5 -5
  135. package/src/utils/ChatGptCompletionMessageUtil.spec.ts +314 -314
  136. package/src/utils/ChatGptCompletionMessageUtil.ts +210 -210
  137. package/src/utils/ChatGptCompletionStreamingUtil.spec.ts +909 -909
  138. package/src/utils/ChatGptCompletionStreamingUtil.ts +91 -91
  139. package/src/utils/ChatGptTokenUsageAggregator.spec.ts +226 -226
  140. package/src/utils/ChatGptTokenUsageAggregator.ts +57 -57
  141. package/src/utils/MPSC.spec.ts +276 -276
  142. package/src/utils/MPSC.ts +42 -42
  143. package/src/utils/Singleton.spec.ts +138 -138
  144. package/src/utils/Singleton.ts +42 -42
  145. package/src/utils/StreamUtil.spec.ts +512 -512
  146. package/src/utils/StreamUtil.ts +87 -87
  147. package/src/utils/__map_take.spec.ts +140 -140
  148. package/src/utils/__map_take.ts +13 -13
  149. package/src/utils/__retry.spec.ts +198 -198
  150. package/src/utils/__retry.ts +18 -18
  151. package/src/utils/assertExecuteFailure.ts +16 -16
  152. package/src/utils/index.ts +4 -4
  153. package/src/utils/request.ts +140 -140
  154. package/src/utils/types.ts +50 -50
@@ -1,186 +1,186 @@
1
- import type { CompletionUsage } from "openai/resources";
2
-
3
- import typia from "typia";
4
-
5
- import type { IAgenticaTokenUsageJson } from "../json/IAgenticaTokenUsageJson";
6
-
7
- import { AgenticaTokenUsageAggregator } from "./internal/AgenticaTokenUsageAggregator";
8
-
9
- export class AgenticaTokenUsage implements IAgenticaTokenUsageJson {
10
- /**
11
- * Aggregated token usage.
12
- */
13
- public readonly aggregate: AgenticaTokenUsage.IComponent;
14
-
15
- /**
16
- * Token uasge of initializer agent.
17
- */
18
- public readonly initialize: AgenticaTokenUsage.IComponent;
19
-
20
- /**
21
- * Token usage of function selector agent.
22
- */
23
- public readonly select: AgenticaTokenUsage.IComponent;
24
-
25
- /**
26
- * Token usage of function canceler agent.
27
- */
28
- public readonly cancel: AgenticaTokenUsage.IComponent;
29
-
30
- /**
31
- * Token usage of function caller agent.
32
- */
33
- public readonly call: AgenticaTokenUsage.IComponent;
34
-
35
- /**
36
- * Token usage of function calling describer agent.
37
- */
38
- public readonly describe: AgenticaTokenUsage.IComponent;
39
-
40
- public constructor(props?: IAgenticaTokenUsageJson) {
41
- if (props === undefined) {
42
- const zero = AgenticaTokenUsage.zero();
43
- this.aggregate = zero.aggregate;
44
- this.initialize = zero.initialize;
45
- this.select = zero.select;
46
- this.cancel = zero.cancel;
47
- this.call = zero.call;
48
- this.describe = zero.describe;
49
- }
50
- else {
51
- this.aggregate = props.aggregate;
52
- this.initialize = props.initialize;
53
- this.select = props.select;
54
- this.cancel = props.cancel;
55
- this.call = props.call;
56
- this.describe = props.describe;
57
- }
58
- }
59
-
60
- public increment(y: IAgenticaTokenUsageJson): void {
61
- const increment = (
62
- x: IAgenticaTokenUsageJson.IComponent,
63
- y: IAgenticaTokenUsageJson.IComponent,
64
- ): void => {
65
- x.total += y.total;
66
- x.input.total += y.input.total;
67
- x.input.cached += y.input.cached;
68
- x.output.total += y.output.total;
69
- x.output.reasoning += y.output.reasoning;
70
- x.output.accepted_prediction += y.output.accepted_prediction;
71
- x.output.rejected_prediction += y.output.rejected_prediction;
72
- };
73
- increment(this.aggregate, y.aggregate);
74
- increment(this.initialize, y.initialize);
75
- increment(this.select, y.select);
76
- increment(this.cancel, y.cancel);
77
- increment(this.call, y.call);
78
- increment(this.describe, y.describe);
79
- }
80
-
81
- public use(
82
- kind: Exclude<keyof IAgenticaTokenUsageJson, "aggregate">,
83
- completionUsage: CompletionUsage,
84
- ): void {
85
- AgenticaTokenUsageAggregator.aggregate({
86
- kind,
87
- completionUsage,
88
- usage: this,
89
- });
90
- }
91
-
92
- public toJSON(): IAgenticaTokenUsageJson {
93
- return typia.misc.clone<IAgenticaTokenUsageJson>(this);
94
- }
95
-
96
- public static zero(): AgenticaTokenUsage {
97
- const component = (): IAgenticaTokenUsageJson.IComponent => ({
98
- total: 0,
99
- input: {
100
- total: 0,
101
- cached: 0,
102
- },
103
- output: {
104
- total: 0,
105
- reasoning: 0,
106
- accepted_prediction: 0,
107
- rejected_prediction: 0,
108
- },
109
- });
110
- return new AgenticaTokenUsage({
111
- aggregate: component(),
112
- initialize: component(),
113
- select: component(),
114
- cancel: component(),
115
- call: component(),
116
- describe: component(),
117
- });
118
- }
119
-
120
- public static plus(
121
- x: AgenticaTokenUsage,
122
- y: AgenticaTokenUsage,
123
- ): AgenticaTokenUsage {
124
- const z: AgenticaTokenUsage = new AgenticaTokenUsage(x.toJSON());
125
- z.increment(y.toJSON());
126
- return z;
127
- }
128
- }
129
- export namespace AgenticaTokenUsage {
130
- export interface IComponent {
131
- /**
132
- * Total token usage.
133
- */
134
- total: number;
135
-
136
- /**
137
- * Input token usage of detailed.
138
- */
139
- input: IInput;
140
-
141
- /**
142
- * Output token usage of detailed.
143
- */
144
- output: IOutput;
145
- }
146
-
147
- /**
148
- * Input token usage of detailed.
149
- */
150
- export interface IInput {
151
- /**
152
- * Total amount of input token uasge.
153
- */
154
- total: number;
155
-
156
- /**
157
- * Cached token usage.
158
- */
159
- cached: number;
160
- }
161
-
162
- /**
163
- * Output token usage of detailed.
164
- */
165
- export interface IOutput {
166
- /**
167
- * Total amount of output token usage.
168
- */
169
- total: number;
170
-
171
- /**
172
- * Reasoning token usage.
173
- */
174
- reasoning: number;
175
-
176
- /**
177
- * Prediction token usage.
178
- */
179
- accepted_prediction: number;
180
-
181
- /**
182
- * Rejected prediction token usage.
183
- */
184
- rejected_prediction: number;
185
- }
186
- }
1
+ import type { CompletionUsage } from "openai/resources";
2
+
3
+ import typia from "typia";
4
+
5
+ import type { IAgenticaTokenUsageJson } from "../json/IAgenticaTokenUsageJson";
6
+
7
+ import { AgenticaTokenUsageAggregator } from "./internal/AgenticaTokenUsageAggregator";
8
+
9
+ export class AgenticaTokenUsage implements IAgenticaTokenUsageJson {
10
+ /**
11
+ * Aggregated token usage.
12
+ */
13
+ public readonly aggregate: AgenticaTokenUsage.IComponent;
14
+
15
+ /**
16
+ * Token uasge of initializer agent.
17
+ */
18
+ public readonly initialize: AgenticaTokenUsage.IComponent;
19
+
20
+ /**
21
+ * Token usage of function selector agent.
22
+ */
23
+ public readonly select: AgenticaTokenUsage.IComponent;
24
+
25
+ /**
26
+ * Token usage of function canceler agent.
27
+ */
28
+ public readonly cancel: AgenticaTokenUsage.IComponent;
29
+
30
+ /**
31
+ * Token usage of function caller agent.
32
+ */
33
+ public readonly call: AgenticaTokenUsage.IComponent;
34
+
35
+ /**
36
+ * Token usage of function calling describer agent.
37
+ */
38
+ public readonly describe: AgenticaTokenUsage.IComponent;
39
+
40
+ public constructor(props?: IAgenticaTokenUsageJson) {
41
+ if (props === undefined) {
42
+ const zero = AgenticaTokenUsage.zero();
43
+ this.aggregate = zero.aggregate;
44
+ this.initialize = zero.initialize;
45
+ this.select = zero.select;
46
+ this.cancel = zero.cancel;
47
+ this.call = zero.call;
48
+ this.describe = zero.describe;
49
+ }
50
+ else {
51
+ this.aggregate = props.aggregate;
52
+ this.initialize = props.initialize;
53
+ this.select = props.select;
54
+ this.cancel = props.cancel;
55
+ this.call = props.call;
56
+ this.describe = props.describe;
57
+ }
58
+ }
59
+
60
+ public increment(y: IAgenticaTokenUsageJson): void {
61
+ const increment = (
62
+ x: IAgenticaTokenUsageJson.IComponent,
63
+ y: IAgenticaTokenUsageJson.IComponent,
64
+ ): void => {
65
+ x.total += y.total;
66
+ x.input.total += y.input.total;
67
+ x.input.cached += y.input.cached;
68
+ x.output.total += y.output.total;
69
+ x.output.reasoning += y.output.reasoning;
70
+ x.output.accepted_prediction += y.output.accepted_prediction;
71
+ x.output.rejected_prediction += y.output.rejected_prediction;
72
+ };
73
+ increment(this.aggregate, y.aggregate);
74
+ increment(this.initialize, y.initialize);
75
+ increment(this.select, y.select);
76
+ increment(this.cancel, y.cancel);
77
+ increment(this.call, y.call);
78
+ increment(this.describe, y.describe);
79
+ }
80
+
81
+ public use(
82
+ kind: Exclude<keyof IAgenticaTokenUsageJson, "aggregate">,
83
+ completionUsage: CompletionUsage,
84
+ ): void {
85
+ AgenticaTokenUsageAggregator.aggregate({
86
+ kind,
87
+ completionUsage,
88
+ usage: this,
89
+ });
90
+ }
91
+
92
+ public toJSON(): IAgenticaTokenUsageJson {
93
+ return typia.misc.clone<IAgenticaTokenUsageJson>(this);
94
+ }
95
+
96
+ public static zero(): AgenticaTokenUsage {
97
+ const component = (): IAgenticaTokenUsageJson.IComponent => ({
98
+ total: 0,
99
+ input: {
100
+ total: 0,
101
+ cached: 0,
102
+ },
103
+ output: {
104
+ total: 0,
105
+ reasoning: 0,
106
+ accepted_prediction: 0,
107
+ rejected_prediction: 0,
108
+ },
109
+ });
110
+ return new AgenticaTokenUsage({
111
+ aggregate: component(),
112
+ initialize: component(),
113
+ select: component(),
114
+ cancel: component(),
115
+ call: component(),
116
+ describe: component(),
117
+ });
118
+ }
119
+
120
+ public static plus(
121
+ x: AgenticaTokenUsage,
122
+ y: AgenticaTokenUsage,
123
+ ): AgenticaTokenUsage {
124
+ const z: AgenticaTokenUsage = new AgenticaTokenUsage(x.toJSON());
125
+ z.increment(y.toJSON());
126
+ return z;
127
+ }
128
+ }
129
+ export namespace AgenticaTokenUsage {
130
+ export interface IComponent {
131
+ /**
132
+ * Total token usage.
133
+ */
134
+ total: number;
135
+
136
+ /**
137
+ * Input token usage of detailed.
138
+ */
139
+ input: IInput;
140
+
141
+ /**
142
+ * Output token usage of detailed.
143
+ */
144
+ output: IOutput;
145
+ }
146
+
147
+ /**
148
+ * Input token usage of detailed.
149
+ */
150
+ export interface IInput {
151
+ /**
152
+ * Total amount of input token uasge.
153
+ */
154
+ total: number;
155
+
156
+ /**
157
+ * Cached token usage.
158
+ */
159
+ cached: number;
160
+ }
161
+
162
+ /**
163
+ * Output token usage of detailed.
164
+ */
165
+ export interface IOutput {
166
+ /**
167
+ * Total amount of output token usage.
168
+ */
169
+ total: number;
170
+
171
+ /**
172
+ * Reasoning token usage.
173
+ */
174
+ reasoning: number;
175
+
176
+ /**
177
+ * Prediction token usage.
178
+ */
179
+ accepted_prediction: number;
180
+
181
+ /**
182
+ * Rejected prediction token usage.
183
+ */
184
+ rejected_prediction: number;
185
+ }
186
+ }
@@ -1,99 +1,99 @@
1
- import type OpenAI from "openai";
2
-
3
- import type { MicroAgenticaEvent } from "../events/MicroAgenticaEvent";
4
- import type { AgenticaUserMessageHistory } from "../histories/AgenticaUserMessageHistory";
5
- import type { MicroAgenticaHistory } from "../histories/MicroAgenticaHistory";
6
- import type { IMicroAgenticaConfig } from "../structures/IMicroAgenticaConfig";
7
-
8
- import type { AgenticaContextRequestResult } from "./AgenticaContextRequestResult";
9
- import type { AgenticaOperationCollection } from "./AgenticaOperationCollection";
10
-
11
- /**
12
- * Context of the Micro Agentic AI agent.
13
- *
14
- * `MicroAgenticaContext` is a structure defining the context of the
15
- * internal agents composing the {@link MicroAgentica}.
16
- *
17
- * It contains every information that is required to interact with
18
- * the AI vendor like OpenAI. It contains every operations for LLM
19
- * function calling, and configuration used for the agent construction.
20
- * And it contains the prompt histories, and facade controller
21
- * functions for interacting with the {@link MicroAgentica} like
22
- * {@link dispatch}.
23
- *
24
- * In such reasons, if you're planning to customize some internal
25
- * agents, or add new agents with new process routine, you have to
26
- * understand this context structure. Otherwise you don't have any
27
- * plan to customize the internal agents, this context information is
28
- * not important for you.
29
- *
30
- * @author Samchon
31
- */
32
- export interface MicroAgenticaContext {
33
- // ----
34
- // APPLICATION
35
- // ----
36
- /**
37
- * Collection of operations.
38
- *
39
- * Collection of operations from every controllers, and their
40
- * groups composed by the divide and conquer rule for the
41
- * efficient operation selection if configured.
42
- */
43
- operations: AgenticaOperationCollection;
44
-
45
- /**
46
- * Configuration of the agent.
47
- *
48
- * Configuration of the agent, that is used when constructing the
49
- * {@link Agentica} instance.
50
- *
51
- * @todo Write detaily after supporting the agent customization feature
52
- */
53
- config: IMicroAgenticaConfig | undefined;
54
-
55
- // ----
56
- // STATES
57
- // ----
58
- /**
59
- * Prompt histories.
60
- */
61
- histories: MicroAgenticaHistory[];
62
-
63
- /**
64
- * Text prompt of the user.
65
- *
66
- * Text conversation written the by user through the
67
- * {@link Agentica.conversate} function.
68
- */
69
- prompt: AgenticaUserMessageHistory;
70
-
71
- /**
72
- * Abort signal.
73
- */
74
- abortSignal?: AbortSignal;
75
- // ----
76
- // HANDLERS
77
- // ----
78
- /**
79
- * Dispatch event.
80
- *
81
- * Dispatch event so that the agent can be handle the event
82
- * through the {@link MicroAgentica.on} function.
83
- *
84
- * @param event Event to deliver
85
- */
86
- dispatch: (event: MicroAgenticaEvent) => Promise<void>;
87
-
88
- /**
89
- * Request to the OpenAI server.
90
- *
91
- * @param source The source agent of the agent
92
- * @param body The request body to the OpenAI server
93
- * @returns Response from the OpenAI server
94
- */
95
- request: (
96
- source: MicroAgenticaEvent.Source,
97
- body: Omit<OpenAI.ChatCompletionCreateParamsStreaming, "model" | "stream">,
98
- ) => Promise<AgenticaContextRequestResult>;
99
- }
1
+ import type OpenAI from "openai";
2
+
3
+ import type { MicroAgenticaEvent } from "../events/MicroAgenticaEvent";
4
+ import type { AgenticaUserMessageHistory } from "../histories/AgenticaUserMessageHistory";
5
+ import type { MicroAgenticaHistory } from "../histories/MicroAgenticaHistory";
6
+ import type { IMicroAgenticaConfig } from "../structures/IMicroAgenticaConfig";
7
+
8
+ import type { AgenticaContextRequestResult } from "./AgenticaContextRequestResult";
9
+ import type { AgenticaOperationCollection } from "./AgenticaOperationCollection";
10
+
11
+ /**
12
+ * Context of the Micro Agentic AI agent.
13
+ *
14
+ * `MicroAgenticaContext` is a structure defining the context of the
15
+ * internal agents composing the {@link MicroAgentica}.
16
+ *
17
+ * It contains every information that is required to interact with
18
+ * the AI vendor like OpenAI. It contains every operations for LLM
19
+ * function calling, and configuration used for the agent construction.
20
+ * And it contains the prompt histories, and facade controller
21
+ * functions for interacting with the {@link MicroAgentica} like
22
+ * {@link dispatch}.
23
+ *
24
+ * In such reasons, if you're planning to customize some internal
25
+ * agents, or add new agents with new process routine, you have to
26
+ * understand this context structure. Otherwise you don't have any
27
+ * plan to customize the internal agents, this context information is
28
+ * not important for you.
29
+ *
30
+ * @author Samchon
31
+ */
32
+ export interface MicroAgenticaContext {
33
+ // ----
34
+ // APPLICATION
35
+ // ----
36
+ /**
37
+ * Collection of operations.
38
+ *
39
+ * Collection of operations from every controllers, and their
40
+ * groups composed by the divide and conquer rule for the
41
+ * efficient operation selection if configured.
42
+ */
43
+ operations: AgenticaOperationCollection;
44
+
45
+ /**
46
+ * Configuration of the agent.
47
+ *
48
+ * Configuration of the agent, that is used when constructing the
49
+ * {@link Agentica} instance.
50
+ *
51
+ * @todo Write detaily after supporting the agent customization feature
52
+ */
53
+ config: IMicroAgenticaConfig | undefined;
54
+
55
+ // ----
56
+ // STATES
57
+ // ----
58
+ /**
59
+ * Prompt histories.
60
+ */
61
+ histories: MicroAgenticaHistory[];
62
+
63
+ /**
64
+ * Text prompt of the user.
65
+ *
66
+ * Text conversation written the by user through the
67
+ * {@link Agentica.conversate} function.
68
+ */
69
+ prompt: AgenticaUserMessageHistory;
70
+
71
+ /**
72
+ * Abort signal.
73
+ */
74
+ abortSignal?: AbortSignal;
75
+ // ----
76
+ // HANDLERS
77
+ // ----
78
+ /**
79
+ * Dispatch event.
80
+ *
81
+ * Dispatch event so that the agent can be handle the event
82
+ * through the {@link MicroAgentica.on} function.
83
+ *
84
+ * @param event Event to deliver
85
+ */
86
+ dispatch: (event: MicroAgenticaEvent) => Promise<void>;
87
+
88
+ /**
89
+ * Request to the OpenAI server.
90
+ *
91
+ * @param source The source agent of the agent
92
+ * @param body The request body to the OpenAI server
93
+ * @returns Response from the OpenAI server
94
+ */
95
+ request: (
96
+ source: MicroAgenticaEvent.Source,
97
+ body: Omit<OpenAI.ChatCompletionCreateParamsStreaming, "model" | "stream">,
98
+ ) => Promise<AgenticaContextRequestResult>;
99
+ }
@@ -1,5 +1,5 @@
1
- export * from "./AgenticaContext";
2
- export * from "./AgenticaOperation";
3
- export * from "./AgenticaOperationCollection";
4
- export * from "./AgenticaOperationSelection";
5
- export * from "./AgenticaTokenUsage";
1
+ export * from "./AgenticaContext";
2
+ export * from "./AgenticaOperation";
3
+ export * from "./AgenticaOperationCollection";
4
+ export * from "./AgenticaOperationSelection";
5
+ export * from "./AgenticaTokenUsage";