@agentica/core 0.8.3 → 0.9.0-dev.20250302

package/src/structures/IAgenticaController.ts

@@ -1,130 +1,132 @@
-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,
+  ILlmSchema,
+} 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<Model extends ILlmSchema.Model> =
+  | IAgenticaController.IHttp<Model>
+  | IAgenticaController.IClass<Model>;
+export namespace IAgenticaController {
+  /**
+   * HTTP controller.
+   *
+   * You can make it by {@link createHttpLlmApplication} function with
+   * the Swagger or OpenAPI document.
+   */
+  export interface IHttp<Model extends ILlmSchema.Model>
+    extends IBase<"http", IHttpLlmApplication<Model>> {
+    /**
+     * 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<Model>;
+
+      /**
+       * Function schema.
+       */
+      function: IHttpLlmFunction<Model>;
+
+      /**
+       * 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<Model extends ILlmSchema.Model>
+    extends IBase<"class", ILlmApplicationOfValidate<Model>> {
+    /**
+     * 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<Model>;
+
+          /**
+           * Target function schema.
+           */
+          function: ILlmFunctionOfValidate<Model>;
+
+          /**
+           * 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;
+  }
+}