@aigne/openai 0.16.3 → 0.16.4-beta.1

package/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## [0.16.4-beta.1](https://github.com/AIGNE-io/aigne-framework/compare/openai-v0.16.4-beta...openai-v0.16.4-beta.1) (2025-10-24)
+
+
+### Features
+
+* **model:** support video model ([#647](https://github.com/AIGNE-io/aigne-framework/issues/647)) ([de81742](https://github.com/AIGNE-io/aigne-framework/commit/de817421ef1dd3246d0d8c51ff12f0a855658f9f))
+
+
+### Bug Fixes
+
+* **model:** updated default video duration settings for AI video models ([#663](https://github.com/AIGNE-io/aigne-framework/issues/663)) ([1203941](https://github.com/AIGNE-io/aigne-framework/commit/12039411aaef77ba665e8edfb0fe6f8097c43e39))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.65.0-beta
+  * devDependencies
+    * @aigne/test-utils bumped to 0.5.57-beta.1
+
+## [0.16.4-beta](https://github.com/AIGNE-io/aigne-framework/compare/openai-v0.16.3...openai-v0.16.4-beta) (2025-10-23)
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @aigne/core bumped to 1.64.1-beta
+  * devDependencies
+    * @aigne/test-utils bumped to 0.5.57-beta
+
 ## [0.16.3](https://github.com/AIGNE-io/aigne-framework/compare/openai-v0.16.3-beta.1...openai-v0.16.3) (2025-10-22)
 
 

package/lib/cjs/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./openai-chat-model.js";
 export * from "./openai-image-model.js";
+export * from "./openai-video-model.js";

package/lib/cjs/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./openai-chat-model.js"), exports);
 __exportStar(require("./openai-image-model.js"), exports);
+__exportStar(require("./openai-video-model.js"), exports);

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

@@ -0,0 +1,72 @@
+import { VideoModel, type VideoModelInput, type VideoModelOptions, type VideoModelOutput } from "@aigne/core";
+import type OpenAI from "openai";
+import type { ClientOptions } from "openai";
+/**
+ * Input options for OpenAI Video Model
+ */
+export interface OpenAIVideoModelInput extends VideoModelInput {
+    /**
+     * Optional image reference that guides generation (file path or URL)
+     */
+    inputReference?: string;
+}
+/**
+ * Output from OpenAI Video Model
+ */
+export interface OpenAIVideoModelOutput extends VideoModelOutput {
+}
+/**
+ * Configuration options for OpenAI Video Model
+ */
+export interface OpenAIVideoModelOptions extends VideoModelOptions<OpenAIVideoModelInput, OpenAIVideoModelOutput> {
+    /**
+     * API key for OpenAI API
+     *
+     * If not provided, will look for OPENAI_API_KEY in environment variables
+     */
+    apiKey?: string;
+    /**
+     * Base URL for OpenAI API
+     *
+     * Useful for proxies or alternate endpoints
+     */
+    baseURL?: string;
+    /**
+     * OpenAI model to use
+     *
+     * Defaults to 'sora-2'
+     */
+    model?: string;
+    /**
+     * Additional model options to control behavior
+     */
+    modelOptions?: Omit<Partial<OpenAIVideoModelInput>, "model">;
+    /**
+     * Client options for OpenAI API
+     */
+    clientOptions?: Partial<ClientOptions>;
+    /**
+     * Polling interval in milliseconds for checking video generation status
+     *
+     * Defaults to 2000ms (2 seconds)
+     */
+    pollingInterval?: number;
+}
+export declare class OpenAIVideoModel extends VideoModel<OpenAIVideoModelInput, OpenAIVideoModelOutput> {
+    options?: OpenAIVideoModelOptions | undefined;
+    constructor(options?: OpenAIVideoModelOptions | undefined);
+    /**
+     * @hidden
+     */
+    protected _client?: OpenAI;
+    protected apiKeyEnvName: string;
+    get client(): OpenAI;
+    get credential(): {
+        url: string | undefined;
+        apiKey: string | undefined;
+        model: string;
+    };
+    get modelOptions(): Omit<Partial<OpenAIVideoModelInput>, "model"> | undefined;
+    downloadToFile(videoId: string): Promise<string>;
+    process(input: OpenAIVideoModelInput): Promise<OpenAIVideoModelOutput>;
+}

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

@@ -0,0 +1,115 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenAIVideoModel = void 0;
+const core_1 = require("@aigne/core");
+const logger_js_1 = require("@aigne/core/utils/logger.js");
+const type_utils_js_1 = require("@aigne/core/utils/type-utils.js");
+const zod_1 = require("zod");
+const openai_js_1 = require("./openai.js");
+const DEFAULT_MODEL = "sora-2";
+const DEFAULT_SECONDS = 4;
+const openAIVideoModelInputSchema = core_1.videoModelInputSchema.extend({
+    inputReference: zod_1.z.string().optional(),
+});
+const openAIVideoModelOptionsSchema = zod_1.z.object({
+    apiKey: zod_1.z.string().optional(),
+    baseURL: zod_1.z.string().optional(),
+    model: zod_1.z.string().optional(),
+    modelOptions: zod_1.z.object({}).optional(),
+    clientOptions: zod_1.z.object({}).optional(),
+    pollingInterval: zod_1.z.number().optional(),
+});
+class OpenAIVideoModel extends core_1.VideoModel {
+    options;
+    constructor(options) {
+        super({
+            ...options,
+            description: options?.description ?? "Generate videos using OpenAI Sora models",
+            inputSchema: openAIVideoModelInputSchema,
+        });
+        this.options = options;
+        if (options)
+            (0, type_utils_js_1.checkArguments)(this.name, openAIVideoModelOptionsSchema, options);
+    }
+    /**
+     * @hidden
+     */
+    _client;
+    apiKeyEnvName = "OPENAI_API_KEY";
+    get client() {
+        const { apiKey, url } = this.credential;
+        if (!apiKey)
+            throw new Error(`${this.name} requires an API key. Please provide it via \`options.apiKey\`, or set the \`${this.apiKeyEnvName}\` environment variable`);
+        this._client ??= new openai_js_1.CustomOpenAI({
+            baseURL: url,
+            apiKey,
+            ...this.options?.clientOptions,
+        });
+        return this._client;
+    }
+    get credential() {
+        return {
+            url: this.options?.baseURL || process.env.OPENAI_BASE_URL,
+            apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],
+            model: this.options?.model || DEFAULT_MODEL,
+        };
+    }
+    get modelOptions() {
+        return this.options?.modelOptions;
+    }
+    async downloadToFile(videoId) {
+        logger_js_1.logger.debug("Downloading video content...");
+        const content = await this.client.videos.downloadContent(videoId);
+        const arrayBuffer = await content.arrayBuffer();
+        const buffer = Buffer.from(arrayBuffer);
+        const base64 = buffer.toString("base64");
+        const dataUrl = `data:video/mp4;base64,${base64}`;
+        return dataUrl;
+    }
+    async process(input) {
+        const model = input.model ?? this.credential.model;
+        const createParams = {
+            model: model,
+            prompt: input.prompt,
+        };
+        if (input.seconds)
+            createParams.seconds = input.seconds;
+        if (input.size)
+            createParams.size = input.size;
+        if (input.inputReference) {
+            createParams.input_reference =
+                input.inputReference;
+        }
+        let video = await this.client.videos.create(createParams);
+        logger_js_1.logger.debug(`Video generation started: ${video.id}`);
+        const pollingInterval = this.options?.pollingInterval ?? 2000;
+        while (video.status === "in_progress" || video.status === "queued") {
+            await new Promise((resolve) => setTimeout(resolve, pollingInterval));
+            video = await this.client.videos.retrieve(video.id);
+            const progress = video.progress ?? 0;
+            const statusText = video.status === "queued" ? "Queued" : "Processing";
+            logger_js_1.logger.debug(`${statusText}: ${progress.toFixed(1)}%`);
+        }
+        if (video.status === "failed") {
+            throw new Error(`Video generation failed: ${video.error?.message || "Unknown error"}`);
+        }
+        if (video.status !== "completed") {
+            throw new Error(`Unexpected video status: ${video.status}`);
+        }
+        return {
+            videos: [
+                {
+                    type: "file",
+                    data: await this.downloadToFile(video.id),
+                },
+            ],
+            usage: {
+                inputTokens: 0,
+                outputTokens: 0,
+            },
+            model,
+            seconds: input.seconds ? parseInt(input.seconds, 10) : DEFAULT_SECONDS,
+        };
+    }
+}
+exports.OpenAIVideoModel = OpenAIVideoModel;

package/lib/dts/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./openai-chat-model.js";
 export * from "./openai-image-model.js";
+export * from "./openai-video-model.js";

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

@@ -0,0 +1,72 @@
+import { VideoModel, type VideoModelInput, type VideoModelOptions, type VideoModelOutput } from "@aigne/core";
+import type OpenAI from "openai";
+import type { ClientOptions } from "openai";
+/**
+ * Input options for OpenAI Video Model
+ */
+export interface OpenAIVideoModelInput extends VideoModelInput {
+    /**
+     * Optional image reference that guides generation (file path or URL)
+     */
+    inputReference?: string;
+}
+/**
+ * Output from OpenAI Video Model
+ */
+export interface OpenAIVideoModelOutput extends VideoModelOutput {
+}
+/**
+ * Configuration options for OpenAI Video Model
+ */
+export interface OpenAIVideoModelOptions extends VideoModelOptions<OpenAIVideoModelInput, OpenAIVideoModelOutput> {
+    /**
+     * API key for OpenAI API
+     *
+     * If not provided, will look for OPENAI_API_KEY in environment variables
+     */
+    apiKey?: string;
+    /**
+     * Base URL for OpenAI API
+     *
+     * Useful for proxies or alternate endpoints
+     */
+    baseURL?: string;
+    /**
+     * OpenAI model to use
+     *
+     * Defaults to 'sora-2'
+     */
+    model?: string;
+    /**
+     * Additional model options to control behavior
+     */
+    modelOptions?: Omit<Partial<OpenAIVideoModelInput>, "model">;
+    /**
+     * Client options for OpenAI API
+     */
+    clientOptions?: Partial<ClientOptions>;
+    /**
+     * Polling interval in milliseconds for checking video generation status
+     *
+     * Defaults to 2000ms (2 seconds)
+     */
+    pollingInterval?: number;
+}
+export declare class OpenAIVideoModel extends VideoModel<OpenAIVideoModelInput, OpenAIVideoModelOutput> {
+    options?: OpenAIVideoModelOptions | undefined;
+    constructor(options?: OpenAIVideoModelOptions | undefined);
+    /**
+     * @hidden
+     */
+    protected _client?: OpenAI;
+    protected apiKeyEnvName: string;
+    get client(): OpenAI;
+    get credential(): {
+        url: string | undefined;
+        apiKey: string | undefined;
+        model: string;
+    };
+    get modelOptions(): Omit<Partial<OpenAIVideoModelInput>, "model"> | undefined;
+    downloadToFile(videoId: string): Promise<string>;
+    process(input: OpenAIVideoModelInput): Promise<OpenAIVideoModelOutput>;
+}

package/lib/esm/index.d.ts

@@ -1,2 +1,3 @@
 export * from "./openai-chat-model.js";
 export * from "./openai-image-model.js";
+export * from "./openai-video-model.js";

package/lib/esm/index.js

@@ -1,2 +1,3 @@
 export * from "./openai-chat-model.js";
 export * from "./openai-image-model.js";
+export * from "./openai-video-model.js";

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

@@ -0,0 +1,72 @@
+import { VideoModel, type VideoModelInput, type VideoModelOptions, type VideoModelOutput } from "@aigne/core";
+import type OpenAI from "openai";
+import type { ClientOptions } from "openai";
+/**
+ * Input options for OpenAI Video Model
+ */
+export interface OpenAIVideoModelInput extends VideoModelInput {
+    /**
+     * Optional image reference that guides generation (file path or URL)
+     */
+    inputReference?: string;
+}
+/**
+ * Output from OpenAI Video Model
+ */
+export interface OpenAIVideoModelOutput extends VideoModelOutput {
+}
+/**
+ * Configuration options for OpenAI Video Model
+ */
+export interface OpenAIVideoModelOptions extends VideoModelOptions<OpenAIVideoModelInput, OpenAIVideoModelOutput> {
+    /**
+     * API key for OpenAI API
+     *
+     * If not provided, will look for OPENAI_API_KEY in environment variables
+     */
+    apiKey?: string;
+    /**
+     * Base URL for OpenAI API
+     *
+     * Useful for proxies or alternate endpoints
+     */
+    baseURL?: string;
+    /**
+     * OpenAI model to use
+     *
+     * Defaults to 'sora-2'
+     */
+    model?: string;
+    /**
+     * Additional model options to control behavior
+     */
+    modelOptions?: Omit<Partial<OpenAIVideoModelInput>, "model">;
+    /**
+     * Client options for OpenAI API
+     */
+    clientOptions?: Partial<ClientOptions>;
+    /**
+     * Polling interval in milliseconds for checking video generation status
+     *
+     * Defaults to 2000ms (2 seconds)
+     */
+    pollingInterval?: number;
+}
+export declare class OpenAIVideoModel extends VideoModel<OpenAIVideoModelInput, OpenAIVideoModelOutput> {
+    options?: OpenAIVideoModelOptions | undefined;
+    constructor(options?: OpenAIVideoModelOptions | undefined);
+    /**
+     * @hidden
+     */
+    protected _client?: OpenAI;
+    protected apiKeyEnvName: string;
+    get client(): OpenAI;
+    get credential(): {
+        url: string | undefined;
+        apiKey: string | undefined;
+        model: string;
+    };
+    get modelOptions(): Omit<Partial<OpenAIVideoModelInput>, "model"> | undefined;
+    downloadToFile(videoId: string): Promise<string>;
+    process(input: OpenAIVideoModelInput): Promise<OpenAIVideoModelOutput>;
+}

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

@@ -0,0 +1,111 @@
+import { VideoModel, videoModelInputSchema, } from "@aigne/core";
+import { logger } from "@aigne/core/utils/logger.js";
+import { checkArguments } from "@aigne/core/utils/type-utils.js";
+import { z } from "zod";
+import { CustomOpenAI } from "./openai.js";
+const DEFAULT_MODEL = "sora-2";
+const DEFAULT_SECONDS = 4;
+const openAIVideoModelInputSchema = videoModelInputSchema.extend({
+    inputReference: z.string().optional(),
+});
+const openAIVideoModelOptionsSchema = z.object({
+    apiKey: z.string().optional(),
+    baseURL: z.string().optional(),
+    model: z.string().optional(),
+    modelOptions: z.object({}).optional(),
+    clientOptions: z.object({}).optional(),
+    pollingInterval: z.number().optional(),
+});
+export class OpenAIVideoModel extends VideoModel {
+    options;
+    constructor(options) {
+        super({
+            ...options,
+            description: options?.description ?? "Generate videos using OpenAI Sora models",
+            inputSchema: openAIVideoModelInputSchema,
+        });
+        this.options = options;
+        if (options)
+            checkArguments(this.name, openAIVideoModelOptionsSchema, options);
+    }
+    /**
+     * @hidden
+     */
+    _client;
+    apiKeyEnvName = "OPENAI_API_KEY";
+    get client() {
+        const { apiKey, url } = this.credential;
+        if (!apiKey)
+            throw new Error(`${this.name} requires an API key. Please provide it via \`options.apiKey\`, or set the \`${this.apiKeyEnvName}\` environment variable`);
+        this._client ??= new CustomOpenAI({
+            baseURL: url,
+            apiKey,
+            ...this.options?.clientOptions,
+        });
+        return this._client;
+    }
+    get credential() {
+        return {
+            url: this.options?.baseURL || process.env.OPENAI_BASE_URL,
+            apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],
+            model: this.options?.model || DEFAULT_MODEL,
+        };
+    }
+    get modelOptions() {
+        return this.options?.modelOptions;
+    }
+    async downloadToFile(videoId) {
+        logger.debug("Downloading video content...");
+        const content = await this.client.videos.downloadContent(videoId);
+        const arrayBuffer = await content.arrayBuffer();
+        const buffer = Buffer.from(arrayBuffer);
+        const base64 = buffer.toString("base64");
+        const dataUrl = `data:video/mp4;base64,${base64}`;
+        return dataUrl;
+    }
+    async process(input) {
+        const model = input.model ?? this.credential.model;
+        const createParams = {
+            model: model,
+            prompt: input.prompt,
+        };
+        if (input.seconds)
+            createParams.seconds = input.seconds;
+        if (input.size)
+            createParams.size = input.size;
+        if (input.inputReference) {
+            createParams.input_reference =
+                input.inputReference;
+        }
+        let video = await this.client.videos.create(createParams);
+        logger.debug(`Video generation started: ${video.id}`);
+        const pollingInterval = this.options?.pollingInterval ?? 2000;
+        while (video.status === "in_progress" || video.status === "queued") {
+            await new Promise((resolve) => setTimeout(resolve, pollingInterval));
+            video = await this.client.videos.retrieve(video.id);
+            const progress = video.progress ?? 0;
+            const statusText = video.status === "queued" ? "Queued" : "Processing";
+            logger.debug(`${statusText}: ${progress.toFixed(1)}%`);
+        }
+        if (video.status === "failed") {
+            throw new Error(`Video generation failed: ${video.error?.message || "Unknown error"}`);
+        }
+        if (video.status !== "completed") {
+            throw new Error(`Unexpected video status: ${video.status}`);
+        }
+        return {
+            videos: [
+                {
+                    type: "file",
+                    data: await this.downloadToFile(video.id),
+                },
+            ],
+            usage: {
+                inputTokens: 0,
+                outputTokens: 0,
+            },
+            model,
+            seconds: input.seconds ? parseInt(input.seconds, 10) : DEFAULT_SECONDS,
+        };
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/openai",
-  "version": "0.16.3",
+  "version": "0.16.4-beta.1",
   "description": "AIGNE OpenAI SDK for integrating with OpenAI's GPT models and API services",
   "publishConfig": {
     "access": "public"
@@ -36,9 +36,9 @@
   },
   "dependencies": {
     "@aigne/uuid": "^13.0.1",
-    "openai": "^5.20.3",
+    "openai": "^6.5.0",
     "zod": "^3.25.67",
-    "@aigne/core": "^1.64.0",
+    "@aigne/core": "^1.65.0-beta",
     "@aigne/platform-helpers": "^0.6.3"
   },
   "devDependencies": {
@@ -47,7 +47,7 @@
     "npm-run-all": "^4.1.5",
     "rimraf": "^6.0.1",
     "typescript": "^5.9.2",
-    "@aigne/test-utils": "^0.5.56"
+    "@aigne/test-utils": "^0.5.57-beta.1"
   },
   "scripts": {
     "lint": "tsc --noEmit",