@aigne/openai 1.74.0-beta.7 → 1.74.0-beta.9

package/dist/index.cjs

@@ -1,8 +1,10 @@
 const require_openai_chat_model = require('./openai-chat-model.cjs');
+const require_openai_embedding_model = require('./openai-embedding-model.cjs');
 const require_openai_image_model = require('./openai-image-model.cjs');
 const require_openai_video_model = require('./openai-video-model.cjs');
 
 exports.OpenAIChatModel = require_openai_chat_model.OpenAIChatModel;
+exports.OpenAIEmbeddingModel = require_openai_embedding_model.OpenAIEmbeddingModel;
 exports.OpenAIImageModel = require_openai_image_model.OpenAIImageModel;
 exports.OpenAIVideoModel = require_openai_video_model.OpenAIVideoModel;
 exports.contentsFromInputMessages = require_openai_chat_model.contentsFromInputMessages;

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { OpenAIChatModel, OpenAIChatModelCapabilities, OpenAIChatModelOptions, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools } from "./openai-chat-model.cjs";
+import { OpenAIEmbeddingModel, OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOptions, OpenAIEmbeddingModelOutput } from "./openai-embedding-model.cjs";
 import { OpenAIImageModel, OpenAIImageModelInput, OpenAIImageModelOptions, OpenAIImageModelOutput } from "./openai-image-model.cjs";
 import { OpenAIVideoModel, OpenAIVideoModelInput, OpenAIVideoModelOptions, OpenAIVideoModelOutput } from "./openai-video-model.cjs";
-export { OpenAIChatModel, OpenAIChatModelCapabilities, OpenAIChatModelOptions, OpenAIImageModel, OpenAIImageModelInput, OpenAIImageModelOptions, OpenAIImageModelOutput, OpenAIVideoModel, OpenAIVideoModelInput, OpenAIVideoModelOptions, OpenAIVideoModelOutput, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools };
+export { OpenAIChatModel, OpenAIChatModelCapabilities, OpenAIChatModelOptions, OpenAIEmbeddingModel, OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOptions, OpenAIEmbeddingModelOutput, OpenAIImageModel, OpenAIImageModelInput, OpenAIImageModelOptions, OpenAIImageModelOutput, OpenAIVideoModel, OpenAIVideoModelInput, OpenAIVideoModelOptions, OpenAIVideoModelOutput, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools };

package/dist/index.d.mts

@@ -1,4 +1,5 @@
 import { OpenAIChatModel, OpenAIChatModelCapabilities, OpenAIChatModelOptions, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools } from "./openai-chat-model.mjs";
+import { OpenAIEmbeddingModel, OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOptions, OpenAIEmbeddingModelOutput } from "./openai-embedding-model.mjs";
 import { OpenAIImageModel, OpenAIImageModelInput, OpenAIImageModelOptions, OpenAIImageModelOutput } from "./openai-image-model.mjs";
 import { OpenAIVideoModel, OpenAIVideoModelInput, OpenAIVideoModelOptions, OpenAIVideoModelOutput } from "./openai-video-model.mjs";
-export { OpenAIChatModel, OpenAIChatModelCapabilities, OpenAIChatModelOptions, OpenAIImageModel, OpenAIImageModelInput, OpenAIImageModelOptions, OpenAIImageModelOutput, OpenAIVideoModel, OpenAIVideoModelInput, OpenAIVideoModelOptions, OpenAIVideoModelOutput, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools };
+export { OpenAIChatModel, OpenAIChatModelCapabilities, OpenAIChatModelOptions, OpenAIEmbeddingModel, OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOptions, OpenAIEmbeddingModelOutput, OpenAIImageModel, OpenAIImageModelInput, OpenAIImageModelOptions, OpenAIImageModelOutput, OpenAIVideoModel, OpenAIVideoModelInput, OpenAIVideoModelOptions, OpenAIVideoModelOutput, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools };

package/dist/index.mjs

@@ -1,5 +1,6 @@
 import { OpenAIChatModel, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools } from "./openai-chat-model.mjs";
+import { OpenAIEmbeddingModel } from "./openai-embedding-model.mjs";
 import { OpenAIImageModel } from "./openai-image-model.mjs";
 import { OpenAIVideoModel } from "./openai-video-model.mjs";
 
-export { OpenAIChatModel, OpenAIImageModel, OpenAIVideoModel, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools };
+export { OpenAIChatModel, OpenAIEmbeddingModel, OpenAIImageModel, OpenAIVideoModel, contentsFromInputMessages, openAIChatModelOptionsSchema, toolsFromInputTools };

