Skip to content

aligajani/agentic-demos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Agentic Demos

A collection of AI agent demonstrations using the OpenAI Agents framework. This repository showcases different types of AI agents working together to solve various tasks.

🚀 Features

  • Multi-Agent System: Multiple specialized agents working together
  • History Tutor Agent: Provides assistance with historical queries and context
  • Math Tutor Agent: Helps with mathematical problems with step-by-step explanations
  • Weather Agent: Real-time weather information for any location worldwide
  • Triage Agent: Intelligently routes queries to the appropriate specialist agent

📋 Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • OpenAI API key

🛠️ Setup

  1. Clone the repository

    git clone https://github.com/yourusername/agentic-demos.git
    cd agentic-demos
  2. Install dependencies

    npm install
  3. Configure your OpenAI API key

    Create a .env.local file in the project root with your OpenAI API keys:

    # .env.local
    OPENAI_API_KEY=your-openai-api-key-here
    OPENAI_TRACING_KEY=your-openai-api-key-here

    ⚠️ Security Note: The .env.local file is already included in .gitignore to prevent accidentally committing your API keys.

🎯 Usage

Running the CLI Chatbot

The easiest way to interact with the AI agents is through the interactive CLI chatbot:

npm run chat

This starts an interactive chat session where you can ask questions about:

  • History: Historical events, figures, and context
  • Math: Mathematical problems with step-by-step explanations
  • Weather: Real-time weather information for any location

Environment Setup

The chatbot requires environment variables to be set. Create a .env.local file in the project root:

# .env.local
OPENAI_API_KEY=your-openai-api-key-here
OPENAI_TRACING_KEY=your-openai-api-key-here

⚠️ Security Note: Never commit your .env.local file to version control. It's already included in .gitignore.

🔧 Dependencies

  • @openai/agents: OpenAI Agents framework
  • axios: HTTP client for API requests
  • zod: TypeScript-first schema validation

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Important Notes

  • API Keys: Never commit API keys to version control. Use environment variables for production.
  • Rate Limits: Be aware of OpenAI API rate limits when running multiple queries.
  • Cost: Running AI agents incurs costs based on OpenAI's pricing.

🆘 Support

If you encounter any issues or have questions, please open an issue on GitHub.


Built with ❤️ using OpenAI Agents

About

OpenAI Agents SDK Demos

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published