@aigne/openai 0.4.3 → 0.6.0

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [0.6.0](https://github.com/AIGNE-io/aigne-framework/compare/openai-v0.5.0...openai-v0.6.0) (2025-07-01)
+
+
+### Features
+
+* **example:** use AIGNE cli to run chat-bot example ([#198](https://github.com/AIGNE-io/aigne-framework/issues/198)) ([7085541](https://github.com/AIGNE-io/aigne-framework/commit/708554100692f2a557f7329ea78e46c3c870ce10))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.28.0
+  * devDependencies
+    * @aigne/test-utils bumped to 0.4.12
+
+## [0.5.0](https://github.com/AIGNE-io/aigne-framework/compare/openai-v0.4.3...openai-v0.5.0) (2025-07-01)
+
+
+### Features
+
+* **cli:** support HTTPS_PROXY and named path param ([#196](https://github.com/AIGNE-io/aigne-framework/issues/196)) ([04e684e](https://github.com/AIGNE-io/aigne-framework/commit/04e684ee26bc2d79924b0e3cb541cd07a7191804))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.27.0
+  * devDependencies
+    * @aigne/test-utils bumped to 0.4.11
+
 ## [0.4.3](https://github.com/AIGNE-io/aigne-framework/compare/openai-v0.4.2...openai-v0.4.3) (2025-06-30)
 
 

package/README.md

@@ -79,6 +79,7 @@ console.log(result);
 ## Streaming Responses
 
 ```typescript file="test/openai-chat-model.test.ts" region="example-openai-chat-model-stream"
+import { isAgentResponseDelta } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/openai";
 
 const model = new OpenAIChatModel({
@@ -90,7 +91,6 @@ const stream = await model.invoke(
   {
     messages: [{ role: "user", content: "Hello, who are you?" }],
   },
-  undefined,
   { streaming: true },
 );
 
@@ -98,9 +98,11 @@ let fullText = "";
 const json = {};
 
 for await (const chunk of stream) {
-  const text = chunk.delta.text?.text;
-  if (text) fullText += text;
-  if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+  if (isAgentResponseDelta(chunk)) {
+    const text = chunk.delta.text?.text;
+    if (text) fullText += text;
+    if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+  }
 }
 
 console.log(fullText); // Output: "Hello! How can I assist you today?"

package/README.zh.md

@@ -79,6 +79,7 @@ console.log(result);
 ## 流式响应
 
 ```typescript file="test/openai-chat-model.test.ts" region="example-openai-chat-model-stream"
+import { isAgentResponseDelta } from "@aigne/core";
 import { OpenAIChatModel } from "@aigne/openai";
 
 const model = new OpenAIChatModel({
@@ -90,7 +91,6 @@ const stream = await model.invoke(
   {
     messages: [{ role: "user", content: "Hello, who are you?" }],
   },
-  undefined,
   { streaming: true },
 );
 
@@ -98,9 +98,11 @@ let fullText = "";
 const json = {};
 
 for await (const chunk of stream) {
-  const text = chunk.delta.text?.text;
-  if (text) fullText += text;
-  if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+  if (isAgentResponseDelta(chunk)) {
+    const text = chunk.delta.text?.text;
+    if (text) fullText += text;
+    if (chunk.delta.json) Object.assign(json, chunk.delta.json);
+  }
 }
 
 console.log(fullText); // Output: "Hello! How can I assist you today?"

package/lib/cjs/openai-chat-model.d.ts

@@ -1,6 +1,6 @@
 import { type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelInputMessage, type ChatModelInputTool, type ChatModelOptions, type ChatModelOutput, type Role } from "@aigne/core";
 import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
-import OpenAI from "openai";
+import OpenAI, { type ClientOptions } from "openai";
 import type { ChatCompletionMessageParam, ChatCompletionTool } from "openai/resources";
 import { z } from "zod";
 export interface OpenAIChatModelCapabilities {
@@ -38,6 +38,10 @@ export interface OpenAIChatModelOptions {
      * Additional model options to control behavior
      */
     modelOptions?: ChatModelOptions;
+    /**
+     * Client options for OpenAI API
+     */
+    clientOptions?: Partial<ClientOptions>;
 }
 /**
  * @hidden

package/lib/cjs/openai-chat-model.js

@@ -88,6 +88,7 @@ class OpenAIChatModel extends core_1.ChatModel {
         this._client ??= new openai_1.default({
             baseURL: this.options?.baseURL,
             apiKey,
+            ...this.options?.clientOptions,
         });
         return this._client;
     }

package/lib/dts/openai-chat-model.d.ts

@@ -1,6 +1,6 @@
 import { type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelInputMessage, type ChatModelInputTool, type ChatModelOptions, type ChatModelOutput, type Role } from "@aigne/core";
 import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
-import OpenAI from "openai";
+import OpenAI, { type ClientOptions } from "openai";
 import type { ChatCompletionMessageParam, ChatCompletionTool } from "openai/resources";
 import { z } from "zod";
 export interface OpenAIChatModelCapabilities {
@@ -38,6 +38,10 @@ export interface OpenAIChatModelOptions {
      * Additional model options to control behavior
      */
     modelOptions?: ChatModelOptions;
+    /**
+     * Client options for OpenAI API
+     */
+    clientOptions?: Partial<ClientOptions>;
 }
 /**
  * @hidden

package/lib/esm/openai-chat-model.d.ts

@@ -1,6 +1,6 @@
 import { type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelInputMessage, type ChatModelInputTool, type ChatModelOptions, type ChatModelOutput, type Role } from "@aigne/core";
 import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
-import OpenAI from "openai";
+import OpenAI, { type ClientOptions } from "openai";
 import type { ChatCompletionMessageParam, ChatCompletionTool } from "openai/resources";
 import { z } from "zod";
 export interface OpenAIChatModelCapabilities {
@@ -38,6 +38,10 @@ export interface OpenAIChatModelOptions {
      * Additional model options to control behavior
      */
     modelOptions?: ChatModelOptions;
+    /**
+     * Client options for OpenAI API
+     */
+    clientOptions?: Partial<ClientOptions>;
 }
 /**
  * @hidden

package/lib/esm/openai-chat-model.js

@@ -79,6 +79,7 @@ export class OpenAIChatModel extends ChatModel {
         this._client ??= new OpenAI({
             baseURL: this.options?.baseURL,
             apiKey,
+            ...this.options?.clientOptions,
         });
         return this._client;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/openai",
-  "version": "0.4.3",
+  "version": "0.6.0",
   "description": "AIGNE OpenAI SDK for integrating with OpenAI's GPT models and API services",
   "publishConfig": {
     "access": "public"
@@ -35,7 +35,7 @@
     "nanoid": "^5.1.5",
     "openai": "^4.87.3",
     "zod": "^3.24.4",
-    "@aigne/core": "^1.26.0"
+    "@aigne/core": "^1.28.0"
   },
   "devDependencies": {
     "@types/bun": "^1.2.12",
@@ -43,7 +43,7 @@
     "npm-run-all": "^4.1.5",
     "rimraf": "^6.0.1",
     "typescript": "^5.8.3",
-    "@aigne/test-utils": "^0.4.10"
+    "@aigne/test-utils": "^0.4.12"
   },
   "scripts": {
     "lint": "tsc --noEmit",