package/dist/openai-embedding-model.cjs

@@ -0,0 +1,68 @@
+const require_rolldown_runtime = require('./_virtual/rolldown_runtime.cjs');
+const require_openai = require('./openai.cjs');
+let _aigne_model_base = require("@aigne/model-base");
+let _aigne_model_base_utils_type_utils = require("@aigne/model-base/utils/type-utils");
+let zod = require("zod");
+
+//#region src/openai-embedding-model.ts
+const DEFAULT_MODEL = "text-embedding-3-small";
+const openAIEmbeddingModelInputSchema = _aigne_model_base.embeddingModelInputSchema.extend({});
+const openAIEmbeddingModelOptionsSchema = zod.z.object({
+	apiKey: zod.z.string().optional(),
+	baseURL: zod.z.string().optional(),
+	model: zod.z.string().optional(),
+	modelOptions: zod.z.object({}).optional(),
+	clientOptions: zod.z.object({}).optional()
+});
+var OpenAIEmbeddingModel = class extends _aigne_model_base.EmbeddingModel {
+	constructor(options) {
+		super({
+			...options,
+			inputSchema: openAIEmbeddingModelInputSchema,
+			description: options?.description ?? "Generate embeddings by OpenAI embedding models"
+		});
+		this.options = options;
+		if (options) (0, _aigne_model_base_utils_type_utils.checkArguments)(this.name, openAIEmbeddingModelOptionsSchema, options);
+	}
+	_client;
+	apiKeyEnvName = "OPENAI_API_KEY";
+	get client() {
+		if (this._client) return this._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 require_openai.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
+		};
+	}
+	async process(input, _options) {
+		const model = input.modelOptions?.model || this.credential.model;
+		const body = {
+			input: input.input,
+			model,
+			...input.dimensions ? { dimensions: input.dimensions } : {},
+			...input.modelOptions?.encoding_format ? { encoding_format: input.modelOptions.encoding_format } : {}
+		};
+		const response = await this.client.embeddings.create(body);
+		return {
+			embeddings: response.data.map((item) => item.embedding),
+			usage: {
+				inputTokens: response.usage?.prompt_tokens ?? 0,
+				outputTokens: 0
+			},
+			model: response.model
+		};
+	}
+};
+
+//#endregion
+exports.OpenAIEmbeddingModel = OpenAIEmbeddingModel;

package/dist/openai-embedding-model.d.cts

@@ -0,0 +1,28 @@
+import { EmbeddingModel, EmbeddingModelInput, EmbeddingModelOptions, EmbeddingModelOutput, ModelInvokeOptions } from "@aigne/model-base";
+import OpenAI, { ClientOptions } from "openai";
+
+//#region src/openai-embedding-model.d.ts
+interface OpenAIEmbeddingModelInput extends EmbeddingModelInput {}
+interface OpenAIEmbeddingModelOutput extends EmbeddingModelOutput {}
+interface OpenAIEmbeddingModelOptions extends EmbeddingModelOptions<OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOutput> {
+  apiKey?: string;
+  baseURL?: string;
+  model?: string;
+  clientOptions?: Partial<ClientOptions>;
+}
+declare class OpenAIEmbeddingModel extends EmbeddingModel<OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOutput> {
+  options?: OpenAIEmbeddingModelOptions | undefined;
+  constructor(options?: OpenAIEmbeddingModelOptions | undefined);
+  protected _client?: OpenAI;
+  protected apiKeyEnvName: string;
+  get client(): OpenAI;
+  get credential(): {
+    url: string | undefined;
+    apiKey: string | undefined;
+    model: string;
+  };
+  process(input: OpenAIEmbeddingModelInput, _options: ModelInvokeOptions): Promise<OpenAIEmbeddingModelOutput>;
+}
+//#endregion
+export { OpenAIEmbeddingModel, OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOptions, OpenAIEmbeddingModelOutput };
+//# sourceMappingURL=openai-embedding-model.d.cts.map

