A simple cli chat interface that enables users to interact with any of their OpenAI Assistants. This application leverages the OpenAI Assistant API, allowing for conversation threads and intelligent responses based on user queries.
Follow these instructions to get a copy of the project up and running on your local machine for development and testing purposes.
You will need Node.js and npm installed on your machine.
node --20.9.0
npm --10.1.0Clone the repository, install the dependencies, and start the server using the following commands:
# Clone the repository to your local machine
git clone https://github.com/report2model/assistant_test
# Navigate to the project directory
cd your-project-root-directory
# Install dependencies (will auto-install from package.json)
npm install
node main.js
Once the application is running, select which assistant you would like to chat with. It will then list the attached files to the assistant if any are available. You can then query the assistant. At any time during an input you can type "new" to switch to a new assistant or type "exit" to exit the application.
This application uses the OpenAI Assistant API to manage conversational threads and messages. The API allows creating sessions with 'threads', sending and receiving 'messages', and managing the conversation session with 'runs'.
We advise implementing proper authorization and restricting API key access to authorized users only to ensure data privacy and security.
Contributions to this project are welcome. Ensure that you follow the code of conduct and submit pull requests for your proposed changes.
Konecheck
This project is MIT licensed for open use by all.
Kudos to the OpenAI team for providing the API and documentation that this project relies upon.
No further enhancements are planned currently.
For additional assistance or questions about this application, please contact the project maintainers at [email protected].