@elizaos/plugin-openai 1.6.0 → 2.0.0-alpha.2

package/dist/generated/specs/specs.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Auto-generated canonical action/provider/evaluator docs for plugin-openai.
+ * DO NOT EDIT - Generated from prompts/specs/**.
+ */
+export type ActionDoc = {
+    name: string;
+    description: string;
+    similes?: readonly string[];
+    parameters?: readonly unknown[];
+    examples?: readonly (readonly unknown[])[];
+};
+export type ProviderDoc = {
+    name: string;
+    description: string;
+    position?: number;
+    dynamic?: boolean;
+};
+export type EvaluatorDoc = {
+    name: string;
+    description: string;
+    similes?: readonly string[];
+    alwaysRun?: boolean;
+    examples?: readonly unknown[];
+};
+export declare const coreActionsSpec: {
+    readonly version: "1.0.0";
+    readonly actions: readonly [];
+};
+export declare const allActionsSpec: {
+    readonly version: "1.0.0";
+    readonly actions: readonly [];
+};
+export declare const coreProvidersSpec: {
+    readonly version: "1.0.0";
+    readonly providers: readonly [];
+};
+export declare const allProvidersSpec: {
+    readonly version: "1.0.0";
+    readonly providers: readonly [];
+};
+export declare const coreEvaluatorsSpec: {
+    readonly version: "1.0.0";
+    readonly evaluators: readonly [];
+};
+export declare const allEvaluatorsSpec: {
+    readonly version: "1.0.0";
+    readonly evaluators: readonly [];
+};
+export declare const coreActionDocs: readonly ActionDoc[];
+export declare const allActionDocs: readonly ActionDoc[];
+export declare const coreProviderDocs: readonly ProviderDoc[];
+export declare const allProviderDocs: readonly ProviderDoc[];
+export declare const coreEvaluatorDocs: readonly EvaluatorDoc[];
+export declare const allEvaluatorDocs: readonly EvaluatorDoc[];
+//# sourceMappingURL=specs.d.ts.map

package/dist/generated/specs/specs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"specs.d.ts","sourceRoot":"","sources":["../../../generated/specs/specs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,UAAU,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;IAChC,QAAQ,CAAC,EAAE,SAAS,CAAC,SAAS,OAAO,EAAE,CAAC,EAAE,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,SAAS,OAAO,EAAE,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,eAAe;;;CAGlB,CAAC;AACX,eAAO,MAAM,cAAc;;;CAGjB,CAAC;AACX,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AACX,eAAO,MAAM,gBAAgB;;;CAGnB,CAAC;AACX,eAAO,MAAM,kBAAkB;;;CAGrB,CAAC;AACX,eAAO,MAAM,iBAAiB;;;CAGpB,CAAC;AAEX,eAAO,MAAM,cAAc,EAAE,SAAS,SAAS,EAA4B,CAAC;AAC5E,eAAO,MAAM,aAAa,EAAE,SAAS,SAAS,EAA2B,CAAC;AAC1E,eAAO,MAAM,gBAAgB,EAAE,SAAS,WAAW,EAAgC,CAAC;AACpF,eAAO,MAAM,eAAe,EAAE,SAAS,WAAW,EAA+B,CAAC;AAClF,eAAO,MAAM,iBAAiB,EAAE,SAAS,YAAY,EAAkC,CAAC;AACxF,eAAO,MAAM,gBAAgB,EAAE,SAAS,YAAY,EAAiC,CAAC"}

package/dist/index.browser.d.ts

@@ -1,2 +1,3 @@
 export * from "./index";
 export { default } from "./index";
+//# sourceMappingURL=index.browser.d.ts.map

package/dist/index.browser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.browser.d.ts","sourceRoot":"","sources":["../index.browser.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.d.ts

@@ -1,8 +1,4 @@
 import type { Plugin } from "@elizaos/core";
-export * from "./types";
-/**
- * Defines the OpenAI plugin with its name, description, and configuration options.
- * @type {Plugin}
- */
 export declare const openaiPlugin: Plugin;
 export default openaiPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAUV,MAAM,EAKP,MAAM,eAAe,CAAC;AA+BvB,eAAO,MAAM,YAAY,EAAE,MAsU1B,CAAC;AAEF,eAAe,YAAY,CAAC"}

package/dist/index.node.d.ts

@@ -1,2 +1,3 @@
 export * from "./index";
 export { default } from "./index";
+//# sourceMappingURL=index.node.d.ts.map

