This project is a small RESTFull API made in Python to create personal Chat to be used with Assistant!
This project have the goal to help the small bussines and personal projects to build a small Assistant to help your clients or your self about any context!
This project can be used in a lot of scenarios, how as:
- Personal Assistant to help your premium customers effectively address questions about your product or service.
- Personal Assistant to help acquire new customers by assisting in answering all questions.
We currently have 3 branchs:
main
- Support K8s and Docker
logs/datadog
- Support K8s, Docker and DataDog Agent to send metrics and logs from STDOUT
serverless/aws_lambda
- Support AWS Lambda with API Gateway
These instructions will help you get Assistant OpenAI up and running on your local machine for development and testing purposes.
# Clone this repository with the specific branch
$ git clone -b <desired-branch> https://github.com/ramonpaolo/assistant-openai.git
# Set the environment variables
$ nano .env
# Run the docker-compose
$ docker-compose up --build -d
# Set the environment variables
$ nano .env
# Install the dependencies
$ pip install -r requirements.txt
# Run the uvicorn
$ uvicorn main:app --reload
# Set the environment variables
$ nano kubernetes/secrets.yml
# Build the container image
$ docker buildx build --platform linux/amd64 -t <your-name-user>/<name-of-image>:latest .
# Upload the image do hub.docker(Image Registry)
$ docker push <your-name-user>/<name-of-image>:latest
# Apply kubernetes configs
$ kubectl apply -f kubernetes
Only available to execute in CI/CD pipelines
Access the folder docs to get example of requests.
The file context.txt in docs/
, is a small example of context to be used in Assistant!
We welcome contributions from the community! If you'd like to contribute, please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature
- Make your changes and commit them:
git commit -m 'feat: Add some feature'
- Push to your forked repository:
git push origin feature/your-feature
- Create a pull request
This project is licensed under the MIT - see the LICENSE file for details.
Enjoy using Assistant OpenAI! If you have any questions or feedback, please don't hesitate to reach out to me.