@agentica/core 0.39.0 → 0.41.0

package/src/structures/IAgenticaConfig.ts

@@ -1,5 +1,6 @@
 import type { AgenticaContext } from "../context/AgenticaContext";
 
+import type { IAgenticaConfigBase } from "./IAgenticaConfigBase";
 import type { IAgenticaExecutor } from "./IAgenticaExecutor";
 import type { IAgenticaSystemPrompt } from "./IAgenticaSystemPrompt";
 
@@ -20,7 +21,7 @@ import type { IAgenticaSystemPrompt } from "./IAgenticaSystemPrompt";
  *
  * @author Samchon
  */
-export interface IAgenticaConfig {
+export interface IAgenticaConfig extends IAgenticaConfigBase {
   /**
    * Agent executor.
    *
@@ -47,45 +48,6 @@ export interface IAgenticaConfig {
    */
   systemPrompt?: IAgenticaSystemPrompt;
 
-  /**
-   * Locale of the A.I. chatbot.
-   *
-   * If you configure this property, the A.I. chatbot will conversate with
-   * the given locale. You can get the locale value by
-   *
-   * - Browser: `navigator.language`
-   * - NodeJS: `process.env.LANG.split(".")[0]`
-   *
-   * @default your_locale
-   */
-  locale?: string;
-
-  /**
-   * Timezone of the A.I. chatbot.
-   *
-   * If you configure this property, the A.I. chatbot will consider the
-   * given timezone. You can get the timezone value by
-   * `Intl.DateTimeFormat().resolvedOptions().timeZone`.
-   *
-   * @default your_timezone
-   */
-  timezone?: string;
-
-  /**
-   * Retry count.
-   *
-   * If LLM function calling composed arguments are invalid,
-   * the A.I. chatbot will retry to call the function with
-   * the modified arguments.
-   *
-   * By the way, if you configure it to 0 or 1, the A.I. chatbot
-   * will not retry the LLM function calling for correcting the
-   * arguments.
-   *
-   * @default 3
-   */
-  retry?: number;
-
   /**
    * Capacity of the LLM function selecting.
    *
@@ -118,22 +80,4 @@ export interface IAgenticaConfig {
    * @default true
    */
   eliticism?: boolean;
-
-  /**
-   * Backoff strategy.
-   *
-   * If OpenAI SDK fails to connect LLM API Server, this Backoff factor
-   * would be used to retry for the next connection.
-   *
-   * If the function returns `true`, the retry would be stopped.
-   * Otherwise, the retry would be continued.
-   *
-   * @default (props) => throw props.error
-   * @returns {number} The number of milliseconds to wait before the next retry
-   * @throws {Error} If the function want to stop the retry, you can throw an error
-   */
-  backoffStrategy?: (props: {
-    count: number;
-    error: unknown;
-  }) => number;
 }

package/src/structures/IAgenticaConfigBase.ts

@@ -0,0 +1,87 @@
+/**
+ * Configuration for Agentic Agent.
+ *
+ * `IAgenticaConfig` is an interface that defines the configuration
+ * properties of the {@link Agentica}. With this configuration, you
+ * can set the user's {@link locale}, {@link timezone}, and some of
+ * {@link systemPrompt system prompts}.
+ *
+ * Also, you can affect to the LLM function selecing/calling logic by
+ * configuring additional properties. For an example, if you configure the
+ * {@link capacity} property, the AI chatbot will divide the functions
+ * into the several groups with the configured capacity and select proper
+ * functions to call by operating the multiple LLM function selecting
+ * agents parallelly.
+ *
+ * @author sunrabbit123
+ */
+export interface IAgenticaConfigBase {
+
+  /**
+   * Locale of the A.I. chatbot.
+   *
+   * If you configure this property, the A.I. chatbot will conversate with
+   * the given locale. You can get the locale value by
+   *
+   * - Browser: `navigator.language`
+   * - NodeJS: `process.env.LANG.split(".")[0]`
+   *
+   * @default your_locale
+   */
+  locale?: string;
+
+  /**
+   * Timezone of the A.I. chatbot.
+   *
+   * If you configure this property, the A.I. chatbot will consider the
+   * given timezone. You can get the timezone value by
+   * `Intl.DateTimeFormat().resolvedOptions().timeZone`.
+   *
+   * @default your_timezone
+   */
+  timezone?: string;
+
+  /**
+   * Retry count.
+   *
+   * If LLM function calling composed arguments are invalid,
+   * the A.I. chatbot will retry to call the function with
+   * the modified arguments.
+   *
+   * By the way, if you configure it to 0 or 1, the A.I. chatbot
+   * will not retry the LLM function calling for correcting the
+   * arguments.
+   *
+   * @default 3
+   */
+  retry?: number;
+
+  /**
+   * Backoff strategy.
+   *
+   * If OpenAI SDK fails to connect LLM API Server, this Backoff factor
+   * would be used to retry for the next connection.
+   *
+   * If the function returns `true`, the retry would be stopped.
+   * Otherwise, the retry would be continued.
+   *
+   * @default (props) => throw props.error
+   * @returns {number} The number of milliseconds to wait before the next retry
+   * @throws {Error} If the function want to stop the retry, you can throw an error
+   */
+  backoffStrategy?: (props: {
+    count: number;
+    error: unknown;
+  }) => number;
+
+  /**
+   * Whether to enable streaming.
+   *
+   * If you set this property to `true`, the A.I. chatbot will enable streaming.
+   *
+   * If you set this property to `false`, the A.I. chatbot will not enable streaming.
+   *
+   * @default true
+   */
+  stream?: boolean;
+}

package/src/structures/IMicroAgenticaConfig.ts

@@ -1,3 +1,4 @@
+import type { IAgenticaConfigBase } from "./IAgenticaConfigBase";
 import type { IMicroAgenticaExecutor } from "./IMicroAgenticaExecutor";
 import type { IMicroAgenticaSystemPrompt } from "./IMicroAgenticaSystemPrompt";
 
@@ -11,7 +12,7 @@ import type { IMicroAgenticaSystemPrompt } from "./IMicroAgenticaSystemPrompt";
  *
  * @author Samchon
  */
-export interface IMicroAgenticaConfig {
+export interface IMicroAgenticaConfig extends IAgenticaConfigBase {
   /**
    * Agent executor.
    *
@@ -39,45 +40,6 @@ export interface IMicroAgenticaConfig {
    */
   systemPrompt?: IMicroAgenticaSystemPrompt;
 
-  /**
-   * Locale of the A.I. chatbot.
-   *
-   * If you configure this property, the A.I. chatbot will conversate with
-   * the given locale. You can get the locale value by
-   *
-   * - Browser: `navigator.language`
-   * - NodeJS: `process.env.LANG.split(".")[0]`
-   *
-   * @default your_locale
-   */
-  locale?: string;
-
-  /**
-   * Timezone of the A.I. chatbot.
-   *
-   * If you configure this property, the A.I. chatbot will consider the
-   * given timezone. You can get the timezone value by
-   * `Intl.DateTimeFormat().resolvedOptions().timeZone`.
-   *
-   * @default your_timezone
-   */
-  timezone?: string;
-
-  /**
-   * Retry count.
-   *
-   * If LLM function calling composed arguments are invalid,
-   * the A.I. chatbot will retry to call the function with
-   * the modified arguments.
-   *
-   * By the way, if you configure it to 0 or 1, the A.I. chatbot
-   * will not retry the LLM function calling for correcting the
-   * arguments.
-   *
-   * @default 3
-   */
-  retry?: number;
-
   /**
    * Whether to throw an exception when execution fails.
    *
@@ -91,22 +53,4 @@ export interface IMicroAgenticaConfig {
    * @default true
    */
   throw?: boolean;
-
-  /**
-   * Backoff strategy.
-   *
-   * If OpenAI SDK fails to connect LLM API Server, this Backoff factor
-   * would be used to retry for the next connection.
-   *
-   * If the function returns `true`, the retry would be stopped.
-   * Otherwise, the retry would be continued.
-   *
-   * @default (props) => throw props.error
-   * @returns {number} The number of milliseconds to wait before the next retry
-   * @throws {Error} If the function want to stop the retry, you can throw an error
-   */
-  backoffStrategy?: (props: {
-    count: number;
-    error: unknown;
-  }) => number;
 }

package/src/utils/ChatGptCompletionMessageUtil.spec.ts

@@ -42,9 +42,9 @@ describe("chatGptCompletionMessageUtil", () => {
     });
 
     it("should handle invalid JSON", () => {
-      expect(() => {
-        ChatGptCompletionMessageUtil.transformCompletionChunk("invalid json");
-      }).toThrow();
+      const result = ChatGptCompletionMessageUtil.transformCompletionChunk("invalid json");
+      // https://github.com/wrtnlabs/agentica/pull/464/files
+      expect(result).toEqual("invalid json");
     });
   });
 

