Skip to content

Update README.md (Typo "Azure Open AI"→"Azure OpenAI") #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions sms-open-ai-bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,28 +9,28 @@ products:
- azure-communication-services
---

# Build a conversation SMS bot with Azure Open AI
# Build a conversation SMS bot with Azure OpenAI

It is no secret that Large Language Models (LLM) like Chat GPT have been all the rage in the last couple of months. These conversational models offer seamless and intuitive interfaces for users to interact with, enabling them to easily ask questions or carry out tasks.  The Azure Communication Services team strives to provide developers with the tools to integrate these conversational entities with communication channels, and delight end users with exceptional support. In this blog we will show you how to use Azure Communication Services SMS capability and Azure Open AI’s GPT model to light up a personalized end user interaction scenario.
It is no secret that Large Language Models (LLM) like Chat GPT have been all the rage in the last couple of months. These conversational models offer seamless and intuitive interfaces for users to interact with, enabling them to easily ask questions or carry out tasks.  The Azure Communication Services team strives to provide developers with the tools to integrate these conversational entities with communication channels, and delight end users with exceptional support. In this blog we will show you how to use Azure Communication Services SMS capability and Azure OpenAI’s GPT model to light up a personalized end user interaction scenario.

## Pre-requisites

- An Azure account with an active subscription. [Create](https://aka.ms/acs-sms-open-ai-create-azure) an account for free .
- An active Communication Services resource and connection string. [Create a Communication Services resource](https://aka.ms/acs-sms-open-ai-create-resource).
- An SMS-enabled telephone number. [Get a phone number](https://aka.ms/acs-sms-open-ai-get-number).
- Enable Event Grid resource provided on your subscription. [See instructions](https://aka.ms/acs-sms-open-ai-event-sub).
- Create an Azure Open AI resource. See [instructions](https://aka.ms/acs-sms-open-ai-create-open).  
- Deploy an Azure Open AI model. See [instructions](https://aka.ms/acs-sms-open-ai-deploy-model).
- Create an Azure OpenAI resource. See [instructions](https://aka.ms/acs-sms-open-ai-create-open).  
- Deploy an Azure OpenAI model. See [instructions](https://aka.ms/acs-sms-open-ai-deploy-model).

This application leverages [Azure Event Grid](https://learn.microsoft.com/azure/event-grid/) to listen for incoming text messages to Azure Communication Services number and an [Azure Function](https://learn.microsoft.com/azure/azure-functions/) to process the event and respond with an Azure Open AI generated response.
This application leverages [Azure Event Grid](https://learn.microsoft.com/azure/event-grid/) to listen for incoming text messages to Azure Communication Services number and an [Azure Function](https://learn.microsoft.com/azure/azure-functions/) to process the event and respond with an Azure OpenAI generated response.

## Run locally

1. Ensure to have the Azure Function Extension on Visual Studio. Click into the tab on the left side menu and initialize the project
2. Open a terminal and navigate to the repository directory
3. Run `cd sms-open-ai-bot` to get in the same directory as the function
4. Run `npm i` which will install the dependencies for the sample
5. Update the values in the code to add your Azure Communication Services connection string and Azure Open AI endpoint (url), model deployment name and key.
5. Update the values in the code to add your Azure Communication Services connection string and Azure OpenAI endpoint (url), model deployment name and key.
6. In Visual Studio Code, click into the `index.ts` file and press `F5`. (Alternatively run `func host start` within the functions directory)

We use [ngrok](https://ngrok.com/) to hook our locally running Azure Function with Azure Event Grid. You will need to [download ngrok](https://ngrok.com/download) for your environment. Once the function is running, we will configure ngrok.
Expand Down