Skip to content

Latest commit

 

History

History
441 lines (280 loc) · 12.4 KB

readme.md

File metadata and controls

441 lines (280 loc) · 12.4 KB
Raw

AGI-o1

AGI-o1 Architecture Diagram

Table of Contents

Overview

AGI-o1 is an advanced AI assistant built using OpenAI's GPT-4 architecture. Designed to handle complex user queries, perform specialized research, manage information efficiently, and provide seamless interactions through a command-line interface, AGI-o1 leverages a scratch pad system for storing and retrieving information. It integrates various functionalities like weather retrieval and is extensible for future enhancements such as image processing.

Important: As of September 21, 2024, the o1-mini model is only available to Tier 5 accounts on OpenAI. Ensure your OpenAI account meets this requirement to utilize all features of AGI-o1.

Features

  • Advanced Chat Interface: Engage in dynamic conversations with the AI assistant.
  • Function Calls: Utilizes OpenAI's function calling to perform specialized tasks.
  • Scratch Pad System: Save, edit, view, list, and search notes categorized for easy access.
  • Logging: Comprehensive logging of interactions and system events.
  • Modular Functions: Includes research, information retrieval, weather updates, and more.
  • Extensible: Placeholder for future functionalities like image processing.
  • Access Control: o1-mini model access restricted to Tier 5 OpenAI accounts as of September 21, 2024.

Architecture

AGI-o1 Architecture Diagram

AGI-o1 follows a modular architecture where each functionality is encapsulated within dedicated functions. The system manages chat history, handles user commands, and interacts with OpenAI's API to process and respond to user inputs effectively.

Installation

Prerequisites

  • Python 3.8+: Ensure you have Python installed. You can download it from python.org.
  • OpenAI API Key: Obtain your API key from OpenAI.
  • Tier 5 OpenAI Account: Required to access the o1-mini model as of September 21, 2024.

Steps

  1. Clone the Repository

    git clone https://github.com/nschlaepfer/AGI-o1.git
cd AGI-o1

  2. Create a Virtual Environment (Optional but Recommended)

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  3. Install Dependencies

    pip install -r requirements.txt

    If requirements.txt is not provided, install the necessary packages manually:

    pip install openai python-dotenv

Configuration

  1. Environment Variables

    Create a .env file in the root directory of the project and add your OpenAI API key:

    OPENAI_API_KEY=your_openai_api_key_here

  2. Directory Setup

    The application will automatically create the following directories if they do not exist:

    • logs/: Stores log files.
    • o1_responses/: Stores responses from the o1_research function.
    • scratch_pad/: Manages scratch pad files categorized appropriately.

Usage

Running the Application

Execute the main script to start interacting with AGI-o1:

python agi_o1.py

Replace agi_o1.py with the actual filename if different.

Available Commands

AGI-o1 supports both natural language interactions and a set of predefined commands for managing the scratch pad and chat history. Commands are prefixed with a /.

Chat Commands

  • Exit Conversation

    exit
quit
bye

    Ends the conversation with the AI assistant.

Scratch Pad Commands

  • Edit a Message

    /edit <index> <new_content>

    Edits a message at the specified index in the chat history.

  • Remove a Message

    /remove <index>

    Removes a message at the specified index from the chat history.

  • Save to Scratch Pad

    /save <category> <filename> <content>

    Saves content to a scratch pad file within the specified category.

  • Edit Scratch Pad File

    /edit_scratch <category> <filename> <new_content>

    Edits an existing scratch pad file within the specified category.

  • List Scratch Pad Files

    /list_scratch_pad [category] [page]

    Lists scratch pad files, optionally within a specific category and paginated.

  • View Scratch Pad File

    /view_scratch <category> <filename>

    Views the content of a scratch pad file within the specified category.

  • Delete Scratch Pad File

    /delete_scratch <category> <filename>

    Deletes a scratch pad file within the specified category.

  • Search Scratch Pad Files

    /search_scratch <query>

    Searches for a query string within all scratch pad files.

Example Usage

You: What's the weather like in New York today?
AI: The current weather in New York is sunny with a temperature of 25 degrees Celsius.

You: /save Personal Notes Meeting at 10 AM
Content saved to scratch pad as 'Personal/Notes.txt'.

You: /list_scratch_pad Personal
Available scratch pad files (Page 1/1):
Personal/Notes.txt

Functions

AGI-o1 includes several built-in functions to enhance its capabilities:

1. o1_research

Performs complex reasoning for STEM (Science, Technology, Engineering, Mathematics) tasks related to the user's query.

  • Parameters:
    • query (string): The STEM question to be researched.

2. librarian

Retrieves information using OpenAI's Retrieval tool.

  • Parameters:
    • query (string): The query to search for information.

3. save_scratch_pad

Saves content to a scratch pad file within a specified category.

  • Parameters:
    • category (string): The category under which to save the file.
    • filename (string): The name of the file to save the content.
    • content (string): The content to save in the file.

4. edit_scratch_pad

