Skip to content

Commit

Permalink
Merge pull request #357 from bolna-ai/oss-example
Browse files Browse the repository at this point in the history 
updating dockerfile and prompt example
  • Loading branch information
@prateeksachan
prateeksachan authored Aug 3, 2024
2 parents bfb52aa + e4da629 commit a655073
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 164 deletions.
6 changes: 0 additions & 6 deletions examples/whisper-melo-llama3/.env-sample
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,7 @@ TWILIO_ACCOUNT_SID=
TWILIO_AUTH_TOKEN=
TWILIO_PHONE_NUMBER=

DEEPGRAM_AUTH_TOKEN=
DEEPGRAM_API_KEY=

ELEVENLABS_API_KEY=

OPENAI_API_KEY=
OPENAI_MODEL=gpt-3.5-turbo

ENVIRONMENT=local
WEBSOCKET_URL=
Expand Down
202 changes: 46 additions & 156 deletions examples/whisper-melo-llama3/Readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,29 @@ Introducing our Dockerized solution! Seamlessly merge [Bolna](https://github.com

### Start Serices
```shell
# build latest `twilio-app` and `bolna-app`
docker compose build twilio-app bolna-app

# run containers
docker compose up -d
```
the output something like this
![alt text](./img/docker_up.png "docker compose up -d")

note: make sure that your all service were runing

`let assume your server IP is 192.168.1.10`

### Creating Agent
for creating agent you have to execute following command mention below

<details>
<summary>Agent create API</summary><br>

```shell
curl --location 'http://192.168.1.10:5001/agent' \
curl --location 'http://0.0.0.0:5001/agent' \
--header 'Content-Type: application/json' \
--data '{
"agent_config": {
"agent_name": "Test agent with a transfer call prompt",
"agent_name": "Bolna Agent",
"agent_welcome_message": "Hey how are you!",
"tasks": [
{
Expand Down Expand Up @@ -48,24 +54,14 @@ curl --location 'http://192.168.1.10:5001/agent' \
"audio_format": "pcm"
},
"llm_agent": {
"max_tokens": 100.0,
"presence_penalty": 0.0,
"summarization_details": null,
"base_url": null,
"extraction_details": null,
"top_p": 0.9,
"model": "deepinfra/meta-llama/Meta-Llama-3-70B-Instruct",
"max_tokens": 123,
"agent_flow_type": "streaming",
"request_json": false,
"routes": null,
"min_p": 0.1,
"frequency_penalty": 0.0,
"stop": null,
"provider": "openai",
"top_k": 0.0,
"temperature": 0.2,
"model": "gpt-3.5-turbo",
"family": "openai",
"extra_config": null
"use_fallback": true,
"family": "llama",
"temperature": 0.1,
"request_json": true,
"provider": "deepinfra"
},
"transcriber": {
"encoding": "linear16",
Expand All @@ -77,118 +73,7 @@ curl --location 'http://192.168.1.10:5001/agent' \
"task": "transcribe",
"provider":"whisper"
},
"api_tools": {
"tools": [
{
"name": "check_availability_of_slots",
"description": "Fetch the available free slots of appointment booking before booking the appointment",
"parameters": {
"type": "object",
"properties": {
"startTime": {
"type": "string",
"description": "It is an ISO FORMATTED DATE on which time user is available (convert it automatically to hr:min such as 3:30 PM is 15:30)"
},
"endTime": {
"type": "string",
"description": "It is an ISO FORMATTED DATE. endDate is always 15 minutes more than startDate always i.e. increment one day to the startDate. such if startDate is 2024-05-15T16:30:00.000Z then endDate is 2024-05-15T16:45:00.000Z"
},
"eventTypeId": {
"type": "integer",
"description": "it is the type of event. For women'\''s haircut use event type id as 814889 and for men'\''s haircut use 798483 "
}
},
"required": [
"startTime",
"eventTypeId",
"endTime"
]
}
},
{
"name": "book_appointment",
"description": "Use this tool to book an appointment with given details and save the appointment in the calendar.",
"parameters": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the person."
},
"email": {
"type": "string",
"description": "email name of the person."
},
"address": {
"type": "string",
"description": "address name of the person."
},
"preferred_date": {
"type": "string",
"description": "Preferred date provided by the person, ask the date when user wants to book an appointment such as tomorrow or day after tomorrow. and convert the user'\''s response into a python readable format i.e. yyyy-mm-dd"
},
"preferred_time": {
"type": "string",
"description": "Preferred time provided by the person, ask the time when users wants to book an appointment such as 9am or 10:30am and convert it to python readable format for example if users said 9am then it is 09:00 or 1:30PM then it 13:30 i.e. in hr:min "
},
"timezone": {
"type": "string",
"description": "fetch timezone by yourself, don'\''t ask user, find timezone based on the address provided by the user"
},
"eventTypeId": {
"type": "integer",
"description": "it is the type of event. For women'\''s haircut use event type id as 814889 and for men'\''s haircut use 798483 "
}
},
"required": [
"name",
"email",
"address",
"eventTypeId",
"preferred_date",
"preferred_time",
"timezone"
]
}
},
{
"name": "transfer_call",
"description": "Transfer calls to human agent if user asks to transfer the call or if it'\''s not in your instructions on how to deal with a certain question user is asking. Call can be routed either to '\''hair_dresser'\'' or a '\''recruiter'\''. Make sure you have this information. It can only be either of the two",
"parameters": {
"type": "object",
"properties": {
"humanAgentType": {
"type": "string",
"description": "This is the department the call should be routed to. Make sure we know the user has mentioned if they want the call to be routed to '\''hair_dresser'\'' or a '\''recruiter'\'' before sending. It can only be either of the two"
}
},
"required": [
"humanAgentType"
]
}
}
],
"tools_params": {
"book_appointment": {
"method": "POST",
"param": "{\"responses\":{\"name\":\"%(name)s\",\"email\":\"%(email)s\",\"location\":{\"optionValue\":\"\",\"value\":\"inPerson\"}},\"start\":\"%(preferred_date)sT%(preferred_time)s:00.000Z\",\"eventTypeId\":%(eventTypeId)d,\"timeZone\":\"%(timezone)s\",\"language\":\"en\",\"metadata\":{}}",
"url": "https://api.cal.com/v1/bookings?apiKey=API_KEY",
"api_token": null
},
"check_availability_of_slots": {
"method": "GET",
"param": "{\"eventTypeId\":%(eventTypeId)d,\"startTime\":\"%(startTime)s\",\"endTime\":\"%(endTime)s\"}",
"url": "https://api.cal.com/v1/slots?apiKey=API_KEY",
"api_token": null
},
"transfer_call": {
"method": "POST",
"param": "{\"humanAgentType\": \"(humanAgentType)s\"}",
"url": "https://webhook.site/3174ce9e-b398-4ec6-bbd5-f3a61473dfce",
"api_token": null
}
}
}
"api_tools": null
},
"task_config": {
"ambient_noise_track": "office-ambience",
Expand Down Expand Up @@ -222,30 +107,33 @@ curl --location 'http://192.168.1.10:5001/agent' \
},
"agent_prompts": {
"task_1": {
"system_prompt": "### Agent Description You'\''re an, Mellisa, a helpful agent whose job is to book appointments for Boston Barber Co. at Beacon Hill. There are two type of appointments available - 1. Haircut for men. event id - 798483 2. Appointment for women - 814889 ### About store - Shop is opened Tuesday to Sunday from 9 am to 9pm. - For premium treatment one beer is on the house ### Flow Users can ask you to find available slots & booking for an appointment. You will ask the users about their availability i.e. when they are available the date and time and check if that slot is available or not then you will ask other details as mentioned in function calling and proceed with this information to do the function calling for finding available slots. If slots are available then you must tell only those slots or that slot to user which is or are very close to the user'\''s availability. ### You have access to following functions/tools 1. *check_availability_of_slots* - To check availability of slots from the calendar before booking the appointment. 2. *book_appointment* - Use this tool to book an appointment with given details and save the appointment in the calendar. 3.*transfer_call* - Use this tool to transfer the call to human agent whenever required\n\n### Important instructions 1. MAKE SURE YOU GET ALL THE REQUIRED DETAILS BEFORE DOING A FUNCTION CALL. 2. PLEASE MAKES SURE YOUR RESPONSES ARE GEARED TO BE SYNTHESIZED BY THE SYNTHESISER IN AN EXPRESSIVE WAY. 3. Just speak 1 sentence at a time. If the user says to transfer call MAKE SURE YOU KNOW IF THE CALL SHOULD BE TRANSFERRED FOR haircut or recruitment. It can only be either of the two!"
"system_prompt": "Ask if they are coming for party tonight"
}
}
}'

```
</details>

below given is the response
![alt text](./img/agent_res.png "agent response")
copy the agent_id we have to use in next step

if you want to [Change voice](#change-voice)
Copy this `agent_id` we have to use in next step while invoking the call

<details>
<summary>Invoke call API</summary><br>

### Make call
```shell
curl --location 'http://192.168.1.10:8001/call' \
curl --location 'http://0.0.0.0:8001/call' \
--header 'Content-Type: application/json' \
--data '{
"agent_id": "bf2a9e9c-6038-4104-85c4-b71a0d1478c9",
"recipient_phone_number": "+91XXXXXXXXXX"
"recipient_phone_number": "+1XXXXXXXXXX"
}'
```
it gonna give output `Done` for succees
</details>

note: if you are using trial account use you register phone no
You should hear your phone ringing now.

### Stop Services
```shell
Expand All @@ -265,22 +153,24 @@ by default we resrtict Melo EN but there were 5 option for voice as mention belo

you have to just change the following section mention below
```JSON
"synthesizer": {
"provider": "melo",
"provider_config": {
"voice": "<put your selected voice here>",
"sample_rate": 8000,
"sdp_ratio" : 0.2,
"noise_scale" : 0.6,
"noise_scale_w" : 0.8,
"speed" : 1.0
},
"stream": true,
"buffer_size": 123,
"audio_format": "pcm"
}
{
"synthesizer": {
"provider": "melo",
"provider_config": {
"voice": "<put your selected voice here>",
"sample_rate": 8000,
"sdp_ratio": 0.2,
"noise_scale": 0.6,
"noise_scale_w": 0.8,
"speed": 1.0
},
"stream": true,
"buffer_size": 123,
"audio_format": "pcm"
}
}
```
and rest of the config gonna be same mention above


### Conservation DENO
This is demo using below prompt to the LLM
Expand Down
4 changes: 2 additions & 2 deletions examples/whisper-melo-llama3/docker-compose.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ services:

### whisper servers ###
whisper-app:
image: whisper-app:latest
image: bolnadev/whisper_server:latest
build:
context: .
dockerfile: dockerfiles/whisper_server.Dockerfile
Expand All @@ -67,7 +67,7 @@ services:
capabilities: [gpu]
### Melo TTS ###
melo-app:
image: melo-app:latest
image: bolnadev/melo_server:latest
build:
context: .
dockerfile: dockerfiles/melo_server.Dockerfile
Expand Down

0 comments on commit a655073

Please sign in to comment.