@agentica/core 0.8.2 → 0.8.3-dev.20250227

package/src/structures/IAgenticaEvent.ts

@@ -1,224 +1,224 @@
-import OpenAI from "openai";
-
-import { AgenticaSource } from "../typings/AgenticaSource";
-import { IAgenticaOperation } from "./IAgenticaOperation";
-import { IAgenticaPrompt } from "./IAgenticaPrompt";
-
-/**
- * Nestia A.I. chatbot event.
- *
- * `IAgenticaEvent` is an union type of all possible events that can
- * be emitted by the A.I. chatbot of the {@link Agentica} class. You
- * can discriminate the subtype by checking the {@link type} property.
- *
- * @author Samchon
- */
-export type IAgenticaEvent =
-  | IAgenticaEvent.IInitialize
-  | IAgenticaEvent.ISelect
-  | IAgenticaEvent.ICancel
-  | IAgenticaEvent.ICall
-  | IAgenticaEvent.IExecute
-  | IAgenticaEvent.IDescribe
-  | IAgenticaEvent.IText
-  | IAgenticaEvent.IRequest
-  | IAgenticaEvent.IResponse;
-export namespace IAgenticaEvent {
-  export type Type = IAgenticaEvent["type"];
-  export type Mapper = {
-    initialize: IInitialize;
-    select: ISelect;
-    cancel: ICancel;
-    call: ICall;
-    execute: IExecute;
-    describe: IDescribe;
-    text: IText;
-    request: IRequest;
-    response: IResponse;
-  };
-
-  /**
-   * Event of initializing the chatbot.
-   */
-  export interface IInitialize extends IBase<"initialize"> {}
-
-  /**
-   * Event of selecting a function to call.
-   */
-  export interface ISelect extends IBase<"select"> {
-    /**
-     * Selected operation.
-     *
-     * Operation that has been selected to prepare LLM function calling.
-     */
-    operation: IAgenticaOperation;
-
-    /**
-     * Reason of selecting the function.
-     *
-     * The A.I. chatbot will fill this property describing why the function
-     * has been selected.
-     */
-    reason: string;
-  }
-
-  /**
-   * Event of canceling a function calling.
-   */
-  export interface ICancel extends IBase<"cancel"> {
-    /**
-     * Selected operation to cancel.
-     *
-     * Operation that has been selected to prepare LLM function calling,
-     * but canceled due to no more required.
-     */
-    operation: IAgenticaOperation;
-
-    /**
-     * Reason of selecting the function.
-     *
-     * The A.I. chatbot will fill this property describing why the function
-     * has been cancelled.
-     *
-     * For reference, if the A.I. chatbot successfully completes the LLM
-     * function calling, the reason of the function cancellation will be
-     * "complete".
-     */
-    reason: string;
-  }
-
-  /**
-   * Event of calling a function.
-   */
-  export interface ICall extends IBase<"call"> {
-    /**
-     * ID of the tool calling.
-     */
-    id: string;
-
-    /**
-     * Target operation to call.
-     */
-    operation: IAgenticaOperation;
-
-    /**
-     * Arguments of the function calling.
-     *
-     * If you modify this {@link arguments} property, it actually modifies
-     * the backend server's request. Therefore, be careful when you're
-     * trying to modify this property.
-     */
-    arguments: object;
-  }
-
-  /**
-   * Event of function calling execution.
-   */
-  export interface IExecute extends IBase<"execute"> {
-    /**
-     * ID of the tool calling.
-     */
-    id: string;
-
-    /**
-     * Target operation had called.
-     */
-    operation: IAgenticaOperation;
-
-    /**
-     * Arguments of the function calling.
-     */
-    arguments: object;
-
-    /**
-     * Return value.
-     */
-    value: any;
-  }
-
-  /**
-   * Event of description.
-   *
-   * Event describing return values of LLM function callings.
-   */
-  export interface IDescribe extends IBase<"describe"> {
-    /**
-     * Executions of the LLM function calling.
-     *
-     * This prompt describes the return value of them.
-     */
-    executions: IAgenticaPrompt.IExecute[];
-
-    /**
-     * Description text.
-     */
-    text: string;
-  }
-
-  /**
-   * Event of text message.
-   */
-  export interface IText extends IBase<"text"> {
-    /**
-     * Role of the orator.
-     */
-    role: "assistant" | "user";
-
-    /**
-     * The text content.
-     */
-    text: string;
-  }
-
-  /**
-   * Request event of LLM provider API.
-   */
-  export interface IRequest extends IBase<"request"> {
-    /**
-     * The source agent of the request.
-     */
-    source: AgenticaSource;
-
-    /**
-     * Request body.
-     */
-    body: OpenAI.ChatCompletionCreateParamsNonStreaming;
-
-    /**
-     * Options for the request.
-     */
-    options?: OpenAI.RequestOptions | undefined;
-  }
-
-  /**
-   * Response event of LLM provider API.
-   */
-  export interface IResponse extends IBase<"response"> {
-    /**
-     * The source agent of the response.
-     */
-    source: AgenticaSource;
-
-    /**
-     * Request body.
-     */
-    body: OpenAI.ChatCompletionCreateParamsNonStreaming;
-
-    /**
-     * Options for the request.
-     */
-    options?: OpenAI.RequestOptions | undefined;
-
-    /**
-     * Return value from the LLM provider API.
-     */
-    value: OpenAI.ChatCompletion;
-  }
-
-  interface IBase<Type extends string> {
-    /**
-     * Discriminator type.
-     */
-    type: Type;
-  }
-}
+import OpenAI from "openai";
+
+import { AgenticaSource } from "../typings/AgenticaSource";
+import { IAgenticaOperation } from "./IAgenticaOperation";
+import { IAgenticaPrompt } from "./IAgenticaPrompt";
+
+/**
+ * Nestia A.I. chatbot event.
+ *
+ * `IAgenticaEvent` is an union type of all possible events that can
+ * be emitted by the A.I. chatbot of the {@link Agentica} class. You
+ * can discriminate the subtype by checking the {@link type} property.
+ *
+ * @author Samchon
+ */
+export type IAgenticaEvent =
+  | IAgenticaEvent.IInitialize
+  | IAgenticaEvent.ISelect
+  | IAgenticaEvent.ICancel
+  | IAgenticaEvent.ICall
+  | IAgenticaEvent.IExecute
+  | IAgenticaEvent.IDescribe
+  | IAgenticaEvent.IText
+  | IAgenticaEvent.IRequest
+  | IAgenticaEvent.IResponse;
+export namespace IAgenticaEvent {
+  export type Type = IAgenticaEvent["type"];
+  export type Mapper = {
+    initialize: IInitialize;
+    select: ISelect;
+    cancel: ICancel;
+    call: ICall;
+    execute: IExecute;
+    describe: IDescribe;
+    text: IText;
+    request: IRequest;
+    response: IResponse;
+  };
+
+  /**
+   * Event of initializing the chatbot.
+   */
+  export interface IInitialize extends IBase<"initialize"> {}
+
+  /**
+   * Event of selecting a function to call.
+   */
+  export interface ISelect extends IBase<"select"> {
+    /**
+     * Selected operation.
+     *
+     * Operation that has been selected to prepare LLM function calling.
+     */
+    operation: IAgenticaOperation;
+
+    /**
+     * Reason of selecting the function.
+     *
+     * The A.I. chatbot will fill this property describing why the function
+     * has been selected.
+     */
+    reason: string;
+  }
+
+  /**
+   * Event of canceling a function calling.
+   */
+  export interface ICancel extends IBase<"cancel"> {
+    /**
+     * Selected operation to cancel.
+     *
+     * Operation that has been selected to prepare LLM function calling,
+     * but canceled due to no more required.
+     */
+    operation: IAgenticaOperation;
+
+    /**
+     * Reason of selecting the function.
+     *
+     * The A.I. chatbot will fill this property describing why the function
+     * has been cancelled.
+     *
+     * For reference, if the A.I. chatbot successfully completes the LLM
+     * function calling, the reason of the function cancellation will be
+     * "complete".
+     */
+    reason: string;
+  }
+
+  /**
+   * Event of calling a function.
+   */
+  export interface ICall extends IBase<"call"> {
+    /**
+     * ID of the tool calling.
+     */
+    id: string;
+
+    /**
+     * Target operation to call.
+     */
+    operation: IAgenticaOperation;
+
+    /**
+     * Arguments of the function calling.
+     *
+     * If you modify this {@link arguments} property, it actually modifies
+     * the backend server's request. Therefore, be careful when you're
+     * trying to modify this property.
+     */
+    arguments: object;
+  }
+
+  /**
+   * Event of function calling execution.
+   */
+  export interface IExecute extends IBase<"execute"> {
+    /**
+     * ID of the tool calling.
+     */
+    id: string;
+
+    /**
+     * Target operation had called.
+     */
+    operation: IAgenticaOperation;
+
+    /**
+     * Arguments of the function calling.
+     */
+    arguments: object;
+
+    /**
+     * Return value.
+     */
+    value: any;
+  }
+
+  /**
+   * Event of description.
+   *
+   * Event describing return values of LLM function callings.
+   */
+  export interface IDescribe extends IBase<"describe"> {
+    /**
+     * Executions of the LLM function calling.
+     *
+     * This prompt describes the return value of them.
+     */
+    executions: IAgenticaPrompt.IExecute[];
+
+    /**
+     * Description text.
+     */
+    text: string;
+  }
+
+  /**
+   * Event of text message.
+   */
+  export interface IText extends IBase<"text"> {
+    /**
+     * Role of the orator.
+     */
+    role: "assistant" | "user";
+
+    /**
+     * The text content.
+     */
+    text: string;
+  }
+
+  /**
+   * Request event of LLM provider API.
+   */
+  export interface IRequest extends IBase<"request"> {
+    /**
+     * The source agent of the request.
+     */
+    source: AgenticaSource;
+
+    /**
+     * Request body.
+     */
+    body: OpenAI.ChatCompletionCreateParamsNonStreaming;
+
+    /**
+     * Options for the request.
+     */
+    options?: OpenAI.RequestOptions | undefined;
+  }
+
+  /**
+   * Response event of LLM provider API.
+   */
+  export interface IResponse extends IBase<"response"> {
+    /**
+     * The source agent of the response.
+     */
+    source: AgenticaSource;
+
+    /**
+     * Request body.
+     */
+    body: OpenAI.ChatCompletionCreateParamsNonStreaming;
+
+    /**
+     * Options for the request.
+     */
+    options?: OpenAI.RequestOptions | undefined;
+
+    /**
+     * Return value from the LLM provider API.
+     */
+    value: OpenAI.ChatCompletion;
+  }
+
+  interface IBase<Type extends string> {
+    /**
+     * Discriminator type.
+     */
+    type: Type;
+  }
+}