package/dist/index.node.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.node.d.ts","sourceRoot":"","sources":["../index.node.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAC;AACxB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}

package/dist/init.d.ts

@@ -1,5 +1,4 @@
-import { type IAgentRuntime } from "@elizaos/core";
-/**
- * Initialize and validate OpenAI configuration
- */
-export declare function initializeOpenAI(_config: any, runtime: IAgentRuntime): void;
+import type { IAgentRuntime } from "@elizaos/core";
+import type { OpenAIPluginConfig } from "./types";
+export declare function initializeOpenAI(_config: OpenAIPluginConfig | undefined, runtime: IAgentRuntime): void;
+//# sourceMappingURL=init.d.ts.map

package/dist/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../init.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAKlD,wBAAgB,gBAAgB,CAC9B,OAAO,EAAE,kBAAkB,GAAG,SAAS,EACvC,OAAO,EAAE,aAAa,GACrB,IAAI,CAEN"}

package/dist/models/audio.d.ts

@@ -1,10 +1,9 @@
-import type { IAgentRuntime } from "@elizaos/core";
-import type { OpenAITranscriptionParams, OpenAITextToSpeechParams } from "../types";
-/**
- * TRANSCRIPTION model handler
- */
-export declare function handleTranscription(runtime: IAgentRuntime, input: Blob | File | Buffer | OpenAITranscriptionParams): Promise<string>;
-/**
- * TEXT_TO_SPEECH model handler
- */
-export declare function handleTextToSpeech(runtime: IAgentRuntime, input: string | OpenAITextToSpeechParams): Promise<ArrayBuffer>;
+import type { TextToSpeechParams as CoreTextToSpeechParams, TranscriptionParams as CoreTranscriptionParams, IAgentRuntime } from "@elizaos/core";
+import type { TextToSpeechParams as LocalTextToSpeechParams, TranscriptionParams as LocalTranscriptionParams } from "../types";
+type AudioInput = Blob | File | Buffer;
+type TranscriptionInput = AudioInput | LocalTranscriptionParams | CoreTranscriptionParams | string;
+type TTSInput = string | LocalTextToSpeechParams | CoreTextToSpeechParams;
+export declare function handleTranscription(runtime: IAgentRuntime, input: TranscriptionInput): Promise<string>;
+export declare function handleTextToSpeech(runtime: IAgentRuntime, input: TTSInput): Promise<ArrayBuffer>;
+export {};
+//# sourceMappingURL=audio.d.ts.map

package/dist/models/audio.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"audio.d.ts","sourceRoot":"","sources":["../../models/audio.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,kBAAkB,IAAI,sBAAsB,EAC5C,mBAAmB,IAAI,uBAAuB,EAC9C,aAAa,EACd,MAAM,eAAe,CAAC;AAEvB,OAAO,KAAK,EACV,kBAAkB,IAAI,uBAAuB,EAC7C,mBAAmB,IAAI,wBAAwB,EAIhD,MAAM,UAAU,CAAC;AAWlB,KAAK,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC;AACvC,KAAK,kBAAkB,GAAG,UAAU,GAAG,wBAAwB,GAAG,uBAAuB,GAAG,MAAM,CAAC;AACnG,KAAK,QAAQ,GAAG,MAAM,GAAG,uBAAuB,GAAG,sBAAsB,CAAC;AAoC1E,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,kBAAkB,GACxB,OAAO,CAAC,MAAM,CAAC,CAqFjB;AAED,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,aAAa,EACtB,KAAK,EAAE,QAAQ,GACd,OAAO,CAAC,WAAW,CAAC,CAwEtB"}

package/dist/models/embedding.d.ts

@@ -1,5 +1,3 @@
 import type { IAgentRuntime, TextEmbeddingParams } from "@elizaos/core";
-/**
- * TEXT_EMBEDDING model handler
- */
 export declare function handleTextEmbedding(runtime: IAgentRuntime, params: TextEmbeddingParams | string | null): Promise<number[]>;
+//# sourceMappingURL=embedding.d.ts.map

package/dist/models/embedding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"embedding.d.ts","sourceRoot":"","sources":["../../models/embedding.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAoCxE,wBAAsB,mBAAmB,CACvC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI,GAC1C,OAAO,CAAC,MAAM,EAAE,CAAC,CAmEnB"}

package/dist/models/image.d.ts

@@ -1,14 +1,5 @@
 import type { IAgentRuntime, ImageDescriptionParams, ImageGenerationParams } from "@elizaos/core";
