@agentica/core 0.8.2 → 0.8.3-dev.20250227

package/src/structures/IAgenticaContext.ts

@@ -1,128 +1,128 @@
-import OpenAI from "openai";
-
-import { AgenticaSource } from "../typings/AgenticaSource";
-import { IAgenticaConfig } from "./IAgenticaConfig";
-import { IAgenticaEvent } from "./IAgenticaEvent";
-import { IAgenticaOperationCollection } from "./IAgenticaOperationCollection";
-import { IAgenticaOperationSelection } from "./IAgenticaOperationSelection";
-import { IAgenticaPrompt } from "./IAgenticaPrompt";
-
-/**
- * Context of the Nestia A.I. agent.
- *
- * `IAgenticaContext` is a structure defining the context of the
- * internal agents composing the {@link Agentica}, like function
- * selector, executor, and describer, and so on. For example, if an
- * agent has been configured to utilize the OpenAI, the context will
- * be delivered to the below components.
- *
- * - {@link ChatGptAgent}
- *   - {@link ChatGptInitializeFunctionAgent}
- *   - {@link ChatGptSelectFunctionAgent}
- *   - {@link ChatGptExecuteFunctionAgent}
- *   - {@link ChatGptDescribeFunctionAgent}
- *   - {@link ChatGptCancelFunctionAgent}
- *
- * Also, as its name is context, it contains every information that
- * is required to interact with the AI provider like OpenAI. It
- * contains every operations for LLM function calling, and
- * configuration used for the agent construction. And it contains
- * the prompt histories, and facade controller functions for
- * interacting with the {@link Agentica} like {@link dispatch}.
- *
- * In such reasons, if you're planning to customize some internal
- * agents, or add new agents with new process routine, you have to
- * understand this context structure. Otherwise you don't have any
- * plan to customize the internal agents, this context information is
- * not important for you.
- *
- * @author Samchon
- */
-export interface IAgenticaContext {
-  //----
-  // APPLICATION
-  //----
-  /**
-   * Collection of operations.
-   *
-   * Collection of operations from every controllers, and their
-   * groups composed by the divide and conquer rule for the
-   * efficient operation selection if configured.
-   */
-  operations: IAgenticaOperationCollection;
-
-  /**
-   * Configuration of the agent.
-   *
-   * Configuration of the agent, that is used when constructing the
-   * {@link Agentica} instance.
-   *
-   * @todo Write detaily after supporting the agent customization feature
-   */
-  config: IAgenticaConfig | undefined;
-
-  //----
-  // STATES
-  //----
-  /**
-   * Prompt histories.
-   */
-  histories: IAgenticaPrompt[];
-
-  /**
-   * Stacked operations.
-   *
-   * In other words, list of candidate operations for the LLM function calling.
-   */
-  stack: IAgenticaOperationSelection[];
-
-  /**
-   * Text prompt of the user.
-   *
-   * Text conversation written the by user through the
-   * {@link Agentica.conversate} function.
-   */
-  prompt: IAgenticaPrompt.IText<"user">;
-
-  /**
-   * Whether the agent is ready.
-   *
-   * Returns a boolean value indicates whether the agent is ready to
-   * perform the function calling.
-   *
-   * If the agent has called the {@link IAgenticaContext.initialize},
-   * it returns `true`. Otherwise the {@link initialize} has never been
-   * called, returns `false`.
-   */
-  ready: () => boolean;
-
-  //----
-  // HANDLERS
-  //----
-  /**
-   * Dispatch event.
-   *
-   * Dispatch event so that the agent can be handle the event
-   * through the {@link Agentica.on} function.
-   *
-   * @param event Event to deliver
-   */
-  dispatch: (event: IAgenticaEvent) => Promise<void>;
-
-  /**
-   * Request to the OpenAI server.
-   *
-   * @param source The source agent of the agent
-   * @param body The request body to the OpenAI server
-   * @returns Response from the OpenAI server
-   */
-  request: (
-    source: AgenticaSource,
-    body: Omit<OpenAI.ChatCompletionCreateParamsNonStreaming, "model">,
-  ) => Promise<OpenAI.ChatCompletion>;
-
-  /**
-   * Initialize the agent.
-   */
-  initialize: () => Promise<void>;
-}
+import OpenAI from "openai";
+
+import { AgenticaSource } from "../typings/AgenticaSource";
+import { IAgenticaConfig } from "./IAgenticaConfig";
+import { IAgenticaEvent } from "./IAgenticaEvent";
+import { IAgenticaOperationCollection } from "./IAgenticaOperationCollection";
+import { IAgenticaOperationSelection } from "./IAgenticaOperationSelection";
+import { IAgenticaPrompt } from "./IAgenticaPrompt";
+
+/**
+ * Context of the Nestia A.I. agent.
+ *
+ * `IAgenticaContext` is a structure defining the context of the
+ * internal agents composing the {@link Agentica}, like function
+ * selector, executor, and describer, and so on. For example, if an
+ * agent has been configured to utilize the OpenAI, the context will
+ * be delivered to the below components.
+ *
+ * - {@link ChatGptAgent}
+ *   - {@link ChatGptInitializeFunctionAgent}
+ *   - {@link ChatGptSelectFunctionAgent}
+ *   - {@link ChatGptExecuteFunctionAgent}
+ *   - {@link ChatGptDescribeFunctionAgent}
+ *   - {@link ChatGptCancelFunctionAgent}
+ *
+ * Also, as its name is context, it contains every information that
+ * is required to interact with the AI provider like OpenAI. It
+ * contains every operations for LLM function calling, and
+ * configuration used for the agent construction. And it contains
+ * the prompt histories, and facade controller functions for
+ * interacting with the {@link Agentica} like {@link dispatch}.
+ *
+ * In such reasons, if you're planning to customize some internal
+ * agents, or add new agents with new process routine, you have to
+ * understand this context structure. Otherwise you don't have any
+ * plan to customize the internal agents, this context information is
+ * not important for you.
+ *
+ * @author Samchon
+ */
+export interface IAgenticaContext {
+  //----
+  // APPLICATION
+  //----
+  /**
+   * Collection of operations.
+   *
+   * Collection of operations from every controllers, and their
+   * groups composed by the divide and conquer rule for the
+   * efficient operation selection if configured.
+   */
+  operations: IAgenticaOperationCollection;
+
+  /**
+   * Configuration of the agent.
+   *
+   * Configuration of the agent, that is used when constructing the
+   * {@link Agentica} instance.
+   *
+   * @todo Write detaily after supporting the agent customization feature
+   */
+  config: IAgenticaConfig | undefined;
+
+  //----
+  // STATES
+  //----
+  /**
+   * Prompt histories.
+   */
+  histories: IAgenticaPrompt[];
+
+  /**
+   * Stacked operations.
+   *
+   * In other words, list of candidate operations for the LLM function calling.
+   */
+  stack: IAgenticaOperationSelection[];
+
+  /**
+   * Text prompt of the user.
+   *
+   * Text conversation written the by user through the
+   * {@link Agentica.conversate} function.
+   */
+  prompt: IAgenticaPrompt.IText<"user">;
+
+  /**
+   * Whether the agent is ready.
+   *
+   * Returns a boolean value indicates whether the agent is ready to
+   * perform the function calling.
+   *
+   * If the agent has called the {@link IAgenticaContext.initialize},
+   * it returns `true`. Otherwise the {@link initialize} has never been
+   * called, returns `false`.
+   */
+  ready: () => boolean;
+
+  //----
+  // HANDLERS
+  //----
+  /**
+   * Dispatch event.
+   *
+   * Dispatch event so that the agent can be handle the event
+   * through the {@link Agentica.on} function.
+   *
+   * @param event Event to deliver
+   */
+  dispatch: (event: IAgenticaEvent) => Promise<void>;
+
+  /**
+   * Request to the OpenAI server.
+   *
+   * @param source The source agent of the agent
+   * @param body The request body to the OpenAI server
+   * @returns Response from the OpenAI server
+   */
+  request: (
+    source: AgenticaSource,
+    body: Omit<OpenAI.ChatCompletionCreateParamsNonStreaming, "model">,
+  ) => Promise<OpenAI.ChatCompletion>;
+
+  /**
+   * Initialize the agent.
+   */
+  initialize: () => Promise<void>;
+}

