Skip to content

This Repo is about Simple Agent system by OpenAI SDK using Google Gimini , which is a modular design pattern that allows AI components like Gemini API Integration | OpenAI-Compatible SDK | Agent System | Async Model Support | Custom Instructions | User Input Handling | Natural Language Response | Chainlit for UI | Console Output

Notifications You must be signed in to change notification settings

waheed444/OpenAI_SDK_Simple_Agent

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🤖 Introduction to OpenAI Agent SDK by Gimini

License Python Version Maintenance

Table of Contents 🚀

Description

The OpenAI Agents SDK enables you to build agentic AI apps in a lightweight, easy-to-use package with very few abstractions.This project demonstrates the integration of the OpenAI-compatible SDK with Google's Gemini API to build an intelligent, conversational AI agent. The agent is designed to understand user prompts and generate insightful, human-like responses. In this implementation, the AI agent is tasked with recommending high-income skills for 2025, showcasing its ability to deliver relevant and valuable information. By leveraging the Gemini 2.0 Flash model, the system benefits from fast and efficient language generation.This setup reflects a modular, production-ready approach for integrating third-party large language models (LLMs) into custom AI solutions.

Features

  • 🤖 Custom AI Agent: Built using the Agent and Runner pattern for modularity and scalability.
  • 🌐 Google Gemini 2.0 Flash Integration: Utilizes Google's API for access to the powerful Gemini language model.
  • 🔑 Secure API Key Management: Employs python-dotenv for safe and convenient API key handling.
  • 🧠 Dynamic Prompt Handling: Processes and responds effectively to a wide range of user prompts.
  • Asynchronous Communication: Leverages AsyncOpenAI for optimized asynchronous communication with OpenAI, improving speed and responsiveness.
  • 🐍 Clean Python Codebase: Maintained with a focus on readability, modularity, and best practices.

Prerequisites

Before getting started, make sure you have the following:

  • Python 3.8+ installed on your system.
  • Basic knowledge of Python programming.
  • Familiarity with virtual environments and dependency management.
  • Git installed to clone the repository.

Installation

  1. Clone the Repository:
git clone https://github.com/waheed444/OpenAI_SDK_Simple_Agent.git
cd OpenAI_SDK_Simple_Agent
  1. Create and Activate a Virtual Environment:
python -m venv venv
source venv/bin/activate  # For Windows: venv\Scripts\activate
  1. Install Dependencies:
pip install -r requirements.txt

OR Install Dependencies:

pip install openai-agents python-dotenv

(If a requirements file is not available, check pyproject.toml for dependency instructions.)

  1. Set up .env file:

Create a .env file in the root directory and add your Gemini API key:

GIMINI_API_KEY  =  your_actual_gemini_api_key_here 

Note: Replace your_actual_gemini_api_key_here with your actual Gemini API key.

Usage

After setting up the project, you can run the AI agent by executing the main script in the src/agent_01 directory.For example:

python src/agent_01/main.py

The agent is designed to provide insightful responses to various prompts. For example, a prompt such as "What are the most in-demand skills for high income in 2025?" might produce output similar to:

"The most in-demand skills for massive income in 2025 include... [list of skills]"

More detailed usage instructions and example prompts will be provided in the project's documentation.

License

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

Contributing

We welcome contributions to improve this project! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-name
  3. Make your changes and ensure they adhere to the project's coding style and best practices.
  4. Commit your changes: git commit -m "Add feature"
  5. Push to the branch: git push origin feature-name
  6. Submit a pull request with a clear description of your changes and their benefits. If you find any issues or want to improve this project, feel free to open a GitHub issue or submit a pull request.

This repo is only for learning and exploring new things, feel free to fork it, explore, or give suggestions!

Star ⭐ the repo if it helps you!


🙌 Let's Connect

LinkedIn GitHub Gmail


About

This Repo is about Simple Agent system by OpenAI SDK using Google Gimini , which is a modular design pattern that allows AI components like Gemini API Integration | OpenAI-Compatible SDK | Agent System | Async Model Support | Custom Instructions | User Input Handling | Natural Language Response | Chainlit for UI | Console Output

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages