perzeuss / OpenAI-Assistant-API-Chat

Official OpenAI-Assistant API starter. Users can specify the assistant's name, model, and description, and send messages to the assistant.

OpenAI Assistant API Chat

Introduction

Welcome to the OpenAI Assistant API Chat repository! This innovative chat application allows users to interact with an AI assistant powered by OpenAI's latest "gpt-4-1106-preview" model. It's an exciting space where technology meets conversation, offering a unique experience of AI interaction.

Features

• Personalized AI Assistant: Customize the assistant's name, model, and description for a unique chat experience.
• Interactive Chat Experience: Engage in dynamic conversations with the AI assistant.
• Robust AI Responses: Leveraging OpenAI's "gpt-4-1106-preview" model for intelligent, context-aware chat responses.
• File Upload: Users can upload files for the assistant to analyze.
• Code Interpretation: (Coming Soon) The assistant can execute Pytho code.
• Function Calls: (Coming Soon) Experience interactive functionalities such as API calls based on chat context.
• GPT-4 Vision Integration: (Coming Soon)
  • Image Descriptions: Send pictures to the AI, and it will describe what it sees, providing insights and understanding of the visual content.
  • Optical Character Recognition (OCR): The AI can analyze text within images, making it possible to read and respond to textual content in photographs or scanned documents.

Beta & Work in Progress

Please note that this application is currently in the beta phase and is continuously evolving. We are working diligently to enhance the user experience and add new features. During this phase, you may encounter some hiccups or unexpected behavior.

Getting Started

Prerequisites

• Node.js installed on your machine.
• An active OpenAI API key.

Installation

1. Clone the Repository:

   git clone https://github.com/your-username/openai-assistant-chat.git
   

2. Install Dependencies: Navigate to the project directory and run:

   npm install
   

3. Environment Setup: Create a .env file in the root directory and add your OpenAI API key:

   OPENAI_API_KEY=your_openai_api_key
   

4. Run the Application: Start the server with:

   npm run dev
   

Contributing

Your contributions make this project thrive. Whether it's reporting bugs, suggesting features, or submitting code changes, every bit of help is greatly appreciated.

• Report Issues: If you encounter any problems, please open an issue on our GitHub page.
• Feature Requests: Have an idea? Share it with us by opening an issue.
• Pull Requests: Want to make a direct impact? Fork the repository, make your changes, and submit a pull request.

We look forward to growing this project with the community's support and creativity!