package/dist/openai-embedding-model.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-embedding-model.d.cts","names":[],"sources":["../src/openai-embedding-model.ts"],"mappings":";;;;UAgBiB,yBAAA,SAAkC,mBAAA;AAAA,UAElC,0BAAA,SAAmC,oBAAA;AAAA,UAEnC,2BAAA,SACP,qBAAA,CAAsB,yBAAA,EAA2B,0BAAA;EACzD,MAAA;EACA,OAAA;EACA,KAAA;EACA,aAAA,GAAgB,OAAA,CAAQ,aAAA;AAAA;AAAA,cAab,oBAAA,SAA6B,cAAA,CACxC,yBAAA,EACA,0BAAA;EAE4B,OAAA,GAAU,2BAAA;cAAV,OAAA,GAAU,2BAAA;EAAA,UAS5B,OAAA,GAAU,MAAA;EAAA,UAEV,aAAA;EAAA,IAEN,MAAA,CAAA,GAAM,MAAA;EAAA,IAmBG,UAAA,CAAA;;;;;EAQE,OAAA,CACb,KAAA,EAAO,yBAAA,EACP,QAAA,EAAU,kBAAA,GACT,OAAA,CAAQ,0BAAA;AAAA"}

package/dist/openai-embedding-model.d.mts

@@ -0,0 +1,28 @@
+import { EmbeddingModel, EmbeddingModelInput, EmbeddingModelOptions, EmbeddingModelOutput, ModelInvokeOptions } from "@aigne/model-base";
+import OpenAI, { ClientOptions } from "openai";
+
+//#region src/openai-embedding-model.d.ts
+interface OpenAIEmbeddingModelInput extends EmbeddingModelInput {}
+interface OpenAIEmbeddingModelOutput extends EmbeddingModelOutput {}
+interface OpenAIEmbeddingModelOptions extends EmbeddingModelOptions<OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOutput> {
+  apiKey?: string;
+  baseURL?: string;
+  model?: string;
+  clientOptions?: Partial<ClientOptions>;
+}
+declare class OpenAIEmbeddingModel extends EmbeddingModel<OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOutput> {
+  options?: OpenAIEmbeddingModelOptions | undefined;
+  constructor(options?: OpenAIEmbeddingModelOptions | undefined);
+  protected _client?: OpenAI;
+  protected apiKeyEnvName: string;
+  get client(): OpenAI;
+  get credential(): {
+    url: string | undefined;
+    apiKey: string | undefined;
+    model: string;
+  };
+  process(input: OpenAIEmbeddingModelInput, _options: ModelInvokeOptions): Promise<OpenAIEmbeddingModelOutput>;
+}
+//#endregion
+export { OpenAIEmbeddingModel, OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOptions, OpenAIEmbeddingModelOutput };
+//# sourceMappingURL=openai-embedding-model.d.mts.map

package/dist/openai-embedding-model.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-embedding-model.d.mts","names":[],"sources":["../src/openai-embedding-model.ts"],"mappings":";;;;UAgBiB,yBAAA,SAAkC,mBAAA;AAAA,UAElC,0BAAA,SAAmC,oBAAA;AAAA,UAEnC,2BAAA,SACP,qBAAA,CAAsB,yBAAA,EAA2B,0BAAA;EACzD,MAAA;EACA,OAAA;EACA,KAAA;EACA,aAAA,GAAgB,OAAA,CAAQ,aAAA;AAAA;AAAA,cAab,oBAAA,SAA6B,cAAA,CACxC,yBAAA,EACA,0BAAA;EAE4B,OAAA,GAAU,2BAAA;cAAV,OAAA,GAAU,2BAAA;EAAA,UAS5B,OAAA,GAAU,MAAA;EAAA,UAEV,aAAA;EAAA,IAEN,MAAA,CAAA,GAAM,MAAA;EAAA,IAmBG,UAAA,CAAA;;;;;EAQE,OAAA,CACb,KAAA,EAAO,yBAAA,EACP,QAAA,EAAU,kBAAA,GACT,OAAA,CAAQ,0BAAA;AAAA"}

package/dist/openai-embedding-model.mjs