-/**
- * IMAGE generation model handler
- */
-export declare function handleImageGeneration(runtime: IAgentRuntime, params: ImageGenerationParams): Promise<{
-    url: string;
-}[]>;
-/**
- * IMAGE_DESCRIPTION model handler
- */
-export declare function handleImageDescription(runtime: IAgentRuntime, params: ImageDescriptionParams | string): Promise<{
-    title: string;
-    description: string;
-}>;
+import type { ImageDescriptionResult, ImageGenerationResult } from "../types";
+export declare function handleImageGeneration(runtime: IAgentRuntime, params: ImageGenerationParams): Promise<ImageGenerationResult[]>;
+export declare function handleImageDescription(runtime: IAgentRuntime, params: ImageDescriptionParams | string): Promise<ImageDescriptionResult>;
+//# sourceMappingURL=image.d.ts.map

package/dist/models/image.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image.d.ts","sourceRoot":"","sources":["../../models/image.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AAElG,OAAO,KAAK,EACV,sBAAsB,EACtB,qBAAqB,EAMtB,MAAM,UAAU,CAAC;AAkBlB,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,qBAAqB,EAAE,CAAC,CA0DlC;AAWD,wBAAsB,sBAAsB,CAC1C,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,sBAAsB,GAAG,MAAM,GACtC,OAAO,CAAC,sBAAsB,CAAC,CA+EjC"}

package/dist/models/index.d.ts

@@ -1,6 +1,8 @@
-export { handleTextSmall, handleTextLarge } from "./text";
+export { handleTextToSpeech, handleTranscription } from "./audio";
 export { handleTextEmbedding } from "./embedding";
-export { handleImageGeneration, handleImageDescription } from "./image";
-export { handleTranscription, handleTextToSpeech } from "./audio";
-export { handleObjectSmall, handleObjectLarge } from "./object";
-export { handleTokenizerEncode, handleTokenizerDecode } from "./tokenizer";
+export { handleImageDescription, handleImageGeneration } from "./image";
+export { handleObjectLarge, handleObjectSmall } from "./object";
+export { handleResearch } from "./research";
+export { handleTextLarge, handleTextSmall } from "./text";
+export { handleTokenizerDecode, handleTokenizerEncode } from "./tokenizer";
+//# sourceMappingURL=index.d.ts.map

package/dist/models/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../models/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAC;AACxE,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAChE,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5C,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,QAAQ,CAAC;AAC1D,OAAO,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC"}

package/dist/models/object.d.ts

@@ -1,9 +1,4 @@
-import type { IAgentRuntime, ObjectGenerationParams } from "@elizaos/core";
-/**
- * OBJECT_SMALL model handler
- */
-export declare function handleObjectSmall(runtime: IAgentRuntime, params: ObjectGenerationParams): Promise<Record<string, unknown>>;
-/**
- * OBJECT_LARGE model handler
- */
-export declare function handleObjectLarge(runtime: IAgentRuntime, params: ObjectGenerationParams): Promise<Record<string, unknown>>;
+import type { IAgentRuntime, JsonValue, ObjectGenerationParams } from "@elizaos/core";
+export declare function handleObjectSmall(runtime: IAgentRuntime, params: ObjectGenerationParams): Promise<Record<string, JsonValue>>;
+export declare function handleObjectLarge(runtime: IAgentRuntime, params: ObjectGenerationParams): Promise<Record<string, JsonValue>>;
+//# sourceMappingURL=object.d.ts.map

package/dist/models/object.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object.d.ts","sourceRoot":"","sources":["../../models/object.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EAET,sBAAsB,EACvB,MAAM,eAAe,CAAC;AAoDvB,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAEpC;AAED,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,sBAAsB,GAC7B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAEpC"}

