@elizaos/plugin-groq 2.0.0-alpha.8 → 2.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shaw Walters and elizaOS Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,75 @@
+# @elizaos/plugin-groq
+
+Groq LLM plugin for elizaOS - Fast inference with GPT-OSS models.
+
+This plugin provides Groq API integration for elizaOS agents, enabling ultra-fast text generation, audio transcription, and text-to-speech synthesis.
+
+## Features
+
+- 🚀 **Fast Inference** - Leverage Groq's LPU for industry-leading inference speeds
+- 📝 **Text Generation** - Generate text with GPT-OSS models
+- 🎤 **Audio Transcription** - Transcribe audio with Whisper models
+- 🔊 **Text-to-Speech** - Generate speech with PlayAI voices
+- 🔢 **Object Generation** - Generate structured JSON objects
+- 🎯 **Tokenization** - Tokenize and detokenize text
+
+## Installation
+
+### TypeScript/JavaScript (npm)
+
+```bash
+npm install @elizaos/plugin-groq
+# or
+bun add @elizaos/plugin-groq
+```
+## Usage
+
+### TypeScript
+
+```typescript
+import { groqPlugin } from "@elizaos/plugin-groq";
+
+// Add to your agent's plugins
+const agent = new Agent({
+  plugins: [groqPlugin],
+});
+```
+## Configuration
+
+Set the following environment variables:
+
+| Variable           | Required | Default                          | Description           |
+| ------------------ | -------- | -------------------------------- | --------------------- |
+| `GROQ_API_KEY`     | Yes      | -                                | Your Groq API key     |
+| `GROQ_BASE_URL`    | No       | `https://api.groq.com/openai/v1` | Custom API base URL   |
+| `GROQ_SMALL_MODEL` | No       | `openai/gpt-oss-120b`           | Model for small tasks |
+| `GROQ_LARGE_MODEL` | No       | `openai/gpt-oss-120b`            | Model for large tasks |
+| `GROQ_TTS_MODEL`   | No       | `canopylabs/orpheus-v1-english`  | Text-to-speech model  |
+| `GROQ_TTS_VOICE`   | No       | `troy`                           | TTS voice name        |
+| `GROQ_TTS_RESPONSE_FORMAT` | No | `wav`                          | TTS response format   |
+
+## Model Capabilities
+
+This plugin provides handlers for the following elizaOS model types:
+
+| Model Type              | Description                                     |
+| ----------------------- | ----------------------------------------------- |
+| `TEXT_SMALL`            | Fast text + structured output via native tool calling (tools, toolChoice, responseSchema) |
+| `TEXT_LARGE`            | Capable text + structured output via native tool calling (tools, toolChoice, responseSchema) |
+| `TRANSCRIPTION`         | Audio transcription with Whisper                |
+| `TEXT_TO_SPEECH`        | Speech synthesis with PlayAI                    |
+| `TEXT_TOKENIZER_ENCODE` | Tokenize text to tokens                         |
+| `TEXT_TOKENIZER_DECODE` | Detokenize tokens to text                       |
+
+## Development
+
+### Building from Source
+
+```bash
+# TypeScript
+bun install
+bun run build
+# TypeScript
+bun run test
+# TypeScript
+bun run format:check

package/auto-enable.ts

@@ -0,0 +1,17 @@
+// Auto-enable check for @elizaos/plugin-groq.
+//
+// Plugin manifest entry-point — referenced by package.json's
+// `elizaos.plugin.autoEnableModule`. Keep this module light: env reads only,
+// no service init, no transitive imports of the full plugin runtime. The
+// auto-enable engine loads dozens of these per boot.
+import type { PluginAutoEnableContext } from "@elizaos/core";
+
+const ENV_KEYS = ["GROQ_API_KEY"] as const;
+
+/** Enable when a Groq API key is present. */
+export function shouldEnable(ctx: PluginAutoEnableContext): boolean {
+  return ENV_KEYS.some((k) => {
+    const v = ctx.env[k];
+    return typeof v === "string" && v.trim() !== "";
+  });
+}