@agentica/core 0.12.0 → 0.12.2-dev.20250314

package/src/json/IAgenticaPromptJson.ts

@@ -1,130 +1,130 @@
-import { IAgenticaOperationJson } from "./IAgenticaOperationJson";
-import { IAgenticaOperationSelectionJson } from "./IAgenticaOperationSelectionJson";
-
-/**
- * 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 IAgenticaPromptJson =
-  | IAgenticaPromptJson.IText
-  | IAgenticaPromptJson.ISelect
-  | IAgenticaPromptJson.ICancel
-  | IAgenticaPromptJson.IExecute
-  | IAgenticaPromptJson.IDescribe;
-export namespace IAgenticaPromptJson {
-  /**
-   * 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.
-     */
-    selections: IAgenticaOperationSelectionJson[];
-  }
-
-  /**
-   * 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.
-     */
-    selections: IAgenticaOperationSelectionJson[];
-  }
-
-  /**
-   * Execute prompt.
-   *
-   * Execution prompt about the LLM function calling.
-   */
-  export interface IExecute extends IBase<"execute"> {
-    /**
-     * ID of the LLM tool call result.
-     */
-    id: string;
-
-    /**
-     * Target operation to call.
-     */
-    operation: IAgenticaOperationJson;
-
-    /**
-     * Arguments of the LLM function calling.
-     */
-    arguments: Record<string, any>;
-
-    /**
-     * Return value.
-     */
-    value: any;
-  }
-
-  /**
-   * 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.
-     */
-    executes: 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 { IAgenticaOperationJson } from "./IAgenticaOperationJson";
+import { IAgenticaOperationSelectionJson } from "./IAgenticaOperationSelectionJson";
+
+/**
+ * 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 IAgenticaPromptJson =
+  | IAgenticaPromptJson.IText
+  | IAgenticaPromptJson.ISelect
+  | IAgenticaPromptJson.ICancel
+  | IAgenticaPromptJson.IExecute
+  | IAgenticaPromptJson.IDescribe;
+export namespace IAgenticaPromptJson {
+  /**
+   * 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.
+     */
+    selections: IAgenticaOperationSelectionJson[];
+  }
+
+  /**
+   * 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.
+     */
+    selections: IAgenticaOperationSelectionJson[];
+  }
+
+  /**
+   * Execute prompt.
+   *
+   * Execution prompt about the LLM function calling.
+   */
+  export interface IExecute extends IBase<"execute"> {
+    /**
+     * ID of the LLM tool call result.
+     */
+    id: string;
+
+    /**
+     * Target operation to call.
+     */
+    operation: IAgenticaOperationJson;
+
+    /**
+     * Arguments of the LLM function calling.
+     */
+    arguments: Record<string, any>;
+
+    /**
+     * Return value.
+     */
+    value: any;
+  }
+
+  /**
+   * 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.
+     */
+    executes: 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/json/IAgenticaTokenUsageJson.ts

