feat: add plugin-openai for text generation using OpenAI API (#1234)

Author: 0xrubusdata

packages/plugin-openai/README.md

@@ -0,0 +1,63 @@
+
+# @elizaos/plugin-openai
+
+A plugin for OpenAI integration, providing automated text generation capabilities.
+
+## Overview
+
+This plugin provides functionality to:
+
+- Generate text using OpenAI's GPT models.
+- Customize prompts for context-aware content generation.
+
+## Installation
+
+```bash
+npm install @elizaos/plugin-openai
+```
+
+## Configuration
+
+The plugin requires the following environment variable:
+
+```env
+OPENAI_API_KEY=your_openai_api_key
+```
+
+## Usage
+
+Import and register the plugin in your Eliza configuration:
+
+```typescript
+import { openaiPlugin } from "@elizaos/plugin-openai";
+
+export default {
+    plugins: [openaiPlugin],
+    // ... other configuration
+};
+```
+
+### Generating Text
+
+```typescript
+const result = await generateTextAction.handler(runtime, message, state);
+console.log(result.text); // Output generated by OpenAI
+```
+
+## Development
+
+### Building
+
+```bash
+npm run build
+```
+
+### Testing
+
+```bash
+npm run test
+```
+
+## License
+
+This plugin is part of the Eliza project. See the main project repository for license information.

packages/plugin-openai/package.json

@@ -0,0 +1,36 @@
+
+{
+    "name": "@elizaos/plugin-openai",
+    "version": "0.1.0",
+    "type": "module",
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "import": {
+                "@elizaos/source": "./src/index.ts",
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            }
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "@elizaos/core": "workspace:*",
+        "axios": "^1.0.0"
+    },
+    "devDependencies": {
+        "tsup": "8.3.5",
+        "vitest": "^1.0.0"
+    },
+    "scripts": {
+        "build": "tsup --format esm --dts",
+        "dev": "tsup --format esm --dts --watch",
+        "test": "vitest run",
+        "test:watch": "vitest"
+    }
+}

packages/plugin-openai/src/actions/generateText.ts

@@ -0,0 +1,42 @@
+
+import axios from "axios";
+import { Action } from "@elizaos/core";
+import { OpenAIResponse, OpenAIRequest } from "../types";
+
+export const generateTextAction: Action = {
+    name: "generateText",
+    description: "Generate text using OpenAI",
+    async handler(runtime, message, state) {
+        const prompt = message.content.text || "";
+        const apiKey = process.env.OPENAI_API_KEY;
+
+        if (!apiKey) {
+            throw new Error("OpenAI API key is not set");
+        }
+
+        const requestData: OpenAIRequest = {
+            model: "text-davinci-003",
+            prompt,
+            max_tokens: 200,
+            temperature: 0.7,
+        };
+
+        try {
+            const response = await axios.post<OpenAIResponse>(
+                "https://api.openai.com/v1/completions",
+                requestData,
+                {
+                    headers: {
+                        Authorization: `Bearer ${apiKey}`,
+                        "Content-Type": "application/json",
+                    },
+                }
+            );
+
+            return { text: response.data.choices[0].text.trim() };
+        } catch (error) {
+            console.error("Error communicating with OpenAI API:", error);
+            throw new Error("Failed to generate text with OpenAI");
+        }
+    },
+};

packages/plugin-openai/src/index.ts

@@ -0,0 +1,13 @@
+
+import { Plugin } from "@elizaos/core";
+import { generateTextAction } from "./actions/generateText";
+
+export const openaiPlugin: Plugin = {
+    name: "openai",
+    description: "OpenAI integration plugin for generating text",
+    actions: [generateTextAction],
+    evaluators: [],
+    providers: [],
+};
+
+export default openaiPlugin;

packages/plugin-openai/src/types.ts

@@ -0,0 +1,20 @@
+
+export interface OpenAIRequest {
+    model: string;
+    prompt: string;
+    max_tokens: number;
+    temperature: number;
+}
+
+export interface OpenAIResponse {
+    id: string;
+    object: string;
+    created: number;
+    model: string;
+    choices: Array<{
+        text: string;
+        index: number;
+        logprobs: null | any;
+        finish_reason: string;
+    }>;
+}