package/src/utils/request.ts

@@ -2,6 +2,7 @@ import type OpenAI from "openai";
 
 import { v4 } from "uuid";
 
+import type { AgenticaContextRequestResult } from "../context/AgenticaContextRequestResult";
 import type { AgenticaTokenUsage } from "../context/AgenticaTokenUsage";
 import type { AgenticaEventSource, AgenticaRequestEvent, AgenticaResponseEvent } from "../events";
 import type { IAgenticaConfig, IAgenticaVendor, IMicroAgenticaConfig } from "../structures";
@@ -12,7 +13,7 @@ import { createRequestEvent } from "../factory";
 import { ChatGptCompletionMessageUtil } from "./ChatGptCompletionMessageUtil";
 import { streamDefaultReaderToAsyncGenerator, StreamUtil } from "./StreamUtil";
 
-export function getChatCompletionWithStreamingFunction(props: {
+export function getChatCompletionFunction(props: {
   vendor: IAgenticaVendor;
   config?: IAgenticaConfig | IMicroAgenticaConfig;
   dispatch: (event: AgenticaRequestEvent | AgenticaResponseEvent) => Promise<void>;
@@ -21,17 +22,18 @@ export function getChatCompletionWithStreamingFunction(props: {
 }) {
   return async (
     source: AgenticaEventSource,
-    body: Omit<OpenAI.ChatCompletionCreateParamsStreaming, "model" | "stream">,
-  ) => {
+    body: Omit<OpenAI.ChatCompletionCreateParamsStreaming | OpenAI.ChatCompletionCreateParamsNonStreaming, "model">,
+  ): Promise<AgenticaContextRequestResult> => {
+    const streamOptions = props.config?.stream === true || props.config?.stream === undefined
+      ? { stream: true, stream_options: { include_usage: true } }
+      : { stream: false };
     const event: AgenticaRequestEvent = createRequestEvent({
       source,
+      stream: streamOptions.stream,
       body: {
         ...body,
         model: props.vendor.model,
-        stream: true,
-        stream_options: {
-          include_usage: true,
-        },
+        ...streamOptions,
       },
       options: {
         ...props.vendor.options,
@@ -61,6 +63,32 @@ export function getChatCompletionWithStreamingFunction(props: {
       }
     })();
 
+    if ("toReadableStream" in completion === false) {
+      if (completion.usage != null) {
+        AgenticaTokenUsageAggregator.aggregate({
+          kind: source,
+          completionUsage: completion.usage,
+          usage: props.usage,
+        });
+      }
+      void props.dispatch({
+        id: v4(),
+        type: "response",
+        request_id: event.id,
+        source,
+        stream: false,
+        body: event.body as OpenAI.ChatCompletionCreateParamsNonStreaming,
+        completion,
+        options: event.options,
+        join: async () => completion,
+        created_at: new Date().toISOString(),
+      }).catch(() => {});
+      return {
+        type: "none-stream",
+        value: completion,
+      };
+    }
+
     const [streamForEvent, temporaryStream] = StreamUtil.transform(
       completion.toReadableStream() as ReadableStream<Uint8Array>,
       value =>
@@ -93,8 +121,9 @@ export function getChatCompletionWithStreamingFunction(props: {
       type: "response",
       request_id: event.id,
       source,
-      stream: streamDefaultReaderToAsyncGenerator(streamForStream.getReader(), props.abortSignal),
-      body: event.body,
+      stream: true,
+      body: event.body as OpenAI.ChatCompletionCreateParamsStreaming,
+      completion: streamDefaultReaderToAsyncGenerator(streamForStream.getReader(), props.abortSignal),
       options: event.options,
       join: async () => {
         const chunks = await StreamUtil.readAll(streamForJoin, props.abortSignal);
@@ -102,6 +131,10 @@ export function getChatCompletionWithStreamingFunction(props: {
       },
       created_at: new Date().toISOString(),
     }).catch(() => {});
-    return streamForReturn;
+
+    return {
+      type: "stream",
+      value: streamForReturn,
+    };
   };
 }