@aigne/openai 0.16.16 → 1.74.0-beta

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

@@ -1,92 +0,0 @@
-import { type AgentInvokeOptions, 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 {
-    /**
-     * Sora model to use for video generation
-     *
-     * - `sora-2`: Standard version, lower cost
-     * - `sora-2-pro`: Pro version, higher quality
-     *
-     * @default "sora-2"
-     */
-    model?: "sora-2" | "sora-2-pro";
-    /**
-     * Video resolution (width x height)
-     *
-     * - `720x1280`: Vertical video (9:16)
-     * - `1280x720`: Horizontal video (16:9)
-     * - `1024x1792`: Vertical video (9:16, higher resolution)
-     * - `1792x1024`: Horizontal video (16:9, higher resolution)
-     */
-    size?: "720x1280" | "1280x720" | "1024x1792" | "1792x1024";
-    /**
-     * Video duration in seconds
-     *
-     * @default "4"
-     */
-    seconds?: "4" | "8" | "12";
-}
-/**
- * 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, _options: AgentInvokeOptions): Promise<OpenAIVideoModelOutput>;
-}

package/lib/dts/openai.d.ts

@@ -1,4 +0,0 @@
-import OpenAI, { type APIError } from "openai";
-export declare class CustomOpenAI extends OpenAI {
-    protected makeStatusError(status: number, error: object, message: string | undefined, headers: Headers): APIError;
-}

package/lib/esm/index.d.ts

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

package/lib/esm/index.js

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

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

@@ -1,160 +0,0 @@
-import { type AgentInvokeOptions, type AgentProcessResult, ChatModel, type ChatModelInput, type ChatModelInputMessage, type ChatModelInputTool, type ChatModelOptions, type ChatModelOutput } from "@aigne/core";
-import { type PromiseOrValue } from "@aigne/core/utils/type-utils.js";
-import type { ClientOptions, OpenAI } from "openai";
-import type { ChatCompletionMessageParam, ChatCompletionTool } from "openai/resources";
-import { z } from "zod";
-export interface OpenAIChatModelCapabilities {
-    supportsNativeStructuredOutputs: boolean;
-    supportsEndWithSystemMessage: boolean;
-    supportsToolsUseWithJsonSchema: boolean;
-    supportsParallelToolCalls: boolean;
-    supportsToolsEmptyParameters: boolean;
-    supportsToolStreaming: boolean;
-    supportsTemperature: boolean;
-}
-/**
- * Configuration options for OpenAI Chat Model
- */
-export interface OpenAIChatModelOptions extends ChatModelOptions {
-    /**
-     * 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;
-    /**
-     * Client options for OpenAI API
-     */
-    clientOptions?: Partial<ClientOptions>;
-}
-/**
- * @hidden
- */
-export declare const openAIChatModelOptionsSchema: z.ZodObject<{
-    apiKey: z.ZodOptional<z.ZodString>;
-    baseURL: z.ZodOptional<z.ZodString>;
-    model: z.ZodOptional<z.ZodString>;
-    modelOptions: z.ZodOptional<z.ZodObject<{
-        model: z.ZodOptional<z.ZodString>;
-        temperature: z.ZodOptional<z.ZodNumber>;
-        topP: z.ZodOptional<z.ZodNumber>;
-        frequencyPenalty: z.ZodOptional<z.ZodNumber>;
-        presencePenalty: z.ZodOptional<z.ZodNumber>;
-        parallelToolCalls: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
-    }, "strip", z.ZodTypeAny, {
-        parallelToolCalls: boolean;
-        model?: string | undefined;
-        temperature?: number | undefined;
-        topP?: number | undefined;
-        frequencyPenalty?: number | undefined;
-        presencePenalty?: number | undefined;
-    }, {
-        model?: string | undefined;
-        temperature?: number | undefined;
-        topP?: number | undefined;
-        frequencyPenalty?: number | undefined;
-        presencePenalty?: number | undefined;
-        parallelToolCalls?: boolean | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    model?: string | undefined;
-    apiKey?: string | undefined;
-    baseURL?: string | undefined;
-    modelOptions?: {
-        parallelToolCalls: boolean;
-        model?: string | undefined;
-        temperature?: number | undefined;
-        topP?: number | undefined;
-        frequencyPenalty?: number | undefined;
-        presencePenalty?: number | undefined;
-    } | undefined;
-}, {
-    model?: string | undefined;
-    apiKey?: string | undefined;
-    baseURL?: string | undefined;
-    modelOptions?: {
-        model?: string | undefined;
-        temperature?: number | undefined;
-        topP?: number | undefined;
-        frequencyPenalty?: number | undefined;
-        presencePenalty?: number | undefined;
-        parallelToolCalls?: boolean | undefined;
-    } | undefined;
-}>;
-/**
- * Implementation of the ChatModel interface for OpenAI's API
- *
- * This model provides access to OpenAI's capabilities including:
- * - Text generation
- * - Tool use with parallel tool calls
- * - JSON structured output
- * - Image understanding
- *
- * Default model: 'gpt-4o-mini'
- *
- * @example
- * Here's how to create and use an OpenAI chat model:
- * {@includeCode ../test/openai-chat-model.test.ts#example-openai-chat-model}
- *
- * @example
- * Here's an example with streaming response:
- * {@includeCode ../test/openai-chat-model.test.ts#example-openai-chat-model-stream}
- */
-export declare class OpenAIChatModel extends ChatModel {
-    options?: OpenAIChatModelOptions | undefined;
-    constructor(options?: OpenAIChatModelOptions | undefined);
-    /**
-     * @hidden
-     */
-    protected _client?: OpenAI;
-    protected apiKeyEnvName: string;
-    protected apiKeyDefault: string | undefined;
-    protected supportsNativeStructuredOutputs: boolean;
-    protected supportsToolsUseWithJsonSchema: boolean;
-    protected supportsParallelToolCalls: boolean;
-    protected supportsToolsEmptyParameters: boolean;
-    protected supportsToolStreaming: boolean;
-    protected supportsTemperature: boolean;
-    get client(): OpenAI;
-    get credential(): {
-        url: string | undefined;
-        apiKey: string | undefined;
-        model: string;
-    };
-    /**
-     * Process the input and generate a response
-     * @param input The input to process
-     * @returns The generated response
-     */
-    process(input: ChatModelInput, options: AgentInvokeOptions): PromiseOrValue<AgentProcessResult<ChatModelOutput>>;
-    private getReasoningEffort;
-    private _process;
-    private getParallelToolCalls;
-    protected getRunMessages(input: ChatModelInput): Promise<ChatCompletionMessageParam[]>;
-    private getRunResponseFormat;
-    private requestStructuredOutput;
-    private extractResultFromStream;
-    /**
-     * Controls how optional fields are handled in JSON schema conversion
-     * - "anyOf": All fields are required but can be null (default)
-     * - "optional": Fields marked as optional in schema remain optional
-     */
-    protected optionalFieldMode?: "anyOf" | "optional";
-    protected jsonSchemaToOpenAIJsonSchema(schema: Record<string, unknown>): Record<string, unknown>;
-}
-/**
- * @hidden
- */
-export declare function contentsFromInputMessages(messages: ChatModelInputMessage[]): Promise<ChatCompletionMessageParam[]>;
-/**
- * @hidden
- */
-export declare function toolsFromInputTools(tools?: ChatModelInputTool[], options?: {
-    addTypeToEmptyParameters?: boolean;
-}): ChatCompletionTool[] | undefined;