@agentica/core 0.8.2 → 0.8.3-dev.20250227

package/src/structures/IAgenticaOperationSelection.ts

@@ -1,69 +1,69 @@
-import { IHttpLlmFunction } from "@samchon/openapi";
-import { ILlmFunctionOfValidate } from "typia";
-
-import { IAgenticaController } from "./IAgenticaController";
-
-/**
- * Nestia agent operation selection.
- *
- * `IAgenticaOperationSelection` is a type represents an operation
- * which has been selected by the A.I. chatbot of {@link Agentica}
- * class for the LLM (Large Language Model) function calling with
- * detailed {@link reason} of the selection (or cancellation).
- *
- * Also, `IAgenticaOperationSelection` is an union type that can
- * specify a subtype by checking the {@link protocol} property.
- *
- * @author Samchon
- */
-export type IAgenticaOperationSelection =
-  | IAgenticaOperationSelection.IHttp
-  | IAgenticaOperationSelection.IClass;
-export namespace IAgenticaOperationSelection {
-  export type IHttp = IBase<
-    "http",
-    IAgenticaController.IHttp,
-    IHttpLlmFunction<"chatgpt">
-  >;
-
-  export type IClass = IBase<
-    "class",
-    IAgenticaController.IClass,
-    ILlmFunctionOfValidate<"chatgpt">
-  >;
-
-  interface IBase<Protocol, Controller, Function> {
-    /**
-     * Discriminator protocol.
-     */
-    protocol: Protocol;
-
-    /**
-     * Belonged controller of the target function.
-     */
-    controller: Controller;
-
-    /**
-     * Target function.
-     *
-     * Function that has been selected to prepare LLM function calling,
-     * or canceled due to no more required.
-     */
-    function: Function;
-
-    /**
-     * Identifier name of the target function.
-     *
-     * If {@link Agentica} has multiple {@link IAgenticaController}s,
-     * the `name` can be different from target function's name.
-     */
-    name: string;
-
-    /**
-     * The reason of the function selection or cancellation.
-     */
-    reason: string;
-
-    toJSON(): Omit<IBase<Protocol, string, string>, "toJSON">;
-  }
-}
+import { IHttpLlmFunction } from "@samchon/openapi";
+import { ILlmFunctionOfValidate } from "typia";
+
+import { IAgenticaController } from "./IAgenticaController";
+
+/**
+ * Nestia agent operation selection.
+ *
+ * `IAgenticaOperationSelection` is a type represents an operation
+ * which has been selected by the A.I. chatbot of {@link Agentica}
+ * class for the LLM (Large Language Model) function calling with
+ * detailed {@link reason} of the selection (or cancellation).
+ *
+ * Also, `IAgenticaOperationSelection` is an union type that can
+ * specify a subtype by checking the {@link protocol} property.
+ *
+ * @author Samchon
+ */
+export type IAgenticaOperationSelection =
+  | IAgenticaOperationSelection.IHttp
+  | IAgenticaOperationSelection.IClass;
+export namespace IAgenticaOperationSelection {
+  export type IHttp = IBase<
+    "http",
+    IAgenticaController.IHttp,
+    IHttpLlmFunction<"chatgpt">
+  >;
+
+  export type IClass = IBase<
+    "class",
+    IAgenticaController.IClass,
+    ILlmFunctionOfValidate<"chatgpt">
+  >;
+
+  interface IBase<Protocol, Controller, Function> {
+    /**
+     * Discriminator protocol.
+     */
+    protocol: Protocol;
+
+    /**
+     * Belonged controller of the target function.
+     */
+    controller: Controller;
+
+    /**
+     * Target function.
+     *
+     * Function that has been selected to prepare LLM function calling,
+     * or canceled due to no more required.
+     */
+    function: Function;
+
+    /**
+     * Identifier name of the target function.
+     *
+     * If {@link Agentica} has multiple {@link IAgenticaController}s,
+     * the `name` can be different from target function's name.
+     */
+    name: string;
+
+    /**
+     * The reason of the function selection or cancellation.
+     */
+    reason: string;
+
+    toJSON(): Omit<IBase<Protocol, string, string>, "toJSON">;
+  }
+}

package/src/structures/IAgenticaPrompt.ts

