@agentica/core 0.12.2-dev.20250314 → 0.12.4

package/src/structures/IAgenticaProps.ts

@@ -1,69 +1,69 @@
-import { ILlmSchema } from "@samchon/openapi";
-
-import { IAgenticaPromptJson } from "../json/IAgenticaPromptJson";
-import { IAgenticaConfig } from "./IAgenticaConfig";
-import { IAgenticaController } from "./IAgenticaController";
-import { IAgenticaVendor } from "./IAgenticaVendor";
-
-/**
- * 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 vendor} 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<Model extends ILlmSchema.Model> {
-  /**
-   * LLM schema model.
-   */
-  model: Model;
-
-  /**
-   * LLM service vendor.
-   */
-  vendor: IAgenticaVendor;
-
-  /**
-   * Controllers serving functions to call.
-   */
-  controllers: IAgenticaController<Model>[];
-
-  /**
-   * 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/wrtnlabs/agentica/tree/main/packages/core/prompts
-   */
-  config?: IAgenticaConfig<Model>;
-
-  /**
-   * Prompt histories.
-   *
-   * If you're starting the conversation from an existing session,
-   * assign the previouis prompt histories to this property.
-   */
-  histories?: IAgenticaPromptJson[];
-}
+import { ILlmSchema } from "@samchon/openapi";
+
+import { IAgenticaPromptJson } from "../json/IAgenticaPromptJson";
+import { IAgenticaConfig } from "./IAgenticaConfig";
+import { IAgenticaController } from "./IAgenticaController";
+import { IAgenticaVendor } from "./IAgenticaVendor";
+
+/**
+ * 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 vendor} 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<Model extends ILlmSchema.Model> {
+  /**
+   * LLM schema model.
+   */
+  model: Model;
+
+  /**
+   * LLM service vendor.
+   */
+  vendor: IAgenticaVendor;
+
+  /**
+   * Controllers serving functions to call.
+   */
+  controllers: IAgenticaController<Model>[];
+
+  /**
+   * 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/wrtnlabs/agentica/tree/main/packages/core/prompts
+   */
+  config?: IAgenticaConfig<Model>;
+
+  /**
+   * Prompt histories.
+   *
+   * If you're starting the conversation from an existing session,
+   * assign the previouis prompt histories to this property.
+   */
+  histories?: IAgenticaPromptJson[];
+}

package/src/structures/IAgenticaSystemPrompt.ts