@@ -1,107 +1,107 @@
-/**
- * Token usage information from the A.I. chatbot.
- *
- * `IAgenticaTokenUsageJson` is a structure representing the token usage
- * information from the {@link Agentica} class. And you can get the
- * token usage information by calling the {@link Agentica.getTokenUsage}
- * method.
- *
- * For reference, `IAgenticaTokenUsageJson` provides only the token usage
- * information, and does not contain any price or cost information. It is
- * because the price or cost can be changed by below reasons.
- *
- * - Type of {@link IAgenticaProps.vendor LLM vendor}
- * - {@link IAgenticaVendor.model} in the LLM vendor.
- * - Just by a policy change of the LLM vendor company.
- *
- * @author Samchon
- */
-export interface IAgenticaTokenUsageJson {
-  /**
-   * Aggregated token usage.
-   */
-  aggregate: IAgenticaTokenUsageJson.IComponent;
-
-  /**
-   * Token uasge of initializer agent.
-   */
-  initialize: IAgenticaTokenUsageJson.IComponent;
-
-  /**
-   * Token usage of function selector agent.
-   */
-  select: IAgenticaTokenUsageJson.IComponent;
-
-  /**
-   * Token usage of function canceler agent.
-   */
-  cancel: IAgenticaTokenUsageJson.IComponent;
-
-  /**
-   * Token usage of function caller agent.
-   */
-  call: IAgenticaTokenUsageJson.IComponent;
-
-  /**
-   * Token usage of function calling describer agent.
-   */
-  describe: IAgenticaTokenUsageJson.IComponent;
-}
-export namespace IAgenticaTokenUsageJson {
-  export interface IComponent {
-    /**
-     * Total token usage.
-     */
-    total: number;
-
-    /**
-     * Input token usage of detailed.
-     */
-    input: IInput;
-
-    /**
-     * Output token usage of detailed.
-     */
-    output: IOutput;
-  }
-
-  /**
-   * Input token usage of detailed.
-   */
-  export interface IInput {
-    /**
-     * Total amount of input token uasge.
-     */
-    total: number;
-
-    /**
-     * Cached token usage.
-     */
-    cached: number;
-  }
-
-  /**
-   * Output token usage of detailed.
-   */
-  export interface IOutput {
-    /**
-     * Total amount of output token usage.
-     */
-    total: number;
-
-    /**
-     * Reasoning token usage.
-     */
-    reasoning: number;
-
-    /**
-     * Prediction token usage.
-     */
-    accepted_prediction: number;
-
-    /**
-     * Rejected prediction token usage.
-     */
-    rejected_prediction: number;
-  }
-}
+/**
+ * Token usage information from the A.I. chatbot.
+ *
+ * `IAgenticaTokenUsageJson` is a structure representing the token usage
+ * information from the {@link Agentica} class. And you can get the
+ * token usage information by calling the {@link Agentica.getTokenUsage}
+ * method.
+ *
+ * For reference, `IAgenticaTokenUsageJson` provides only the token usage
+ * information, and does not contain any price or cost information. It is
+ * because the price or cost can be changed by below reasons.
+ *
+ * - Type of {@link IAgenticaProps.vendor LLM vendor}
+ * - {@link IAgenticaVendor.model} in the LLM vendor.
+ * - Just by a policy change of the LLM vendor company.
+ *
+ * @author Samchon
+ */
+export interface IAgenticaTokenUsageJson {
+  /**
+   * Aggregated token usage.
+   */
+  aggregate: IAgenticaTokenUsageJson.IComponent;
+
+  /**
+   * Token uasge of initializer agent.
+   */
+  initialize: IAgenticaTokenUsageJson.IComponent;
+
+  /**
+   * Token usage of function selector agent.
+   */
+  select: IAgenticaTokenUsageJson.IComponent;
+
+  /**
+   * Token usage of function canceler agent.
+   */
+  cancel: IAgenticaTokenUsageJson.IComponent;
+
+  /**
+   * Token usage of function caller agent.
+   */
+  call: IAgenticaTokenUsageJson.IComponent;
+
+  /**
+   * Token usage of function calling describer agent.
+   */
+  describe: IAgenticaTokenUsageJson.IComponent;
+}
+export namespace IAgenticaTokenUsageJson {
+  export interface IComponent {
+    /**
+     * Total token usage.
+     */
+    total: number;
+
+    /**
+     * Input token usage of detailed.
+     */
+    input: IInput;
+
+    /**
+     * Output token usage of detailed.
+     */
+    output: IOutput;
+  }
+
+  /**
+   * Input token usage of detailed.
+   */
+  export interface IInput {
+    /**
+     * Total amount of input token uasge.
+     */
+    total: number;
+
+    /**
+     * Cached token usage.
+     */
+    cached: number;
+  }
+
+  /**
+   * Output token usage of detailed.
+   */
+  export interface IOutput {
+    /**
+     * Total amount of output token usage.
+     */
+    total: number;
+
+    /**
+     * Reasoning token usage.
+     */
+    reasoning: number;
+
+    /**
+     * Prediction token usage.
+     */
+    accepted_prediction: number;
+
+    /**
+     * Rejected prediction token usage.
+     */
+    rejected_prediction: number;
+  }
+}

package/src/prompts/AgenticaCancelPrompt.ts

