@agentica/core 0.10.3 → 0.11.0

package/src/internal/AgenticaTokenUsageAggregator.ts

@@ -1,115 +0,0 @@
-import OpenAI from "openai";
-
-import { IAgenticaTokenUsage } from "../structures/IAgenticaTokenUsage";
-
-export namespace AgenticaTokenUsageAggregator {
-  export const aggregate = (props: {
-    kind: Exclude<keyof IAgenticaTokenUsage, "aggregate">;
-    completion: OpenAI.ChatCompletion;
-    usage: IAgenticaTokenUsage;
-  }): void => {
-    if (!props.completion.usage) return;
-
-    //----
-    // COMPONENT
-    //----
-    const component: IAgenticaTokenUsage.IComponent = props.usage[props.kind];
-
-    // TOTAL
-    component.total += props.completion.usage.total_tokens;
-
-    // PROMPT
-    component.input.total += props.completion.usage.prompt_tokens;
-    props.completion.usage.prompt_tokens_details?.audio_tokens ?? 0;
-    component.input.cached +=
-      props.completion.usage.prompt_tokens_details?.cached_tokens ?? 0;
-
-    // COMPLETION
-    component.output.total += props.completion.usage.total_tokens;
-    component.output.accepted_prediction +=
-      props.completion.usage.completion_tokens_details
-        ?.accepted_prediction_tokens ?? 0;
-    component.output.reasoning +=
-      props.completion.usage.completion_tokens_details?.reasoning_tokens ?? 0;
-    component.output.rejected_prediction +=
-      props.completion.usage.completion_tokens_details
-        ?.rejected_prediction_tokens ?? 0;
-
-    //----
-    // RE-AGGREGATE
-    //----
-    const sum = (getter: (comp: IAgenticaTokenUsage.IComponent) => number) =>
-      Object.entries(props.usage)
-        .filter(([key]) => key !== "aggregate")
-        .map(([_, comp]) => getter(comp))
-        .reduce((a, b) => a + b, 0);
-    const aggregate: IAgenticaTokenUsage.IComponent = props.usage.aggregate;
-    aggregate.total = sum((comp) => comp.total);
-    aggregate.input.total = sum((comp) => comp.input.total);
-    aggregate.input.cached = sum((comp) => comp.input.cached);
-    aggregate.output.total = sum((comp) => comp.output.total);
-    aggregate.output.reasoning = sum((comp) => comp.output.reasoning);
-    aggregate.output.accepted_prediction = sum(
-      (comp) => comp.output.accepted_prediction,
-    );
-    aggregate.output.rejected_prediction = sum(
-      (comp) => comp.output.rejected_prediction,
-    );
-  };
-
-  export const plus = (
-    x: IAgenticaTokenUsage,
-    y: IAgenticaTokenUsage,
-  ): IAgenticaTokenUsage => {
-    const component = (
-      a: IAgenticaTokenUsage.IComponent,
-      b: IAgenticaTokenUsage.IComponent,
-    ): IAgenticaTokenUsage.IComponent => ({
-      total: a.total + b.total,
-      input: {
-        total: a.input.total + b.input.total,
-        cached: a.input.cached + b.input.cached,
-      },
-      output: {
-        total: a.output.total + b.output.total,
-        reasoning: a.output.reasoning + b.output.reasoning,
-        accepted_prediction:
-          a.output.accepted_prediction + b.output.accepted_prediction,
-        rejected_prediction:
-          a.output.rejected_prediction + b.output.rejected_prediction,
-      },
-    });
-    return {
-      aggregate: component(x.aggregate, y.aggregate),
-      initialize: component(x.initialize, y.initialize),
-      select: component(x.select, y.select),
-      cancel: component(x.cancel, y.cancel),
-      call: component(x.call, y.call),
-      describe: component(x.describe, y.describe),
-    };
-  };
-
-  export const zero = (): IAgenticaTokenUsage => {
-    const component = (): IAgenticaTokenUsage.IComponent => ({
-      total: 0,
-      input: {
-        total: 0,
-        cached: 0,
-      },
-      output: {
-        total: 0,
-        reasoning: 0,
-        accepted_prediction: 0,
-        rejected_prediction: 0,
-      },
-    });
-    return {
-      aggregate: component(),
-      initialize: component(),
-      select: component(),
-      cancel: component(),
-      call: component(),
-      describe: component(),
-    };
-  };
-}

package/src/structures/IAgenticaEvent.ts