@@ -1,125 +1,125 @@
-import { ILlmSchema } from "@samchon/openapi";
-
-import { AgenticaExecutePrompt } from "../prompts/AgenticaExecutePrompt";
-import { AgenticaPrompt } from "../prompts/AgenticaPrompt";
-import { IAgenticaConfig } from "./IAgenticaConfig";
-
-/**
- * System prompt collection of the A.I. chatbot.
- *
- * `IAgenticaSystemPrompt` is a type represents a collection of system
- * prompts that would be used by the A.I. chatbot of {@link Agentica}.
- *
- * You can customize the system prompt by configuring the
- * {@link IAgenticaConfig.systemPrompt} property when creating a new
- * {@link Agentica} instance.
- *
- * If you don't configure any system prompts, the default system prompts
- * would be used which are written in the below directory as markdown
- * documents.
- *
- * - https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts
- *
- * @author Samchon
- */
-export interface IAgenticaSystemPrompt<Model extends ILlmSchema.Model> {
-  /**
-   * Common system prompt that would be used in every situation.
-   *
-   * @param config Configuration of the agent
-   * @returns The common system prompt
-   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/common.md
-   */
-  common?: (config?: IAgenticaConfig<Model> | undefined) => string;
-
-  /**
-   * Initialize system prompt.
-   *
-   * When the A.I. chatbot has not informed any functions to the agent
-   * yet because the user has not implied any function calling request yet,
-   * {@link Agentica} says that it is a circumstance that nothing has
-   * been initialized yet.
-   *
-   * In that case, the `initialize` system prompt would be used. You can
-   * customize the `initialize` system prompt by assigning this function
-   * with the given {@link AgenticaPrompt histories} parameter.
-   *
-   * @param histories Histories of the previous prompts
-   * @returns initialize system prompt
-   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/initialize.md
-   */
-  initialize?: (histories: AgenticaPrompt<Model>[]) => string;
-
-  /**
-   * Select system prompt.
-   *
-   * The {@link Agentica} has a process selecting some candidate
-   * functions to call by asking to the A.I. agent with the previous
-   * prompt histories.
-   *
-   * In that case, this `select` system prompt would be used. You can
-   * customize it by assigning this function with the given
-   * {@link AgenticaPrompt histories} parameter.
-   *
-   * Note that, the `"select"` means only the function selection. It does
-   * not contain the filling argument or executing the function. It
-   * literally contains only the selection process.
-   *
-   * @param histories Histories of the previous prompts
-   * @returns select system promopt
-   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/select.md
-   */
-  select?: (histories: AgenticaPrompt<Model>[]) => string;
-
-  /**
-   * Cancel system prompt.
-   *
-   * The {@link Agentica} has a process canceling some candidate
-   * functions to call by asking to the A.I. agent with the previous
-   * prompt histories.
-   *
-   * In that case, this `cancel` system prompt would be used. You can
-   * customize it by assigning this function with the given
-   * {@link AgenticaPrompt histories} parameter.
-   *
-   * @param histories Histories of the previous prompts
-   * @returns cancel system prompt
-   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/cancel.md
-   */
-  cancel?: (histories: AgenticaPrompt<Model>[]) => string;
-
-  /**
-   * Execute system prompt.
-   *
-   * The {@link Agentica} has a process filling the arguments of some
-   * selected candidate functions by the LLM (Large Language Model)
-   * function calling feature with the previous prompt histories, and
-   * executing the arguments filled function with validation feedback.
-   *
-   * In that case, this `execute` system prompt would be used. You can
-   * customize it by assigning this function with the given
-   * {@link AgenticaPrompt histories} parameter.
-   *
-   * @param histories Histories of the previous prompts
-   * @returns execute system prompt
-   * https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/execute.md
-   */
-  execute?: (histories: AgenticaPrompt<Model>[]) => string;
-
-  /**
-   * Describe system prompt.
-   *
-   * The {@link Agentica} has a process describing the return values of
-   * the executed functions by requesting to the A.I. agent with the
-   * previous prompt histories.
-   *
-   * In that case, this `describe` system prompt would be used. You can
-   * customize it by assigning this function with the given
-   * {@link AgenticaPrompt histories} parameter.
-   *
-   * @param histories Histories of the previous prompts
-   * @returns describe system prompt
-   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/describe.md
-   */
-  describe?: (histories: AgenticaExecutePrompt<Model>[]) => string;
-}
+import { ILlmSchema } from "@samchon/openapi";
+
+import { AgenticaExecutePrompt } from "../prompts/AgenticaExecutePrompt";
+import { AgenticaPrompt } from "../prompts/AgenticaPrompt";
+import { IAgenticaConfig } from "./IAgenticaConfig";
+
+/**
+ * System prompt collection of the A.I. chatbot.
+ *
+ * `IAgenticaSystemPrompt` is a type represents a collection of system
+ * prompts that would be used by the A.I. chatbot of {@link Agentica}.
+ *
+ * You can customize the system prompt by configuring the
+ * {@link IAgenticaConfig.systemPrompt} property when creating a new
+ * {@link Agentica} instance.
+ *
+ * If you don't configure any system prompts, the default system prompts
+ * would be used which are written in the below directory as markdown
+ * documents.
+ *
+ * - https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts
+ *
+ * @author Samchon
+ */
+export interface IAgenticaSystemPrompt<Model extends ILlmSchema.Model> {
+  /**
+   * Common system prompt that would be used in every situation.
+   *
+   * @param config Configuration of the agent
+   * @returns The common system prompt
+   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/common.md
+   */
+  common?: (config?: IAgenticaConfig<Model> | undefined) => string;
+
+  /**
+   * Initialize system prompt.
+   *
+   * When the A.I. chatbot has not informed any functions to the agent
+   * yet because the user has not implied any function calling request yet,
+   * {@link Agentica} says that it is a circumstance that nothing has
+   * been initialized yet.
+   *
+   * In that case, the `initialize` system prompt would be used. You can
+   * customize the `initialize` system prompt by assigning this function
+   * with the given {@link AgenticaPrompt histories} parameter.
+   *
+   * @param histories Histories of the previous prompts
+   * @returns initialize system prompt
+   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/initialize.md
+   */
+  initialize?: (histories: AgenticaPrompt<Model>[]) => string;
+
+  /**
+   * Select system prompt.
+   *
+   * The {@link Agentica} has a process selecting some candidate
+   * functions to call by asking to the A.I. agent with the previous
+   * prompt histories.
+   *
+   * In that case, this `select` system prompt would be used. You can
+   * customize it by assigning this function with the given
+   * {@link AgenticaPrompt histories} parameter.
+   *
+   * Note that, the `"select"` means only the function selection. It does
+   * not contain the filling argument or executing the function. It
+   * literally contains only the selection process.
+   *
+   * @param histories Histories of the previous prompts
+   * @returns select system promopt
+   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/select.md
+   */
+  select?: (histories: AgenticaPrompt<Model>[]) => string;
+
+  /**
+   * Cancel system prompt.
+   *
+   * The {@link Agentica} has a process canceling some candidate
+   * functions to call by asking to the A.I. agent with the previous
+   * prompt histories.
+   *
+   * In that case, this `cancel` system prompt would be used. You can
+   * customize it by assigning this function with the given
+   * {@link AgenticaPrompt histories} parameter.
+   *
+   * @param histories Histories of the previous prompts
+   * @returns cancel system prompt
+   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/cancel.md
+   */
+  cancel?: (histories: AgenticaPrompt<Model>[]) => string;
+
+  /**
+   * Execute system prompt.
+   *
+   * The {@link Agentica} has a process filling the arguments of some
+   * selected candidate functions by the LLM (Large Language Model)
+   * function calling feature with the previous prompt histories, and
+   * executing the arguments filled function with validation feedback.
+   *
+   * In that case, this `execute` system prompt would be used. You can
+   * customize it by assigning this function with the given
+   * {@link AgenticaPrompt histories} parameter.
+   *
+   * @param histories Histories of the previous prompts
+   * @returns execute system prompt
+   * https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/execute.md
+   */
+  execute?: (histories: AgenticaPrompt<Model>[]) => string;
+
+  /**
+   * Describe system prompt.
+   *
+   * The {@link Agentica} has a process describing the return values of
+   * the executed functions by requesting to the A.I. agent with the
+   * previous prompt histories.
+   *
+   * In that case, this `describe` system prompt would be used. You can
+   * customize it by assigning this function with the given
+   * {@link AgenticaPrompt histories} parameter.
+   *
+   * @param histories Histories of the previous prompts
+   * @returns describe system prompt
+   * @default https://github.com/wrtnlabs/agentica/tree/main/packages/core/prompts/describe.md
+   */
+  describe?: (histories: AgenticaExecutePrompt<Model>[]) => string;
+}