package/dist/models/research.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Deep Research model handler
+ *
+ * Provides deep research capabilities using OpenAI's o3-deep-research and o4-mini-deep-research models.
+ * These models can find, analyze, and synthesize hundreds of sources to create comprehensive reports.
+ *
+ * @see https://platform.openai.com/docs/guides/deep-research
+ */
+import type { IAgentRuntime, ResearchParams, ResearchResult } from "@elizaos/core";
+/**
+ * Handles RESEARCH model requests using OpenAI's deep research models.
+ *
+ * Deep research models can take tens of minutes to complete tasks.
+ * Use background mode for long-running tasks.
+ *
+ * @param runtime - The agent runtime
+ * @param params - Research parameters
+ * @returns Research result with text, annotations, and output items
+ *
+ * @example
+ * ```typescript
+ * const result = await handleResearch(runtime, {
+ *   input: "Research the economic impact of AI on global labor markets",
+ *   tools: [
+ *     { type: "web_search_preview" },
+ *     { type: "code_interpreter", container: { type: "auto" } }
+ *   ],
+ *   background: true,
+ * });
+ * console.log(result.text);
+ * ```
+ */
+export declare function handleResearch(runtime: IAgentRuntime, params: ResearchParams): Promise<ResearchResult>;
+//# sourceMappingURL=research.d.ts.map

package/dist/models/research.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"research.d.ts","sourceRoot":"","sources":["../../models/research.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EACV,aAAa,EAQb,cAAc,EACd,cAAc,EAGf,MAAM,eAAe,CAAC;AAgPvB;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAsB,cAAc,CAClC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,cAAc,GACrB,OAAO,CAAC,cAAc,CAAC,CA2GzB"}

package/dist/models/text.d.ts

@@ -1,9 +1,28 @@
-import type { GenerateTextParams, IAgentRuntime, TextStreamResult } from "@elizaos/core";
 /**
- * TEXT_SMALL model handler
+ * Text generation model handlers
+ *
+ * Provides text generation using OpenAI's language models.
+ */
+import type { GenerateTextParams, IAgentRuntime } from "@elizaos/core";
+import type { TextStreamResult } from "../types";
+/**
+ * Handles TEXT_SMALL model requests.
+ *
+ * Uses the configured small model (default: gpt-5-mini).
+ *
+ * @param runtime - The agent runtime
+ * @param params - Generation parameters
+ * @returns Generated text or stream result
  */
 export declare function handleTextSmall(runtime: IAgentRuntime, params: GenerateTextParams): Promise<string | TextStreamResult>;
 /**
- * TEXT_LARGE model handler
+ * Handles TEXT_LARGE model requests.
+ *
+ * Uses the configured large model (default: gpt-5).
+ *
+ * @param runtime - The agent runtime
+ * @param params - Generation parameters
+ * @returns Generated text or stream result
  */
 export declare function handleTextLarge(runtime: IAgentRuntime, params: GenerateTextParams): Promise<string | TextStreamResult>;
+//# sourceMappingURL=text.d.ts.map

package/dist/models/text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../models/text.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,kBAAkB,EAAE,aAAa,EAAiB,MAAM,eAAe,CAAC;AAItF,OAAO,KAAK,EAAE,gBAAgB,EAAc,MAAM,UAAU,CAAC;AAqG7D;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,MAAM,GAAG,gBAAgB,CAAC,CAEpC;AAED;;;;;;;;GAQG;AACH,wBAAsB,eAAe,CACnC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,MAAM,GAAG,gBAAgB,CAAC,CAEpC"}

package/dist/models/tokenizer.d.ts

@@ -1,9 +1,4 @@
-import type { IAgentRuntime, TokenizeTextParams, DetokenizeTextParams } from "@elizaos/core";
-/**
- * TEXT_TOKENIZER_ENCODE model handler
- */
-export declare function handleTokenizerEncode(runtime: IAgentRuntime, { prompt, modelType }: TokenizeTextParams): Promise<number[]>;
-/**
- * TEXT_TOKENIZER_DECODE model handler
- */
-export declare function handleTokenizerDecode(runtime: IAgentRuntime, { tokens, modelType }: DetokenizeTextParams): Promise<string>;
+import type { DetokenizeTextParams, IAgentRuntime, TokenizeTextParams } from "@elizaos/core";
+export declare function handleTokenizerEncode(runtime: IAgentRuntime, params: TokenizeTextParams): Promise<number[]>;
+export declare function handleTokenizerDecode(runtime: IAgentRuntime, params: DetokenizeTextParams): Promise<string>;
+//# sourceMappingURL=tokenizer.d.ts.map

package/dist/models/tokenizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokenizer.d.ts","sourceRoot":"","sources":["../../models/tokenizer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AAI7F,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,kBAAkB,GACzB,OAAO,CAAC,MAAM,EAAE,CAAC,CAMnB;AAED,wBAAsB,qBAAqB,CACzC,OAAO,EAAE,aAAa,EACtB,MAAM,EAAE,oBAAoB,GAC3B,OAAO,CAAC,MAAM,CAAC,CAejB"}