@@ -1,229 +0,0 @@
-import { ILlmSchema } from "@samchon/openapi";
-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<Model extends ILlmSchema.Model> =
-  | IAgenticaEvent.IInitialize
-  | IAgenticaEvent.ISelect<Model>
-  | IAgenticaEvent.ICancel<Model>
-  | IAgenticaEvent.ICall<Model>
-  | IAgenticaEvent.IExecute<Model>
-  | IAgenticaEvent.IDescribe<Model>
-  | IAgenticaEvent.IText
-  | IAgenticaEvent.IRequest
-  | IAgenticaEvent.IResponse;
-export namespace IAgenticaEvent {
-  export type Type = IAgenticaEvent<any>["type"];
-  export type Mapper<Model extends ILlmSchema.Model> = {
-    initialize: IInitialize;
-    select: ISelect<Model>;
-    cancel: ICancel<Model>;
-    call: ICall<Model>;
-    execute: IExecute<Model>;
-    describe: IDescribe<Model>;
-    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<Model extends ILlmSchema.Model>
-    extends IBase<"select"> {
-    /**
-     * Selected operation.
-     *
-     * Operation that has been selected to prepare LLM function calling.
-     */
-    operation: IAgenticaOperation<Model>;
-
-    /**
-     * 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<Model extends ILlmSchema.Model>
-    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<Model>;
-
-    /**
-     * 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<Model extends ILlmSchema.Model> extends IBase<"call"> {
-    /**
-     * ID of the tool calling.
-     */
-    id: string;
-
-    /**
-     * Target operation to call.
-     */
-    operation: IAgenticaOperation<Model>;
-
-    /**
-     * 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<Model extends ILlmSchema.Model>
-    extends IBase<"execute"> {
-    /**
-     * ID of the tool calling.
-     */
-    id: string;
-
-    /**
-     * Target operation had called.
-     */
-    operation: IAgenticaOperation<Model>;
-
-    /**
-     * 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<Model extends ILlmSchema.Model>
-    extends IBase<"describe"> {
-    /**
-     * Executions of the LLM function calling.
-     *
-     * This prompt describes the return value of them.
-     */
-    executions: IAgenticaPrompt.IExecute<Model>[];
-
-    /**
-     * 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 vendor 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 vendor 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 vendor API.
-     */
-    value: OpenAI.ChatCompletion;
-  }
-
-  interface IBase<Type extends string> {
-    /**
-     * Discriminator type.
-     */
-    type: Type;
-  }
-}

package/src/structures/IAgenticaOperationSelection.ts

@@ -1,68 +0,0 @@
-import { IHttpLlmFunction, ILlmFunction, ILlmSchema } from "@samchon/openapi";
-
-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<Model extends ILlmSchema.Model> =
-  | IAgenticaOperationSelection.IHttp<Model>
-  | IAgenticaOperationSelection.IClass<Model>;
-export namespace IAgenticaOperationSelection {
-  export type IHttp<Model extends ILlmSchema.Model> = IBase<
-    "http",
-    IAgenticaController.IHttp<Model>,
-    IHttpLlmFunction<Model>
-  >;
-
-  export type IClass<Model extends ILlmSchema.Model> = IBase<
-    "class",
-    IAgenticaController.IClass<Model>,
-    ILlmFunction<Model>
-  >;
-
-  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,182 +0,0 @@
-import {
-  IHttpLlmFunction,
-  IHttpResponse,
-  ILlmFunction,
-  ILlmSchema,
-} from "@samchon/openapi";
-
-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<Model extends ILlmSchema.Model> =
-  | IAgenticaPrompt.IText
-  | IAgenticaPrompt.ISelect<Model>
-  | IAgenticaPrompt.ICancel<Model>
-  | IAgenticaPrompt.IExecute<Model>
-  | IAgenticaPrompt.IDescribe<Model>;
-export namespace IAgenticaPrompt {
-  /**
-   * Select prompt.
-   *
-   * Selection prompt about candidate functions to call.
-   */
-  export interface ISelect<Model extends ILlmSchema.Model>
-    extends IBase<"select"> {
-    /**
-     * ID of the LLM tool call result.
-     */
-    id: string;
-
-    /**
-     * Operations that have been selected.
-     */
-    operations: IAgenticaOperationSelection<Model>[];
-  }
-
-  /**
-   * Cancel prompt.
-   *
-   * Cancellation prompt about the candidate functions to be discarded.
-   */
-  export interface ICancel<Model extends ILlmSchema.Model>
-    extends IBase<"cancel"> {
-    /**
-     * ID of the LLM tool call result.
-     */
-    id: string;
-
-    /**
-     * Operations that have been cancelled.
-     */
-    operations: IAgenticaOperationSelection<Model>[];
-  }
-
-  /**
-   * Execute prompt.
-   *
-   * Execution prompt about the LLM function calling.
-   */
-  export type IExecute<Model extends ILlmSchema.Model> =
-    | IExecute.IHttp<Model>
-    | IExecute.IClass<Model>;
-  export namespace IExecute {
-    export type IHttp<Model extends ILlmSchema.Model> = IBase<
-      "http",
-      IAgenticaController.IHttp<Model>,
-      IHttpLlmFunction<Model>,
-      IHttpResponse
-    >;
-    export type IClass<Model extends ILlmSchema.Model> = IBase<
-      "class",
-      IAgenticaController.IClass<Model>,
-      ILlmFunction<Model>,
-      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<Model extends ILlmSchema.Model>
-    extends IBase<"describe"> {
-    /**
-     * Executions of the LLM function calling.
-     *
-     * This prompt describes the return value of them.
-     */
-    executions: IExecute<Model>[];
-
-    /**
-     * 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;
-  }
-}