Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shubh2-0/chatbotspringai
This repository contains ChatBotSpringAI, an exhilarating Spring Boot project that unleashes the power of an intelligent chatbot! Engage in dynamic conversations and receive brilliant responses, all made possible by the impressive ChatGPT API from OpenAI. Experience the magic of AI-driven interactions like never before! ๐๐๐ฌ
https://github.com/shubh2-0/chatbotspringai
java-8 lombok maven openai restful-api resttemplate spring-boot springannotations
Last synced: about 2 months ago
JSON representation
This repository contains ChatBotSpringAI, an exhilarating Spring Boot project that unleashes the power of an intelligent chatbot! Engage in dynamic conversations and receive brilliant responses, all made possible by the impressive ChatGPT API from OpenAI. Experience the magic of AI-driven interactions like never before! ๐๐๐ฌ
- Host: GitHub
- URL: https://github.com/shubh2-0/chatbotspringai
- Owner: Shubh2-0
- Created: 2023-08-04T05:42:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-18T18:43:50.000Z (11 months ago)
- Last Synced: 2024-05-01T13:47:20.843Z (8 months ago)
- Topics: java-8, lombok, maven, openai, restful-api, resttemplate, spring-boot, springannotations
- Language: Java
- Homepage:
- Size: 2.22 MB
- Stars: 18
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ChatBotSpringAI ๐ค
![Project Logo](images/poster.png)
## Description ๐ฃ๏ธ๐ฌ
Welcome to ChatBotSpringAI, the ultimate Spring Boot project that brings an intelligent chatbot to life! ๐๐ Engage in conversations like never before, powered by the incredible ChatGPT API from OpenAI. Get ready for an adventure full of amazing interactions and brilliant responses! ๐๐ฌ
## Table of Contents ๐๐- [Installation](#installation)
- [Usage](#usage)
- [API Integration](#api-integration)
- [Configuration](#configuration)
- [Tools Used](#tools-used)
- [Contributing](#contributing)
- [Acknowledgements](#acknowledgements)
- [JavaDoc](#javadoc)## Installation ๐ป๐ ๏ธ
Let's get started on this exciting journey! To run ChatBotSpringAI on your local machine, follow these super simple steps:
1. Clone the repository to your computer. ๐๐ป
2. Make sure you have Java and Maven installed. If not, don't worry, we've got you covered! ๐๐
3. Grab an API key from the OpenAI platform. It's like the secret sauce for the magic! ๐โจ
4. Set the API key as an environment variable or securely store it in the application.properties file. Safety first! ๐๐
5. Build the project using Maven. Boom! ๐ฅ๐ฅ
6. Run the Spring Boot application. Here we go! ๐โโ๏ธ๐โโ๏ธ## Usage ๐๐จ๏ธ
Once the ChatBot is up and running, get ready to have a blast! ๐๐ Interact with the ChatBot by making HTTP GET requests to the awesome endpoint we've set up. Simply append the text prompt as a query parameter to the URL, like this:
``
GET http://localhost:8080/mychat?userInput="Github"
``
userInput(user query)You'll receive incredible answers as a response! ๐คฏ๐ฌ
## API Integration โ๏ธ๐
ChatBotSpringAI is now officially connected to the mind-blowing OpenAI ChatGPT API. Get ready to experience the power of cutting-edge technology as we dive deep into the world of AI-powered conversations! ๐คโก
## Configuration ๐งโ๏ธ
Customize your chatbot experience like a boss! ๐ฉ๐ Modify the application.properties file to tweak the API endpoint URL, adjust model settings, and fine-tune parameters for the most sensational chat responses. ๐๐ฌ
## Tools Used ๐ ๏ธ
Java
Maven
Spring Boot
RESTful API
Lombok
STS
GitHub
Postman
## Contributing ๐ค๐
Hey, we're in this together! We're thrilled to welcome contributions from all the awesome developers out there. Join the ChatBotSpringAI community and let's make it even better! ๐๐คฉ
## Acknowledgements ๐๐
A huge shoutout to the incredible developers and researchers at OpenAI. Your groundbreaking work on the ChatGPT model is an inspiration to all of us! ๐โจ Thank you for making this project a reality.
---
Let's make this README a celebration of the awesome ChatBotSpringAI project! ๐ฅณ๐ The world of AI-powered chat awaits, and we can't wait to see what exciting conversations await us! ๐ฌ๐ฌ
Feel free to use this enthusiasm-filled README or add even more excitement and personal touches to make it uniquely yours. Let's spread the joy of technology with ChatBotSpringAI! ๐๐ค
## JavaDoc ๐๐
The JavaDoc documentation for the classes in the ChatBotSpringAI project can be found [here](https://64cd7caa2be4dd65b7df5481--chipper-maamoul-ae7f9b.netlify.app/). It provides detailed explanations for classes, methods, fields, and other elements to help developers understand the functionality and usage of various components.
To generate the JavaDoc documentation, use the `javadoc` command with app
## ๐ฌ Contact
If you want to contact me, you can reach me through below handles.