@@ -1,173 +1,173 @@
-import { IHttpLlmFunction, IHttpResponse } from "@samchon/openapi";
-import { ILlmFunctionOfValidate } from "typia";
-
-import { IAgenticaController } from "./IAgenticaController";
-import { IAgenticaOperationSelection } from "./IAgenticaOperationSelection";
-
-/**
- * Nestia A.I. chatbot prompt.
- *
- * `IWrtnChatPrompt` is an union type of all possible prompts that can
- * be generated by the A.I. chatbot of the {@link Agentica} class.
- *
- * In other words, `IWrtnChatPrompt` is a type of chat history that
- * is occurred during the conversation between the user and the A.I. chatbot
- * in the {@link Agentica} class.
- *
- * If you want to continue the previous A.I. chatbot session, you can
- * accomplish it by assigning the {@link IAgenticaProps.histories}
- * property when creating a new {@link Agentica} instance.
- *
- * @author Samchon
- */
-export type IAgenticaPrompt =
-  | IAgenticaPrompt.IText
-  | IAgenticaPrompt.ISelect
-  | IAgenticaPrompt.ICancel
-  | IAgenticaPrompt.IExecute
-  | IAgenticaPrompt.IDescribe;
-export namespace IAgenticaPrompt {
-  /**
-   * Select prompt.
-   *
-   * Selection prompt about candidate functions to call.
-   */
-  export interface ISelect extends IBase<"select"> {
-    /**
-     * ID of the LLM tool call result.
-     */
-    id: string;
-
-    /**
-     * Operations that have been selected.
-     */
-    operations: IAgenticaOperationSelection[];
-  }
-
-  /**
-   * Cancel prompt.
-   *
-   * Cancellation prompt about the candidate functions to be discarded.
-   */
-  export interface ICancel extends IBase<"cancel"> {
-    /**
-     * ID of the LLM tool call result.
-     */
-    id: string;
-
-    /**
-     * Operations that have been cancelled.
-     */
-    operations: IAgenticaOperationSelection[];
-  }
-
-  /**
-   * Execute prompt.
-   *
-   * Execution prompt about the LLM function calling.
-   */
-  export type IExecute = IExecute.IHttp | IExecute.IClass;
-  export namespace IExecute {
-    export type IHttp = IBase<
-      "http",
-      IAgenticaController.IHttp,
-      IHttpLlmFunction<"chatgpt">,
-      IHttpResponse
-    >;
-    export type IClass = IBase<
-      "class",
-      IAgenticaController.IClass,
-      ILlmFunctionOfValidate<"chatgpt">,
-      any
-    >;
-    interface IBase<Protocol, Controller, Function, Value> {
-      /**
-       * Discriminator type.
-       */
-      type: "execute";
-
-      /**
-       * Protocol discriminator.
-       */
-      protocol: Protocol;
-
-      /**
-       * Belonged controller of the target function.
-       */
-      controller: Controller;
-
-      /**
-       * Target function to call.
-       */
-      function: Function;
-
-      /**
-       * ID of the LLM tool call result.
-       */
-      id: string;
-
-      /**
-       * Identifier name of the function.
-       *
-       * If {@link Agentica} has multiple {@link IAgenticaController}s,
-       * the `name` can be different from target function's name.
-       */
-      name: string;
-
-      /**
-       * Arguments of the LLM function calling.
-       */
-      arguments: object;
-
-      /**
-       * Return value.
-       */
-      value: Value;
-
-      toJSON(): Omit<IBase<Protocol, string, string, Value>, "toJSON">;
-    }
-  }
-
-  /**
-   * Description prompt.
-   *
-   * Description prompt about the return value of the LLM function calling.
-   */
-  export interface IDescribe extends IBase<"describe"> {
-    /**
-     * Executions of the LLM function calling.
-     *
-     * This prompt describes the return value of them.
-     */
-    executions: IExecute[];
-
-    /**
-     * Description text.
-     */
-    text: string;
-  }
-
-  /**
-   * Text prompt.
-   */
-  export interface IText<
-    Role extends "assistant" | "user" = "assistant" | "user",
-  > extends IBase<"text"> {
-    /**
-     * Role of the orator.
-     */
-    role: Role;
-
-    /**
-     * The text content.
-     */
-    text: string;
-  }
-
-  interface IBase<Type extends string> {
-    /**
-     * Discriminator type.
-     */
-    type: Type;
-  }
-}
+import { IHttpLlmFunction, IHttpResponse } from "@samchon/openapi";
+import { ILlmFunctionOfValidate } from "typia";
+
+import { IAgenticaController } from "./IAgenticaController";
+import { IAgenticaOperationSelection } from "./IAgenticaOperationSelection";
+
+/**
+ * Nestia A.I. chatbot prompt.
+ *
+ * `IWrtnChatPrompt` is an union type of all possible prompts that can
+ * be generated by the A.I. chatbot of the {@link Agentica} class.
+ *
+ * In other words, `IWrtnChatPrompt` is a type of chat history that
+ * is occurred during the conversation between the user and the A.I. chatbot
+ * in the {@link Agentica} class.
+ *
+ * If you want to continue the previous A.I. chatbot session, you can
+ * accomplish it by assigning the {@link IAgenticaProps.histories}
+ * property when creating a new {@link Agentica} instance.
+ *
+ * @author Samchon
+ */
+export type IAgenticaPrompt =
+  | IAgenticaPrompt.IText
+  | IAgenticaPrompt.ISelect
+  | IAgenticaPrompt.ICancel
+  | IAgenticaPrompt.IExecute
+  | IAgenticaPrompt.IDescribe;
+export namespace IAgenticaPrompt {
+  /**
+   * Select prompt.
+   *
+   * Selection prompt about candidate functions to call.
+   */
+  export interface ISelect extends IBase<"select"> {
+    /**
+     * ID of the LLM tool call result.
+     */
+    id: string;
+
+    /**
+     * Operations that have been selected.
+     */
+    operations: IAgenticaOperationSelection[];
+  }
+
+  /**
+   * Cancel prompt.
+   *
+   * Cancellation prompt about the candidate functions to be discarded.
+   */
+  export interface ICancel extends IBase<"cancel"> {
+    /**
+     * ID of the LLM tool call result.
+     */
+    id: string;
+
+    /**
+     * Operations that have been cancelled.
+     */
+    operations: IAgenticaOperationSelection[];
+  }
+
+  /**
+   * Execute prompt.
+   *
+   * Execution prompt about the LLM function calling.
+   */
+  export type IExecute = IExecute.IHttp | IExecute.IClass;
+  export namespace IExecute {
+    export type IHttp = IBase<
+      "http",
+      IAgenticaController.IHttp,
+      IHttpLlmFunction<"chatgpt">,
+      IHttpResponse
+    >;
+    export type IClass = IBase<
+      "class",
+      IAgenticaController.IClass,
+      ILlmFunctionOfValidate<"chatgpt">,
+      any
+    >;
+    interface IBase<Protocol, Controller, Function, Value> {
+      /**
+       * Discriminator type.
+       */
+      type: "execute";
+
+      /**
+       * Protocol discriminator.
+       */
+      protocol: Protocol;
+
+      /**
+       * Belonged controller of the target function.
+       */
+      controller: Controller;
+
+      /**
+       * Target function to call.
+       */
+      function: Function;
+
+      /**
+       * ID of the LLM tool call result.
+       */
+      id: string;
+
+      /**
+       * Identifier name of the function.
+       *
+       * If {@link Agentica} has multiple {@link IAgenticaController}s,
+       * the `name` can be different from target function's name.
+       */
+      name: string;
+
+      /**
+       * Arguments of the LLM function calling.
+       */
+      arguments: object;
+
+      /**
+       * Return value.
+       */
+      value: Value;
+
+      toJSON(): Omit<IBase<Protocol, string, string, Value>, "toJSON">;
+    }
+  }
+
+  /**
+   * Description prompt.
+   *
+   * Description prompt about the return value of the LLM function calling.
+   */
+  export interface IDescribe extends IBase<"describe"> {
+    /**
+     * Executions of the LLM function calling.
+     *
+     * This prompt describes the return value of them.
+     */
+    executions: IExecute[];
+
+    /**
+     * Description text.
+     */
+    text: string;
+  }
+
+  /**
+   * Text prompt.
+   */
+  export interface IText<
+    Role extends "assistant" | "user" = "assistant" | "user",
+  > extends IBase<"text"> {
+    /**
+     * Role of the orator.
+     */
+    role: Role;
+
+    /**
+     * The text content.
+     */
+    text: string;
+  }
+
+  interface IBase<Type extends string> {
+    /**
+     * Discriminator type.
+     */
+    type: Type;
+  }
+}

