@agentica/core 0.43.2 → 0.44.0-dev.20260313

package/src/utils/ChatGptCompletionMessageUtil.spec.ts

@@ -1,320 +1,314 @@
-import type {
-  ChatCompletion,
-  ChatCompletionChunk,
-  ChatCompletionMessageToolCall,
-} from "openai/resources";
-
-import { ChatGptCompletionMessageUtil } from "./ChatGptCompletionMessageUtil";
-
-describe("chatGptCompletionMessageUtil", () => {
-  describe("transformCompletionChunk", () => {
-    it("should transform string chunk to ChatCompletionChunk", () => {
-      const chunk = {
-        id: "test-id",
-        choices: [{
-          index: 0,
-          delta: { content: "Hello" },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion.chunk",
-      };
-
-      const result = ChatGptCompletionMessageUtil.transformCompletionChunk(JSON.stringify(chunk));
-      expect(result).toEqual(chunk);
-    });
-
-    it("should transform Uint8Array chunk to ChatCompletionChunk", () => {
-      const chunk = {
-        id: "test-id",
-        choices: [{
-          index: 0,
-          delta: { content: "Hello" },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion.chunk",
-      };
-
-      const uint8Array = new TextEncoder().encode(JSON.stringify(chunk));
-      const result = ChatGptCompletionMessageUtil.transformCompletionChunk(uint8Array);
-      expect(result).toEqual(chunk);
-    });
-
-    it("should handle invalid JSON", () => {
-      const result = ChatGptCompletionMessageUtil.transformCompletionChunk("invalid json");
-      // https://github.com/wrtnlabs/agentica/pull/464/files
-      expect(result).toEqual("invalid json");
-    });
-  });
-
-  describe("accumulate", () => {
-    it("should accumulate content from chunks", () => {
-      const origin: ChatCompletion = {
-        id: "test-id",
-        choices: [{
-          index: 0,
-          // @ts-expect-error - refusal is not required
-          message: { role: "assistant", content: "Hello" },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion",
-      };
-
-      const chunk: ChatCompletionChunk = {
-        id: "test-id",
-        // @ts-expect-error - finish_reason is not required
-        choices: [{
-          index: 0,
-          delta: { content: " World" },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion.chunk",
-      };
-
-      const result = ChatGptCompletionMessageUtil.accumulate(origin, chunk);
-      expect(result.choices[0]?.message.content).toBe("Hello World");
-    });
-
-    it("should accumulate tool calls", () => {
-      const origin: ChatCompletion = {
-        id: "test-id",
-        choices: [{
-          index: 0,
-          // @ts-expect-error - finish_reason is not required
-          message: {
-            role: "assistant",
-            content: null,
-            tool_calls: [{
-              id: "call_1",
-              type: "function",
-              function: {
-                name: "test",
-                arguments: "{\"arg\": \"value\"}",
-              },
-            }],
-          },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion",
-      };
-
-      const chunk: ChatCompletionChunk = {
-        id: "test-id",
-        // @ts-expect-error - finish_reason is not required
-        choices: [{
-          index: 0,
-          delta: {
-            tool_calls: [{
-              index: 0,
-              id: "call_1",
-              function: {
-                name: "_function",
-                arguments: "{\"arg2\": \"value2\"}",
-              },
-            }],
-          },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion.chunk",
-      };
-
-      const result = ChatGptCompletionMessageUtil.accumulate(origin, chunk);
-      expect(result.choices[0]?.message.tool_calls?.filter(tc => tc.type === "function")[0]?.function.name).toBe("test_function");
-      expect(result.choices[0]?.message.tool_calls?.filter(tc => tc.type === "function")[0]?.function.arguments).toBe("{\"arg\": \"value\"}{\"arg2\": \"value2\"}");
-    });
-
-    it("should handle usage aggregation", () => {
-      const origin: ChatCompletion = {
-        id: "test-id",
-        choices: [{
-          index: 0,
-          // @ts-expect-error - finish_reason is not required
-          message: { role: "assistant", content: "Hello" },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion",
-        usage: {
-          prompt_tokens: 10,
-          completion_tokens: 5,
-          total_tokens: 15,
-        },
-      };
-
-      const chunk: ChatCompletionChunk = {
-        id: "test-id",
-        // @ts-expect-error - finish_reason is not required
-        choices: [{
-          index: 0,
-          delta: { content: " World" },
-        }],
-        created: 1234567890,
-        model: "gpt-4",
-        object: "chat.completion.chunk",
-        usage: {
-          prompt_tokens: 0,
-          completion_tokens: 6,
-          total_tokens: 6,
-        },
-      };
-
-      const result = ChatGptCompletionMessageUtil.accumulate(origin, chunk);
-      expect(result.usage).toEqual({
-        prompt_tokens: 10,
-        completion_tokens: 11,
-        total_tokens: 21,
-        completion_tokens_details: {
-          accepted_prediction_tokens: 0,
-          reasoning_tokens: 0,
-          rejected_prediction_tokens: 0,
-        },
-        prompt_tokens_details: {
-          audio_tokens: 0,
-          cached_tokens: 0,
-        },
-      });
-    });
-  });
-
-  describe("merge", () => {
-    it("should merge multiple chunks into completion", () => {
-      const chunks: ChatCompletionChunk[] = [
-        {
-          id: "test-id",
-          // @ts-expect-error - finish_reason is not required
-          choices: [{
-            index: 0,
-            delta: { content: "Hello" },
-          }],
-          created: 1234567890,
-          model: "gpt-4",
-          object: "chat.completion.chunk",
-        },
-        {
-          id: "test-id",
-          // @ts-expect-error - finish_reason is not required
-          choices: [{
-            index: 0,
-            delta: { content: " World" },
-          }],
-          created: 1234567890,
-          model: "gpt-4",
-          object: "chat.completion.chunk",
-        },
-      ];
-
-      const result = ChatGptCompletionMessageUtil.merge(chunks);
-      expect(result.choices[0]?.message.content).toBe("Hello World");
-    });
-
-    it("should throw error for empty chunks array", () => {
-      expect(() => {
-        ChatGptCompletionMessageUtil.merge([]);
-      }).toThrow("No chunks received");
-    });
-  });
-
-  describe("mergeChoice", () => {
-    it("should merge finish reason", () => {
-      const acc: ChatCompletion.Choice = {
-        index: 0,
-        // @ts-expect-error - finish_reason is not required
-        message: { role: "assistant", content: "Hello" },
-      };
-
-      const cur: ChatCompletionChunk.Choice = {
-        index: 0,
-        delta: {},
-        finish_reason: "stop",
-      };
-
-      const result = ChatGptCompletionMessageUtil.mergeChoice(acc, cur);
-      expect(result.finish_reason).toBe("stop");
-    });
-
-    it("should merge content", () => {
-      const acc: ChatCompletion.Choice = {
-        index: 0,
-        // @ts-expect-error - refusal is not required
-        message: { role: "assistant", content: "Hello" },
-      };
-
-      // @ts-expect-error - finish_reason is not required
-      const cur: ChatCompletionChunk.Choice = {
-        index: 0,
-        delta: { content: " World" },
-      };
-
-      const result = ChatGptCompletionMessageUtil.mergeChoice(acc, cur);
-      expect(result.message.content).toBe("Hello World");
-    });
-
-    it("should merge refusal", () => {
-      // @ts-expect-error - finish_reason is not required
-      const acc: ChatCompletion.Choice = {
-        index: 0,
-        message: { role: "assistant", content: null, refusal: "I cannot" },
-      };
-
-      // @ts-expect-error - finish_reason is not required
-      const cur: ChatCompletionChunk.Choice = {
-        index: 0,
-        delta: { refusal: " do that" },
-      };
-
-      const result = ChatGptCompletionMessageUtil.mergeChoice(acc, cur);
-      expect(result.message.refusal).toBe("I cannot do that");
-    });
-  });
-
-  describe("mergeToolCalls", () => {
-    it("should merge tool call function arguments", () => {
-      const acc: ChatCompletionMessageToolCall = {
-        id: "call_1",
-        type: "function",
-        function: {
-          name: "test",
-          arguments: "{\"arg\": \"value\"}",
-        },
-      };
-
-      const cur: ChatCompletionChunk.Choice.Delta.ToolCall = {
-        index: 0,
-        id: "call_1",
-        function: {
-          arguments: "{\"arg2\": \"value2\"}",
-        },
-      };
-
-      const result = ChatGptCompletionMessageUtil.mergeToolCalls(acc, cur);
-      expect(result.type === "function" ? result.function.arguments : "custom").toBe("{\"arg\": \"value\"}{\"arg2\": \"value2\"}");
-    });
-
-    it("should merge tool call function name", () => {
-      const acc: ChatCompletionMessageToolCall = {
-        id: "call_1",
-        type: "function",
-        function: {
-          name: "test",
-          arguments: "",
-        },
-      };
-
-      const cur: ChatCompletionChunk.Choice.Delta.ToolCall = {
-        index: 0,
-        id: "call_1",
-        function: {
-          name: "_function",
-        },
-      };
-
-      const result = ChatGptCompletionMessageUtil.mergeToolCalls(acc, cur);
-      expect(result.type === "function" ? result.function.name : "custom").toBe("test_function");
-    });
-  });
-});
+import type {
+  ChatCompletion,
+  ChatCompletionChunk,
+  ChatCompletionMessageToolCall,
+} from "openai/resources";
+
+import { ChatGptCompletionMessageUtil } from "./ChatGptCompletionMessageUtil";
+
+describe("chatGptCompletionMessageUtil", () => {
+  describe("transformCompletionChunk", () => {
+    it("should transform string chunk to ChatCompletionChunk", () => {
+      const chunk = {
+        id: "test-id",
+        choices: [{
+          index: 0,
+          delta: { content: "Hello" },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion.chunk",
+      };
+
+      const result = ChatGptCompletionMessageUtil.transformCompletionChunk(JSON.stringify(chunk));
+      expect(result).toEqual(chunk);
+    });
+
+    it("should transform Uint8Array chunk to ChatCompletionChunk", () => {
+      const chunk = {
+        id: "test-id",
+        choices: [{
+          index: 0,
+          delta: { content: "Hello" },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion.chunk",
+      };
+
+      const uint8Array = new TextEncoder().encode(JSON.stringify(chunk));
+      const result = ChatGptCompletionMessageUtil.transformCompletionChunk(uint8Array);
+      expect(result).toEqual(chunk);
+    });
+  });
+
+  describe("accumulate", () => {
+    it("should accumulate content from chunks", () => {
+      const origin: ChatCompletion = {
+        id: "test-id",
+        choices: [{
+          index: 0,
+          // @ts-expect-error - refusal is not required
+          message: { role: "assistant", content: "Hello" },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion",
+      };
+
+      const chunk: ChatCompletionChunk = {
+        id: "test-id",
+        // @ts-expect-error - finish_reason is not required
+        choices: [{
+          index: 0,
+          delta: { content: " World" },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion.chunk",
+      };
+
+      const result = ChatGptCompletionMessageUtil.accumulate(origin, chunk);
+      expect(result.choices[0]?.message.content).toBe("Hello World");
+    });
+
+    it("should accumulate tool calls", () => {
+      const origin: ChatCompletion = {
+        id: "test-id",
+        choices: [{
+          index: 0,
+          // @ts-expect-error - finish_reason is not required
+          message: {
+            role: "assistant",
+            content: null,
+            tool_calls: [{
+              id: "call_1",
+              type: "function",
+              function: {
+                name: "test",
+                arguments: "{\"arg\": \"value\"}",
+              },
+            }],
+          },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion",
+      };
+
+      const chunk: ChatCompletionChunk = {
+        id: "test-id",
+        // @ts-expect-error - finish_reason is not required
+        choices: [{
+          index: 0,
+          delta: {
+            tool_calls: [{
+              index: 0,
+              id: "call_1",
+              function: {
+                name: "_function",
+                arguments: "{\"arg2\": \"value2\"}",
+              },
+            }],
+          },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion.chunk",
+      };
+
+      const result = ChatGptCompletionMessageUtil.accumulate(origin, chunk);
+      expect(result.choices[0]?.message.tool_calls?.filter(tc => tc.type === "function")[0]?.function.name).toBe("test_function");
+      expect(result.choices[0]?.message.tool_calls?.filter(tc => tc.type === "function")[0]?.function.arguments).toBe("{\"arg\": \"value\"}{\"arg2\": \"value2\"}");
+    });
+
+    it("should handle usage aggregation", () => {
+      const origin: ChatCompletion = {
+        id: "test-id",
+        choices: [{
+          index: 0,
+          // @ts-expect-error - finish_reason is not required
+          message: { role: "assistant", content: "Hello" },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion",
+        usage: {
+          prompt_tokens: 10,
+          completion_tokens: 5,
+          total_tokens: 15,
+        },
+      };
+
+      const chunk: ChatCompletionChunk = {
+        id: "test-id",
+        // @ts-expect-error - finish_reason is not required
+        choices: [{
+          index: 0,
+          delta: { content: " World" },
+        }],
+        created: 1234567890,
+        model: "gpt-4",
+        object: "chat.completion.chunk",
+        usage: {
+          prompt_tokens: 0,
+          completion_tokens: 6,
+          total_tokens: 6,
+        },
+      };
+
+      const result = ChatGptCompletionMessageUtil.accumulate(origin, chunk);
+      expect(result.usage).toEqual({
+        prompt_tokens: 10,
+        completion_tokens: 11,
+        total_tokens: 21,
+        completion_tokens_details: {
+          accepted_prediction_tokens: 0,
+          reasoning_tokens: 0,
+          rejected_prediction_tokens: 0,
+        },
+        prompt_tokens_details: {
+          audio_tokens: 0,
+          cached_tokens: 0,
+        },
+      });
+    });
+  });
+
+  describe("merge", () => {
+    it("should merge multiple chunks into completion", () => {
+      const chunks: ChatCompletionChunk[] = [
+        {
+          id: "test-id",
+          // @ts-expect-error - finish_reason is not required
+          choices: [{
+            index: 0,
+            delta: { content: "Hello" },
+          }],
+          created: 1234567890,
+          model: "gpt-4",
+          object: "chat.completion.chunk",
+        },
+        {
+          id: "test-id",
+          // @ts-expect-error - finish_reason is not required
+          choices: [{
+            index: 0,
+            delta: { content: " World" },
+          }],
+          created: 1234567890,
+          model: "gpt-4",
+          object: "chat.completion.chunk",
+        },
+      ];
+
+      const result = ChatGptCompletionMessageUtil.merge(chunks);
+      expect(result.choices[0]?.message.content).toBe("Hello World");
+    });
+
+    it("should throw error for empty chunks array", () => {
+      expect(() => {
+        ChatGptCompletionMessageUtil.merge([]);
+      }).toThrow("No chunks received");
+    });
+  });
+
+  describe("mergeChoice", () => {
+    it("should merge finish reason", () => {
+      const acc: ChatCompletion.Choice = {
+        index: 0,
+        // @ts-expect-error - finish_reason is not required
+        message: { role: "assistant", content: "Hello" },
+      };
+
+      const cur: ChatCompletionChunk.Choice = {
+        index: 0,
+        delta: {},
+        finish_reason: "stop",
+      };
+
+      const result = ChatGptCompletionMessageUtil.mergeChoice(acc, cur);
+      expect(result.finish_reason).toBe("stop");
+    });
+
+    it("should merge content", () => {
+      const acc: ChatCompletion.Choice = {
+        index: 0,
+        // @ts-expect-error - refusal is not required
+        message: { role: "assistant", content: "Hello" },
+      };
+
+      // @ts-expect-error - finish_reason is not required
+      const cur: ChatCompletionChunk.Choice = {
+        index: 0,
+        delta: { content: " World" },
+      };
+
+      const result = ChatGptCompletionMessageUtil.mergeChoice(acc, cur);
+      expect(result.message.content).toBe("Hello World");
+    });
+
+    it("should merge refusal", () => {
+      // @ts-expect-error - finish_reason is not required
+      const acc: ChatCompletion.Choice = {
+        index: 0,
+        message: { role: "assistant", content: null, refusal: "I cannot" },
+      };
+
+      // @ts-expect-error - finish_reason is not required
+      const cur: ChatCompletionChunk.Choice = {
+        index: 0,
+        delta: { refusal: " do that" },
+      };
+
+      const result = ChatGptCompletionMessageUtil.mergeChoice(acc, cur);
+      expect(result.message.refusal).toBe("I cannot do that");
+    });
+  });
+
+  describe("mergeToolCalls", () => {
+    it("should merge tool call function arguments", () => {
+      const acc: ChatCompletionMessageToolCall = {
+        id: "call_1",
+        type: "function",
+        function: {
+          name: "test",
+          arguments: "{\"arg\": \"value\"}",
+        },
+      };
+
+      const cur: ChatCompletionChunk.Choice.Delta.ToolCall = {
+        index: 0,
+        id: "call_1",
+        function: {
+          arguments: "{\"arg2\": \"value2\"}",
+        },
+      };
+
+      const result = ChatGptCompletionMessageUtil.mergeToolCalls(acc, cur);
+      expect(result.type === "function" ? result.function.arguments : "custom").toBe("{\"arg\": \"value\"}{\"arg2\": \"value2\"}");
+    });
+
+    it("should merge tool call function name", () => {
+      const acc: ChatCompletionMessageToolCall = {
+        id: "call_1",
+        type: "function",
+        function: {
+          name: "test",
+          arguments: "",
+        },
+      };
+
+      const cur: ChatCompletionChunk.Choice.Delta.ToolCall = {
+        index: 0,
+        id: "call_1",
+        function: {
+          name: "_function",
+        },
+      };
+
+      const result = ChatGptCompletionMessageUtil.mergeToolCalls(acc, cur);
+      expect(result.type === "function" ? result.function.name : "custom").toBe("test_function");
+    });
+  });
+});