Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pedrogritter/ai-gpt-agent
A simple agent to test OpenAI's GPT API
https://github.com/pedrogritter/ai-gpt-agent
Last synced: 3 days ago
JSON representation
A simple agent to test OpenAI's GPT API
- Host: GitHub
- URL: https://github.com/pedrogritter/ai-gpt-agent
- Owner: pedrogritter
- Created: 2024-11-07T16:55:59.000Z (2 months ago)
- Default Branch: master
- Last Pushed: 2024-11-14T21:27:24.000Z (about 2 months ago)
- Last Synced: 2024-11-14T22:26:41.688Z (about 2 months ago)
- Language: TypeScript
- Size: 57.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome_ai_agents - Ai-Gpt-Agent - A simple agent to test OpenAI's GPT API (Building / Testing)
- awesome_ai_agents - Ai-Gpt-Agent - A simple agent to test OpenAI's GPT API (Building / Testing)
README
# AI GPT Agent
A Node.js application that creates an intelligent agent using OpenAI's GPT API with tool-calling capabilities.
## Description
This application creates an AI agent that can:
- Process natural language commands
- Execute specialized tools based on user requests
- Generate and manipulate images
- Tell dad jokes
- Browse Reddit content
- Maintain conversation history
- Handle multi-step tasks automatically
## Features
- 🤖 Integrates with OpenAI's GPT-4 API
- 🛠️ Supports custom tool execution
- 💾 Maintains persistent conversation history in JSON
- 🔄 Handles complex multi-step interactions
- 📝 Includes type safety with TypeScript
- 🎨 Supports DALL-E 3 image generation
## Prerequisites
- Node.js (v18 or higher)
- OpenAI API key
- TypeScript knowledge for development
## Installation
1. Clone this repository:
```bash
git clone https://github.com/pedrogritter/ai-gpt-agent.git
cd ai-gpt-agent
```
2. Install dependencies:
```bash
npm install
```
3. Create a `.env` file in the root directory:
```env
OPENAI_API_KEY=your_api_key_here
```
## Usage
Run the agent with a prompt:
```bash
npm start "Your prompt here"
```
Example prompts:
```bash
npm start "Make a meme image from a random dad joke"
npm start "Tell me a dad joke"
npm start "What would Gandalf say about coding?" # Easter egg! 🧙♂️
```
## Project Structure
```
├── src/
│ ├── agent.ts # Main agent logic
│ ├── ai.ts # OpenAI configuration
│ ├── llm.ts # Language model interface
│ ├── memory.ts # Conversation history using LowDB
│ ├── systemPrompt.ts # System prompt configuration
│ ├── ui.ts # User interface utilities
│ └── tools/ # Custom tool implementations
├── types.ts # TypeScript type definitions
└── index.ts # Application entry point
```
## Development
## Available Tools
- Image Generation: Create images using DALL-E 3
- Reddit: Access Reddit content
- Dad Jokes: Generate dad jokes
- Middle-earth Quotes: Words of wisdom from LOTR characters 🧙♂️
To add new tools:
1. Create a new tool function in `src/tools/`
2. Define the tool's schema using Zod
3. Add the tool to the tools array in `src/tools/index.ts`