package/src/structures/IAgenticaVendor.ts

@@ -1,39 +1,39 @@
-import OpenAI from "openai";
-
-/**
- * LLM service vendor for Nestia Chat.
- *
- * `IAgenticaVendor` is a type represents an LLM
- * (Large Language Model) vendor of the {@link Agentica}.
- *
- * Currently, {@link Agentica} supports OpenAI SDK. However, it does
- * not mean that you can use only OpenAI's GPT model in the
- * {@link Agentica}. The OpenAI SDK is just a connection tool to the
- * LLM vendor's API, and you can use other LLM vendors by configuring
- * its `baseURL` and API key.
- *
- * Therefore, if you want to use another LLM vendor like Claude or
- * Gemini, please configure the `baseURL` to the {@link api}, and
- * set {@link IAgenticaController}'s schema model as "cluade" or
- * "gemini".
- *
- * @author Samchon
- */
-export interface IAgenticaVendor {
-  /**
-   * OpenAI API instance.
-   */
-  api: OpenAI;
-
-  /**
-   * Chat model to be used.
-   *
-   * `({}) & string` means to support third party hosting cloud(eg. openRouter, aws)
-   */
-  model: OpenAI.ChatModel | ({} & string);
-
-  /**
-   * Options for the request.
-   */
-  options?: OpenAI.RequestOptions | undefined;
-}
+import OpenAI from "openai";
+
+/**
+ * LLM service vendor for Nestia Chat.
+ *
+ * `IAgenticaVendor` is a type represents an LLM
+ * (Large Language Model) vendor of the {@link Agentica}.
+ *
+ * Currently, {@link Agentica} supports OpenAI SDK. However, it does
+ * not mean that you can use only OpenAI's GPT model in the
+ * {@link Agentica}. The OpenAI SDK is just a connection tool to the
+ * LLM vendor's API, and you can use other LLM vendors by configuring
+ * its `baseURL` and API key.
+ *
+ * Therefore, if you want to use another LLM vendor like Claude or
+ * Gemini, please configure the `baseURL` to the {@link api}, and
+ * set {@link IAgenticaController}'s schema model as "cluade" or
+ * "gemini".
+ *
+ * @author Samchon
+ */
+export interface IAgenticaVendor {
+  /**
+   * OpenAI API instance.
+   */
+  api: OpenAI;
+
+  /**
+   * Chat model to be used.
+   *
+   * `({}) & string` means to support third party hosting cloud(eg. openRouter, aws)
+   */
+  model: OpenAI.ChatModel | ({} & string);
+
+  /**
+   * Options for the request.
+   */
+  options?: OpenAI.RequestOptions | undefined;
+}