Edits content of an existing scratch pad file within a specified category.

  • Parameters:
    • category (string): The category of the file to edit.
    • filename (string): The name of the file to edit.
    • new_content (string): The new content to replace the existing content.

5. list_scratch_pad_files

Lists all available scratch pad files, optionally within a specific category and paginated.

  • Parameters:
    • category (string, optional): The category to list files from.
    • page (integer, optional): The page number to display.

6. view_scratch_pad

Views the content of a scratch pad file within a specified category.

  • Parameters:
    • category (string): The category of the file to view.
    • filename (string): The name of the file to view.

7. delete_scratch_pad

Deletes a scratch pad file within a specified category.

  • Parameters:
    • category (string): The category of the file to delete.
    • filename (string): The name of the file to delete.

8. search_scratch_pad

Searches for a query string within all scratch pad files.

  • Parameters:
    • query (string): The string to search for within scratch pad files.

9. get_current_weather

Gets the current weather in a given location.

  • Parameters:
    • location (string): The city and state, e.g., "San Francisco, CA".
    • unit (string, optional): Unit for temperature (celsius or fahrenheit). Defaults to celsius.

Future Functions

  • handle_image: Placeholder for image processing and description functionality.

Directory Structure

AGI-o1/
├── logs/
│   └── chat_log_YYYYMMDD_HHMMSS.log
├── o1_responses/
│   └── o1_response_YYYYMMDD_HHMMSS.log
├── scratch_pad/
│   ├── Category1/
│   │   └── filename1.txt
│   └── Category2/
│       └── filename2.txt
├── .env
├── agi_o1.py
├── requirements.txt
└── README.md
  • logs/: Contains log files documenting interactions and system events.
  • o1_responses/: Stores responses from the o1_research function for later reference.
  • scratch_pad/: Organized directories containing user-saved notes and information.
  • .env: Environment variables, including the OpenAI API key.
  • agi_o1.py: Main application script.
  • requirements.txt: Lists Python dependencies.
  • README.md: Project documentation.

Logging

AGI-o1 employs Python's built-in logging module to record detailed logs of all interactions and system activities.

  • Log Files: Stored in the logs/ directory with filenames formatted as chat_log_YYYYMMDD_HHMMSS.log.
  • Logged Information:
    • User inputs and AI responses.
    • Function calls and their parameters.
    • Errors and warnings for troubleshooting.

Contributing

Contributions are welcome! To contribute to AGI-o1, follow these steps:

  1. Fork the Repository

  2. Create a New Branch

    git checkout -b feature/YourFeatureName

  3. Commit Your Changes

    git commit -m "Add your detailed description here"

  4. Push to the Branch

    git push origin feature/YourFeatureName

  5. Open a Pull Request

Provide a clear description of your changes and the problem they solve.

Code of Conduct

Please adhere to the Contributor Covenant Code of Conduct in all interactions.

License

This project is licensed under the MIT License.

Contact

For questions, suggestions, or support, please contact:

Note: Replace placeholders like path/to/your/diagram.png, your.email@example.com, and any other placeholder text with your actual details.

Enhancements and Best Practices

To make the README even more effective, consider the following enhancements:

  1. Add the Architecture Diagram:

    Ensure you replace path/to/your/diagram.png with the actual path to your architecture diagram. For example, if the diagram is in the docs folder:

    ![AGI-o1 Architecture Diagram](docs/architecture_diagram.png)

  2. Provide a requirements.txt File:

    If not already present, create a requirements.txt file with the necessary dependencies:

    openai
python-dotenv

    This allows users to install dependencies easily using pip install -r requirements.txt.

  3. Include Examples and Screenshots:

    Adding screenshots of the application in action or example conversations can help users understand its functionality better.

  4. Detailed Contribution Guidelines:

    Including a CONTRIBUTING.md file with detailed guidelines can streamline the contribution process.

  5. Add a License File:

    Ensure you have a LICENSE file in your repository matching the license mentioned in the README.

  6. Code of Conduct:

    Including a CODE_OF_CONDUCT.md file promotes a welcoming and respectful community.

  7. Issue Templates:

    Adding issue and pull request templates can help maintain the quality and consistency of contributions.

  8. Badges:

    Incorporate badges for build status, license, and other relevant metrics to provide quick information at a glance.

    ![License](https://img.shields.io/badge/license-MIT-blue.svg)
![GitHub last commit](https://img.shields.io/github/last-commit/nschlaepfer/AGI-o1)

  9. Expand the Functions Section:

    Provide more detailed explanations or usage examples for each function to help users understand how to leverage them effectively.

  10. Automate Directory Creation:

    While the script handles directory creation, documenting this behavior reassures users about the setup process.

  11. Environment Variable Validation:

    Add instructions or scripts to validate the presence and correctness of environment variables, enhancing user experience.

  12. Testing Instructions:

    If you have tests, include a section on how to run them to ensure the application works as expected.

  13. FAQ Section:

    Address common questions or issues users might encounter.