@@ -0,0 +1,68 @@
+import { CustomOpenAI } from "./openai.mjs";
+import { EmbeddingModel, embeddingModelInputSchema } from "@aigne/model-base";
+import { checkArguments } from "@aigne/model-base/utils/type-utils";
+import { z } from "zod";
+
+//#region src/openai-embedding-model.ts
+const DEFAULT_MODEL = "text-embedding-3-small";
+const openAIEmbeddingModelInputSchema = embeddingModelInputSchema.extend({});
+const openAIEmbeddingModelOptionsSchema = z.object({
+	apiKey: z.string().optional(),
+	baseURL: z.string().optional(),
+	model: z.string().optional(),
+	modelOptions: z.object({}).optional(),
+	clientOptions: z.object({}).optional()
+});
+var OpenAIEmbeddingModel = class extends EmbeddingModel {
+	constructor(options) {
+		super({
+			...options,
+			inputSchema: openAIEmbeddingModelInputSchema,
+			description: options?.description ?? "Generate embeddings by OpenAI embedding models"
+		});
+		this.options = options;
+		if (options) checkArguments(this.name, openAIEmbeddingModelOptionsSchema, options);
+	}
+	_client;
+	apiKeyEnvName = "OPENAI_API_KEY";
+	get client() {
+		if (this._client) return this._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
+		};
+	}
+	async process(input, _options) {
+		const model = input.modelOptions?.model || this.credential.model;
+		const body = {
+			input: input.input,
+			model,
+			...input.dimensions ? { dimensions: input.dimensions } : {},
+			...input.modelOptions?.encoding_format ? { encoding_format: input.modelOptions.encoding_format } : {}
+		};
+		const response = await this.client.embeddings.create(body);
+		return {
+			embeddings: response.data.map((item) => item.embedding),
+			usage: {
+				inputTokens: response.usage?.prompt_tokens ?? 0,
+				outputTokens: 0
+			},
+			model: response.model
+		};
+	}
+};
+
+//#endregion
+export { OpenAIEmbeddingModel };
+//# sourceMappingURL=openai-embedding-model.mjs.map

