https://github.com/lperezmo/sms-helper

An AI-powered, function-calling text assistant written in Python and hosted through Azure Functions.
https://github.com/lperezmo/sms-helper

azure azure-functions function-calling gpt-3-5-turbo llm openai openai-api prompts sentry sms twilio-sms-api visual-studio-code

Last synced: 2 months ago
JSON representation

An AI-powered, function-calling text assistant written in Python and hosted through Azure Functions.

• Host: GitHub
• URL: https://github.com/lperezmo/sms-helper
• Owner: lperezmo
• License: gpl-3.0
• Created: 2023-12-16T23:26:58.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-18T03:44:04.000Z (over 1 year ago)
• Last Synced: 2024-05-29T04:30:36.766Z (11 months ago)
• Topics: azure, azure-functions, function-calling, gpt-3-5-turbo, llm, openai, openai-api, prompts, sentry, sms, twilio-sms-api, visual-studio-code
• Language: Python
• Homepage:
• Size: 179 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SMS Helper

## Overview

SMS Helper is an AI-powered, function-calling text assistant designed to process and respond to SMS messages. This application is written in Python and hosted through Azure Functions, utilizing Twilio as the SMS texting platform.

## Features

- Backend can call external tools to perform various functions, such as scheduling text and phone reminders. 

    - This functionality is supported through by allowing AI to call [flask-automated-reminders](https://github.com/lperezmo/flask-automated-reminders).

- Azure Functions allow us to write the backend purely in Python & easily deploy changes.

- Uses Twilio for SMS functionalities and integration.

## Deploy on Azure (VS Code)

1. Create an Azure account & create a function with all defaults (Python).

    * **(Optional)** You can also just create using the Azure functions extension on VS code, see step 3.

2. Create required environment variables on your function.

    - `ACCOUNT_SID`

    - `AUTH_TOKEN`

    - `OPENAI_API_KEY`

    - `SENTRY_DSN`

    ![Setting Env variables in Azure"](https://github.com/lperezmo/sms-helper/blob/main/images/azure_func_env_variables.png?raw=true)

3. In VS Code, install the Azure Functions extension (this will make it way easier).

    ![Extension](https://github.com/lperezmo/sms-helper/blob/main/images/extension.png?raw=true)

4. Open the folder where this repo is located.

    * **(Optional)** Edit `__init__.py` code to use alternative helper if you want to send less messages per request.

    * **(Optional)** If using the 'schedule reminders' function, edit system message and API call to get the current time and date if you want something different than pacific time.

5. Go to the extension, and under 'Workspace' click on the little thunder sign and select 'Deploy to existing function...'.

    ![Deploy](https://github.com/lperezmo/sms-helper/blob/main/images/deploy.png?raw=true)

6. Follow the prompts and done. Get your URL endpoint from Azure & load on Twilio.

## Build & Deploy to Azure using Github Actions

Follow instructions here to enable updating your Azure function when edits are made on Github repo: 

* [How to use GitHub Actions for Azure Functions](https://learn.microsoft.com/en-us/azure/azure-functions/functions-how-to-github-actions?tabs=linux%2Cdotnet&pivots=method-manual)

## Load on Twilio

1. Create Twilio account.

2. Go to Phone Numbers > Manage > Active Numbers > Your number > Messaging configuration.

3. Set when a message comes in to use a webhook with your Azure Function endpoint (see image below)

    ![Twilio config](https://github.com/lperezmo/sms-helper/blob/main/images/messaging_configuration.png?raw=true)

*Note: Your endpoint will look like this:

`https://YOUR-FUNCTION-NAME.azurewebsites.net/api/sms_helper`*

## Summary

1. Configure Azure & Twilio

2. Create function in Azure

3. Deploy

4. Load on Twilio

5. Text your new SMS bud

## Requirements

The project requires the following dependencies:

- `azure-functions==1.17.0`

- `twilio==8.10.2`

- `openai==1.3.2`

- `sentry-sdk`

## Contributing

Contributions to SMS Helper are welcome. Just submit a pull request and I'll take a look at it.

## License

 GPL-3.0 license