Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.79 KB

README.md

File metadata and controls

57 lines (37 loc) · 1.79 KB
Raw

-BETA- WORK - IN - PROGRESS

Chat Application with OpenAI Assistant API

Description

This chat application integrates OpenAI's Assistant API to provide an interactive chat interface. It enables users to interact with an AI assistant, offering functionalities like creating and deleting assistants, managing threads, and processing user inputs for various tasks.

Features

  • Real-time chat interface with AI assistant.
  • Integration with OpenAI's Assistant API for advanced functionalities.
  • Custom chat functionalities including creating assistants, threads, and message handling.

Installation

To set up this project locally, follow these steps:

  1. Clone the repository:

    git clone [https://github.com/admineral/openAssistant]

  2. Install dependencies:

    npm install

  3. Set up environment variables:

    • Create a .env file in the root directory.
    • Add your OpenAI API key and any other necessary configuration.

  4. Start the application:

    npm run dev

Usage

  • The application can be accessed at localhost:3000 after starting the server.
  • Example use cases are provided to guide interactions with the AI assistant.
  • Users can type messages and interact with the AI assistant in real-time.

Contributing

Contributions to this project are welcome. Please follow these steps to contribute:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-branch-name.
  3. Make your changes and commit them: git commit -m 'Commit message'.
  4. Push to the original branch: git push origin [project-name]/[location].
  5. Create the pull request.

Alternatively, see the GitHub documentation on creating a pull request.