package/src/structures/IAgenticaProps.ts

@@ -1,64 +1,64 @@
-import { Primitive } from "typia";
-
-import { IAgenticaConfig } from "./IAgenticaConfig";
-import { IAgenticaController } from "./IAgenticaController";
-import { IAgenticaPrompt } from "./IAgenticaPrompt";
-import { IAgenticaProvider } from "./IAgenticaProvider";
-
-/**
- * Properties of the Nestia Agent.
- *
- * `IAgenticaProps` is an interface that defines the properties
- * of the {@link Agentica.constructor}. In the `IAgenticaProps`,
- * there're everything to prepare to create a Super A.I. chatbot
- * performing the LLM (Large Language Model) function calling.
- *
- * At first, you have to specify the LLM service {@link provider} like
- * OpenAI with its API key and client API. And then, you have to define
- * the {@link controllers} serving the functions to call. The controllers
- * are separated by two protocols; HTTP API and TypeScript class. At last,
- * you can {@link config configure} the agent by setting the locale, timezone,
- * and some of system prompts.
- *
- * Additionally, if you want to start from the previous A.I. chatbot
- * session, you can accomplish it by assigning the previous prompt
- * histories to the {@link histories} property.
- *
- * @author Samchon
- */
-export interface IAgenticaProps {
-  /**
-   * LLM service provider.
-   */
-  provider: IAgenticaProvider;
-
-  /**
-   * Controllers serving functions to call.
-   */
-  controllers: IAgenticaController[];
-
-  /**
-   * Configuration of agent.
-   *
-   * Configuration of A.I. chatbot agent including the user's locale,
-   * timezone, and some of system prompts. Also, you can affect to the
-   * LLM function selecting/calling logic by configuring additional
-   * properties.
-   *
-   * If you don't configure this property, these values would be default.
-   *
-   * - `locale`: your system's locale and timezone
-   * - `timezone`: your system's timezone
-   * - `systemPrompt`: default prompts written in markdown
-   *   - https://github.com/samchon/nestia/tree/master/packages/agent/prompts
-   */
-  config?: IAgenticaConfig;
-
-  /**
-   * Prompt histories.
-   *
-   * If you're starting the conversation from an existing session,
-   * assign the previouis prompt histories to this property.
-   */
-  histories?: Primitive<IAgenticaPrompt>[];
-}
+import { Primitive } from "typia";
+
+import { IAgenticaConfig } from "./IAgenticaConfig";
+import { IAgenticaController } from "./IAgenticaController";
+import { IAgenticaPrompt } from "./IAgenticaPrompt";
+import { IAgenticaProvider } from "./IAgenticaProvider";
+
+/**
+ * Properties of the Nestia Agent.
+ *
+ * `IAgenticaProps` is an interface that defines the properties
+ * of the {@link Agentica.constructor}. In the `IAgenticaProps`,
+ * there're everything to prepare to create a Super A.I. chatbot
+ * performing the LLM (Large Language Model) function calling.
+ *
+ * At first, you have to specify the LLM service {@link provider} like
+ * OpenAI with its API key and client API. And then, you have to define
+ * the {@link controllers} serving the functions to call. The controllers
+ * are separated by two protocols; HTTP API and TypeScript class. At last,
+ * you can {@link config configure} the agent by setting the locale, timezone,
+ * and some of system prompts.
+ *
+ * Additionally, if you want to start from the previous A.I. chatbot
+ * session, you can accomplish it by assigning the previous prompt
+ * histories to the {@link histories} property.
+ *
+ * @author Samchon
+ */
+export interface IAgenticaProps {
+  /**
+   * LLM service provider.
+   */
+  provider: IAgenticaProvider;
+
+  /**
+   * Controllers serving functions to call.
+   */
+  controllers: IAgenticaController[];
+
+  /**
+   * Configuration of agent.
+   *
+   * Configuration of A.I. chatbot agent including the user's locale,
+   * timezone, and some of system prompts. Also, you can affect to the
+   * LLM function selecting/calling logic by configuring additional
+   * properties.
+   *
+   * If you don't configure this property, these values would be default.
+   *
+   * - `locale`: your system's locale and timezone
+   * - `timezone`: your system's timezone
+   * - `systemPrompt`: default prompts written in markdown
+   *   - https://github.com/samchon/nestia/tree/master/packages/agent/prompts
+   */
+  config?: IAgenticaConfig;
+
+  /**
+   * Prompt histories.
+   *
+   * If you're starting the conversation from an existing session,
+   * assign the previouis prompt histories to this property.
+   */
+  histories?: Primitive<IAgenticaPrompt>[];
+}