package/src/structures/IAgenticaController.ts

@@ -1,130 +1,130 @@
-import {
-  IHttpConnection,
-  IHttpLlmApplication,
-  IHttpLlmFunction,
-  IHttpResponse,
-} from "@samchon/openapi";
-import { ILlmApplicationOfValidate, ILlmFunctionOfValidate } from "typia";
-
-/**
- * Controller of the Nestia Agent.
- *
- * `IAgenticaController` is a type represents a controller of the
- * {@link Agentica}, which serves a set of functions to be called
- * by A.I. chatbot from LLM function calling.
- *
- * Also, `IAgenticaController` is an union type which can specify
- * a subtype by checking the {@link protocol} property.
- *
- * - HTTP server: {@link IAgenticaController..IHttp}
- * - TypeScript class: {@link IAgenticaController.IClass}
- *
- * @author Samchon
- */
-export type IAgenticaController =
-  | IAgenticaController.IHttp
-  | IAgenticaController.IClass;
-export namespace IAgenticaController {
-  /**
-   * HTTP controller.
-   *
-   * You can make it by {@link createHttpLlmApplication} function with
-   * the Swagger or OpenAPI document.
-   */
-  export interface IHttp extends IBase<"http", IHttpLlmApplication<"chatgpt">> {
-    /**
-     * Connection to the server.
-     *
-     * Connection to the API server including the URL and headers.
-     */
-    connection: IHttpConnection;
-
-    /**
-     * Executor of the API function.
-     *
-     * @param props Properties of the API function call
-     * @returns HTTP response of the API function call
-     */
-    execute?: (props: {
-      /**
-       * Connection to the server.
-       */
-      connection: IHttpConnection;
-
-      /**
-       * Application schema.
-       */
-      application: IHttpLlmApplication<"chatgpt">;
-
-      /**
-       * Function schema.
-       */
-      function: IHttpLlmFunction<"chatgpt">;
-
-      /**
-       * Arguments of the function calling.
-       *
-       * It is an object of key-value pairs of the API function's parameters.
-       * The property keys are composed by below rules:
-       *
-       * - parameter names
-       * - query parameter as an object type if exists
-       * - body parameter if exists
-       */
-      arguments: object;
-    }) => Promise<IHttpResponse>;
-  }
-
-  /**
-   * TypeScript class controller.
-   *
-   * You can make it by `typia.llm.application<App, Model>()` function.
-   *
-   * - https://typia.io/docs/llm/application
-   */
-  export interface IClass
-    extends IBase<"class", ILlmApplicationOfValidate<"chatgpt">> {
-    /**
-     * Executor of the class function.
-     *
-     * Executor of the class function, by target class instance
-     * or callback function with given schema and arguments
-     * information.
-     */
-    execute:
-      | object
-      | ((props: {
-          /**
-           * Target application schema.
-           */
-          application: ILlmApplicationOfValidate<"chatgpt">;
-
-          /**
-           * Target function schema.
-           */
-          function: ILlmFunctionOfValidate<"chatgpt">;
-
-          /**
-           * Arguments of the function calling.
-           */
-          arguments: object;
-        }) => Promise<unknown>);
-  }
-
-  interface IBase<Protocol, Application> {
-    /**
-     * Protocol discrminator.
-     */
-    protocol: Protocol;
-
-    /**
-     * Name of the controller.
-     */
-    name: string;
-
-    /**
-     * Application schema of function calling.
-     */
-    application: Application;
-  }
-}
+import {
+  IHttpConnection,
+  IHttpLlmApplication,
+  IHttpLlmFunction,
+  IHttpResponse,
+} from "@samchon/openapi";
+import { ILlmApplicationOfValidate, ILlmFunctionOfValidate } from "typia";
+
+/**
+ * Controller of the Nestia Agent.
+ *
+ * `IAgenticaController` is a type represents a controller of the
+ * {@link Agentica}, which serves a set of functions to be called
+ * by A.I. chatbot from LLM function calling.
+ *
+ * Also, `IAgenticaController` is an union type which can specify
+ * a subtype by checking the {@link protocol} property.
+ *
+ * - HTTP server: {@link IAgenticaController..IHttp}
+ * - TypeScript class: {@link IAgenticaController.IClass}
+ *
+ * @author Samchon
+ */
+export type IAgenticaController =
+  | IAgenticaController.IHttp
+  | IAgenticaController.IClass;
+export namespace IAgenticaController {
+  /**
+   * HTTP controller.
+   *
+   * You can make it by {@link createHttpLlmApplication} function with
+   * the Swagger or OpenAPI document.
+   */
+  export interface IHttp extends IBase<"http", IHttpLlmApplication<"chatgpt">> {
+    /**
+     * Connection to the server.
+     *
+     * Connection to the API server including the URL and headers.
+     */
+    connection: IHttpConnection;
+
+    /**
+     * Executor of the API function.
+     *
+     * @param props Properties of the API function call
+     * @returns HTTP response of the API function call
+     */
+    execute?: (props: {
+      /**
+       * Connection to the server.
+       */
+      connection: IHttpConnection;
+
+      /**
+       * Application schema.
+       */
+      application: IHttpLlmApplication<"chatgpt">;
+
+      /**
+       * Function schema.
+       */
+      function: IHttpLlmFunction<"chatgpt">;
+
+      /**
+       * Arguments of the function calling.
+       *
+       * It is an object of key-value pairs of the API function's parameters.
+       * The property keys are composed by below rules:
+       *
+       * - parameter names
+       * - query parameter as an object type if exists
+       * - body parameter if exists
+       */
+      arguments: object;
+    }) => Promise<IHttpResponse>;
+  }
+
+  /**
+   * TypeScript class controller.
+   *
+   * You can make it by `typia.llm.application<App, Model>()` function.
+   *
+   * - https://typia.io/docs/llm/application
+   */
+  export interface IClass
+    extends IBase<"class", ILlmApplicationOfValidate<"chatgpt">> {
+    /**
+     * Executor of the class function.
+     *
+     * Executor of the class function, by target class instance
+     * or callback function with given schema and arguments
+     * information.
+     */
+    execute:
+      | object
+      | ((props: {
+          /**
+           * Target application schema.
+           */
+          application: ILlmApplicationOfValidate<"chatgpt">;
+
+          /**
+           * Target function schema.
+           */
+          function: ILlmFunctionOfValidate<"chatgpt">;
+
+          /**
+           * Arguments of the function calling.
+           */
+          arguments: object;
+        }) => Promise<unknown>);
+  }
+
+  interface IBase<Protocol, Application> {
+    /**
+     * Protocol discrminator.
+     */
+    protocol: Protocol;
+
+    /**
+     * Name of the controller.
+     */
+    name: string;
+
+    /**
+     * Application schema of function calling.
+     */
+    application: Application;
+  }
+}