package/dist/openai-embedding-model.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-embedding-model.mjs","names":[],"sources":["../src/openai-embedding-model.ts"],"sourcesContent":["import {\n  EmbeddingModel,\n  type EmbeddingModelInput,\n  type EmbeddingModelOptions,\n  type EmbeddingModelOutput,\n  embeddingModelInputSchema,\n  type ModelInvokeOptions,\n} from \"@aigne/model-base\";\nimport { checkArguments } from \"@aigne/model-base/utils/type-utils\";\nimport type OpenAI from \"openai\";\nimport type { ClientOptions } from \"openai\";\nimport { z } from \"zod\";\nimport { CustomOpenAI } from \"./openai.js\";\n\nconst DEFAULT_MODEL = \"text-embedding-3-small\";\n\nexport interface OpenAIEmbeddingModelInput extends EmbeddingModelInput {}\n\nexport interface OpenAIEmbeddingModelOutput extends EmbeddingModelOutput {}\n\nexport interface OpenAIEmbeddingModelOptions\n  extends EmbeddingModelOptions<OpenAIEmbeddingModelInput, OpenAIEmbeddingModelOutput> {\n  apiKey?: string;\n  baseURL?: string;\n  model?: string;\n  clientOptions?: Partial<ClientOptions>;\n}\n\nconst openAIEmbeddingModelInputSchema = embeddingModelInputSchema.extend({});\n\nconst openAIEmbeddingModelOptionsSchema = z.object({\n  apiKey: z.string().optional(),\n  baseURL: z.string().optional(),\n  model: z.string().optional(),\n  modelOptions: z.object({}).optional(),\n  clientOptions: z.object({}).optional(),\n});\n\nexport class OpenAIEmbeddingModel extends EmbeddingModel<\n  OpenAIEmbeddingModelInput,\n  OpenAIEmbeddingModelOutput\n> {\n  constructor(public override options?: OpenAIEmbeddingModelOptions) {\n    super({\n      ...options,\n      inputSchema: openAIEmbeddingModelInputSchema,\n      description: options?.description ?? \"Generate embeddings by OpenAI embedding models\",\n    });\n    if (options) checkArguments(this.name, openAIEmbeddingModelOptionsSchema, options);\n  }\n\n  protected _client?: OpenAI;\n\n  protected apiKeyEnvName = \"OPENAI_API_KEY\";\n\n  get client() {\n    if (this._client) return this._client;\n\n    const { apiKey, url } = this.credential;\n\n    if (!apiKey)\n      throw new Error(\n        `${this.name} requires an API key. Please provide it via \\`options.apiKey\\`, or set the \\`${this.apiKeyEnvName}\\` environment variable`,\n      );\n\n    this._client ??= new CustomOpenAI({\n      baseURL: url,\n      apiKey,\n      ...this.options?.clientOptions,\n    });\n\n    return this._client;\n  }\n\n  override get credential() {\n    return {\n      url: this.options?.baseURL || process.env.OPENAI_BASE_URL,\n      apiKey: this.options?.apiKey || process.env[this.apiKeyEnvName],\n      model: this.options?.model || DEFAULT_MODEL,\n    };\n  }\n\n  override async process(\n    input: OpenAIEmbeddingModelInput,\n    _options: ModelInvokeOptions,\n  ): Promise<OpenAIEmbeddingModelOutput> {\n    const model = input.modelOptions?.model || this.credential.model;\n\n    const body: OpenAI.EmbeddingCreateParams = {\n      input: input.input,\n      model,\n      ...(input.dimensions ? { dimensions: input.dimensions } : {}),\n      ...(input.modelOptions?.encoding_format\n        ? { encoding_format: input.modelOptions.encoding_format as \"float\" | \"base64\" }\n        : {}),\n    };\n\n    const response = await this.client.embeddings.create(body);\n\n    return {\n      embeddings: response.data.map((item) => item.embedding),\n      usage: {\n        inputTokens: response.usage?.prompt_tokens ?? 0,\n        outputTokens: 0,\n      },\n      model: response.model,\n    };\n  }\n}\n"],"mappings":";;;;;;AAcA,MAAM,gBAAgB;AActB,MAAM,kCAAkC,0BAA0B,OAAO,EAAE,CAAC;AAE5E,MAAM,oCAAoC,EAAE,OAAO;CACjD,QAAQ,EAAE,QAAQ,CAAC,UAAU;CAC7B,SAAS,EAAE,QAAQ,CAAC,UAAU;CAC9B,OAAO,EAAE,QAAQ,CAAC,UAAU;CAC5B,cAAc,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU;CACrC,eAAe,EAAE,OAAO,EAAE,CAAC,CAAC,UAAU;CACvC,CAAC;AAEF,IAAa,uBAAb,cAA0C,eAGxC;CACA,YAAY,AAAgB,SAAuC;AACjE,QAAM;GACJ,GAAG;GACH,aAAa;GACb,aAAa,SAAS,eAAe;GACtC,CAAC;EALwB;AAM1B,MAAI,QAAS,gBAAe,KAAK,MAAM,mCAAmC,QAAQ;;CAGpF,AAAU;CAEV,AAAU,gBAAgB;CAE1B,IAAI,SAAS;AACX,MAAI,KAAK,QAAS,QAAO,KAAK;EAE9B,MAAM,EAAE,QAAQ,QAAQ,KAAK;AAE7B,MAAI,CAAC,OACH,OAAM,IAAI,MACR,GAAG,KAAK,KAAK,+EAA+E,KAAK,cAAc,yBAChH;AAEH,OAAK,YAAY,IAAI,aAAa;GAChC,SAAS;GACT;GACA,GAAG,KAAK,SAAS;GAClB,CAAC;AAEF,SAAO,KAAK;;CAGd,IAAa,aAAa;AACxB,SAAO;GACL,KAAK,KAAK,SAAS,WAAW,QAAQ,IAAI;GAC1C,QAAQ,KAAK,SAAS,UAAU,QAAQ,IAAI,KAAK;GACjD,OAAO,KAAK,SAAS,SAAS;GAC/B;;CAGH,MAAe,QACb,OACA,UACqC;EACrC,MAAM,QAAQ,MAAM,cAAc,SAAS,KAAK,WAAW;EAE3D,MAAM,OAAqC;GACzC,OAAO,MAAM;GACb;GACA,GAAI,MAAM,aAAa,EAAE,YAAY,MAAM,YAAY,GAAG,EAAE;GAC5D,GAAI,MAAM,cAAc,kBACpB,EAAE,iBAAiB,MAAM,aAAa,iBAAuC,GAC7E,EAAE;GACP;EAED,MAAM,WAAW,MAAM,KAAK,OAAO,WAAW,OAAO,KAAK;AAE1D,SAAO;GACL,YAAY,SAAS,KAAK,KAAK,SAAS,KAAK,UAAU;GACvD,OAAO;IACL,aAAa,SAAS,OAAO,iBAAiB;IAC9C,cAAc;IACf;GACD,OAAO,SAAS;GACjB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aigne/openai",
-  "version": "1.74.0-beta.7",
+  "version": "1.74.0-beta.9",
   "description": "AIGNE OpenAI SDK for integrating with OpenAI's GPT models and API services",
   "license": "Elastic-2.0",
   "publishConfig": {
@@ -36,7 +36,7 @@
     "@aigne/uuid": "^13.0.1",
     "openai": "^6.14.0",
     "zod": "^3.25.67",
-    "@aigne/model-base": "^1.74.0-beta.7"
+    "@aigne/model-base": "^1.74.0-beta.9"
   },
   "devDependencies": {
     "@types/bun": "^1.3.6",