@@ -1,32 +1,32 @@
-import { ILlmSchema } from "@samchon/openapi";
-
-import { AgenticaOperationSelection } from "../context/AgenticaOperationSelection";
-import { IAgenticaPromptJson } from "../json/IAgenticaPromptJson";
-import { AgenticaPromptBase } from "./AgenticaPromptBase";
-
-export class AgenticaCancelPrompt<
-  Model extends ILlmSchema.Model,
-> extends AgenticaPromptBase<"cancel", IAgenticaPromptJson.ICancel> {
-  public readonly id: string;
-  public readonly selections: AgenticaOperationSelection<Model>[];
-
-  public constructor(props: AgenticaCancelPrompt.IProps<Model>) {
-    super("cancel");
-    this.id = props.id;
-    this.selections = props.selections;
-  }
-
-  public toJSON(): IAgenticaPromptJson.ICancel {
-    return {
-      type: this.type,
-      id: this.id,
-      selections: this.selections.map((s) => s.toJSON()),
-    };
-  }
-}
-export namespace AgenticaCancelPrompt {
-  export interface IProps<Model extends ILlmSchema.Model> {
-    id: string;
-    selections: AgenticaOperationSelection<Model>[];
-  }
-}
+import { ILlmSchema } from "@samchon/openapi";
+
+import { AgenticaOperationSelection } from "../context/AgenticaOperationSelection";
+import { IAgenticaPromptJson } from "../json/IAgenticaPromptJson";
+import { AgenticaPromptBase } from "./AgenticaPromptBase";
+
+export class AgenticaCancelPrompt<
+  Model extends ILlmSchema.Model,
+> extends AgenticaPromptBase<"cancel", IAgenticaPromptJson.ICancel> {
+  public readonly id: string;
+  public readonly selections: AgenticaOperationSelection<Model>[];
+
+  public constructor(props: AgenticaCancelPrompt.IProps<Model>) {
+    super("cancel");
+    this.id = props.id;
+    this.selections = props.selections;
+  }
+
+  public toJSON(): IAgenticaPromptJson.ICancel {
+    return {
+      type: this.type,
+      id: this.id,
+      selections: this.selections.map((s) => s.toJSON()),
+    };
+  }
+}
+export namespace AgenticaCancelPrompt {
+  export interface IProps<Model extends ILlmSchema.Model> {
+    id: string;
+    selections: AgenticaOperationSelection<Model>[];
+  }
+}

package/src/prompts/AgenticaDescribePrompt.ts

@@ -1,41 +1,41 @@
-import { ILlmSchema } from "@samchon/openapi";
-
-import { IAgenticaPromptJson } from "../json/IAgenticaPromptJson";
-import { AgenticaExecutePrompt } from "./AgenticaExecutePrompt";
-import { AgenticaPromptBase } from "./AgenticaPromptBase";
-
-export class AgenticaDescribePrompt<
-  Model extends ILlmSchema.Model,
-> extends AgenticaPromptBase<"describe", IAgenticaPromptJson.IDescribe> {
-  /**
-   * Executions of the LLM function calling.
-   *
-   * This prompt describes the return value of them.
-   */
-  public readonly executes: AgenticaExecutePrompt<Model>[];
-
-  /**
-   * Description text.
-   */
-  public readonly text: string;
-
-  public constructor(props: AgenticaDescribePrompt.IProps<Model>) {
-    super("describe");
-    this.executes = props.executes;
-    this.text = props.text;
-  }
-
-  public toJSON(): IAgenticaPromptJson.IDescribe {
-    return {
-      type: this.type,
-      executes: this.executes.map((e) => e.toJSON()),
-      text: this.text,
-    };
-  }
-}
-export namespace AgenticaDescribePrompt {
-  export interface IProps<Model extends ILlmSchema.Model> {
-    executes: AgenticaExecutePrompt<Model>[];
-    text: string;
-  }
-}
+import { ILlmSchema } from "@samchon/openapi";
+
+import { IAgenticaPromptJson } from "../json/IAgenticaPromptJson";
+import { AgenticaExecutePrompt } from "./AgenticaExecutePrompt";
+import { AgenticaPromptBase } from "./AgenticaPromptBase";
+
+export class AgenticaDescribePrompt<
+  Model extends ILlmSchema.Model,
+> extends AgenticaPromptBase<"describe", IAgenticaPromptJson.IDescribe> {
+  /**
+   * Executions of the LLM function calling.
+   *
+   * This prompt describes the return value of them.
+   */
+  public readonly executes: AgenticaExecutePrompt<Model>[];
+
+  /**
+   * Description text.
+   */
+  public readonly text: string;
+
+  public constructor(props: AgenticaDescribePrompt.IProps<Model>) {
+    super("describe");
+    this.executes = props.executes;
+    this.text = props.text;
+  }
+
+  public toJSON(): IAgenticaPromptJson.IDescribe {
+    return {
+      type: this.type,
+      executes: this.executes.map((e) => e.toJSON()),
+      text: this.text,
+    };
+  }
+}
+export namespace AgenticaDescribePrompt {
+  export interface IProps<Model extends ILlmSchema.Model> {
+    executes: AgenticaExecutePrompt<Model>[];
+    text: string;
+  }
+}