bolna 0.6.3__tar.gz

bolna-0.6.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Bolna
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bolna-0.6.3/PKG-INFO

@@ -0,0 +1,182 @@
+Metadata-Version: 2.1
+Name: bolna
+Version: 0.6.3
+Author-email: Prateek Sachan <ps@prateeksachan.com>
+License: MIT License
+        
+        Copyright (c) 2023 Bolna
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiobotocore==2.9.0
+Requires-Dist: aiodynamo==23.10.1
+Requires-Dist: aiohttp==3.8.6
+Requires-Dist: fastapi==0.95.1
+Requires-Dist: litellm==1.15.7
+Requires-Dist: numpy==1.26.1
+Requires-Dist: openai==1.3.5
+Requires-Dist: pydantic==1.10.7
+Requires-Dist: python-dateutil==2.8.2
+Requires-Dist: python-dotenv==1.0.0
+Requires-Dist: redis==5.0.1
+Requires-Dist: requests==2.31.0
+Requires-Dist: tiktoken==0.5.2
+Requires-Dist: twilio==8.9.0
+Requires-Dist: uvicorn==0.22.0
+Requires-Dist: uvloop==0.19.0
+Requires-Dist: websockets==10.4
+Provides-Extra: dev
+Requires-Dist: pip-tools; extra == "dev"
+
+<h1 align="center">
+</h1>
+<p align="center">
+  <p align="center"><b>End-to-end open-source voice agents platform</b>: Quickly build LLM based voice driven conversational applications</p>
+</p>
+
+<h4 align="center">
+  <a href="https://discord.gg/6fTq2F9s">Discord</a> |
+  <a href="https://docs.bolna.dev">Docs</a> |
+  <a href="https://bolna.dev">Website</a>
+</h4>
+
+<h4 align="center">
+  <a href="https://github.com/bolna-ai/bolna/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Bolna is released under the MIT license." />
+  </a>
+  <a href="https://github.com/bolna-ai/bolna/blob/main/CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
+  </a>
+</h4>
+
+
+## Introduction
+
+**[Bolna](https://bolna.dev)** is the end--to-end open source production ready framework for quickly building LLM based voice driven conversational applications.
+
+
+## Demo
+https://github.com/bolna-ai/bolna/assets/1313096/2237f64f-1c5b-4723-b7e7-d11466e9b226
+
+
+
+## Components
+Bolna helps you create AI Voice Agents which can be instructed to do tasks beginning with:
+
+1. Initiating a phone call using telephony providers like `Twilio`, etc.
+2. Transcribing the conversations using `Deepgram`, etc.
+3. Using LLMs like `OpenAI`, etc to handle conversations
+4. Synthesizing LLM responses back to telephony using `AWS Polly`, `XTTS`, etc.
+5. Instructing the Agent to perform tasks like sending emails, text messages, booking calendar after the conversation has ended
+
+Refer to the [docs](https://docs.bolna.dev) for a deepdive into all supported providers.
+
+
+## Agents
+This repo contains the following types of agents in the `agents/agent_types` directory which can be used to create conversational applications:
+
+1. `contextual_conversational_agent`: LLM-based free flow agent
+2. `graph_based_conversational_agent`: LLM-based agent with classification
+3. `extraction_agent`: Currently WIP. [Feel free to contribute and open a PR](https://github.com/bolna-ai/bolna/compare)
+
+
+## Local setup
+A basic local setup uses Twilio for telephony. We have dockerized the setup in `local_setup/`. One will need to populate an environment `.env` file from `.env.sample`.
+
+The setup consists of four containers:
+
+1. Twilio web server: for initiating the calls one will need to set up a [Twilio account](https://www.twilio.com/docs/usage/tutorials/how-to-use-your-free-trial-account)
+2. Bolna server: for creating and handling agents 
+3. `ngrok`: for tunneling. One will need to add the `authtoken` to `ngrok-config.yml`
+4. `redis`: for persisting agents & users contextual data
+
+Running `docker-compose up --build` will use the `.env` as the environment file and the `agent_data` to start all containers.
+
+Once the docker containers are up, you can now start to create your agents and instruct them to initiate calls.
+
+
+## Agent Examples
+The repo contains examples as a reference for creating for application agents in the `agent_data` directory:
+
+1. `airbnb_job`: A `streaming` `conversation` agent where the agent screens potential candidates for a job at AirBnB
+2. `sorting_hat`: A `preprocessed` `conversation` agent which acts as a Sorting Hat for Hogwarts
+3. `yc_screening`: A `streaming` `conversation` agent which acts as a Y Combinator partner asking questions around the idea/startup
+4. `indian_elections_vernacular`: A `streaming` `conversation` agent which asks people for their outlook towards Indian elections in Hindi language
+5. `sample_agent`: A boilerplate sample agent to start building your own agent!
+
+
+## Anatomy of an agent
+All agents are read from the `agent_data` directory. We have provided some samples for getting started. There's a dashboard coming up [still in WIP] which will easily facilitate towards creating agents.
+
+General structure of the agents:
+
+    your-awesome-agent-name
+    ├── conversation_details.json         # Compiled prompt
+    └── users.json                        # List of users that the call would be made to
+
+| Agent type    | `streaming` agent                                                              | `preprocessed` agent                                                                                                                                                                                     |
+|---------------|--------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Introduction  | A streaming agent will work like a free-flow conversation following the prompt | Apart from following the prompt, a preprocessed agent will have all responses <br/>from the agent preprocessed in the form of audio which will be streamed <br/>as per the classification of human's response |
+| Prompt        | Required (defined in `conversation_details.json`)                              | Required (defined in `conversation_details.json`)                                                                                                                                                        |
+| Preprocessing | Not required                                                                   | Required (using `scripts/preprocessed.py`)                                                                                                                                                               |
+
+
+> [!note]
+> Currently, the `users.json` has the following user attributes which gets substituted in the prompt to make it customized for the call. More to be added soon! 
+> - first_name
+> - last_name
+> - honorific
+> 
+> 
+> 
+> For instance, in the case of a preprocessed agent, the initial intro could be customized to have the user's name.
+> 
+> Even the prompt could be customized to fill in user contextual details from users.json. For example, [{first_name} defined in prompt](https://github.com/bolna-ai/bolna/blob/master/agent_data/airbnb_job/conversation_details.json#L3) and [prompt intro](https://github.com/bolna-ai/bolna/blob/master/agent_data/sorting_hat/conversation_details.json#L10)
+
+
+## Setting up your agent
+1. Create a directory under `agent_data` directory with the name for your agent
+2. Create your prompt and save in a file called `conversation_details.json` using the example provided
+3. Optional: In case if you are creating a `preprocessed` agent, generate the audio data used by using the script `scripts/preprocess.py`
+
+
+## Creating your agent and invoking calls
+1. At this point, the docker containers should be up and running
+2. Your agent prompt should be defined in the `agent_data/` directory with `conversation_details.json` with the user list in `users.json`
+3. Create your agent using the [Bolna Create Agent API](https://docs.bolna.dev/api-reference/endpoint/create). An agent will get created with an `agent_id`
+4. Instruct the agent to initiate call to users via `scripts/initiate_agent_call.py <agent_name> <agent_id>`
+
+
+## Open-source v/s Paid
+Though the repository is completely open source, you can connect with us if interested in managed offerings or more customized solutions.
+
+<a href="https://calendly.com/bolna/30min"><img alt="Schedule a meeting" src="https://cdn.cookielaw.org/logos/122ecfc3-4694-42f1-863f-2db42d1b1e68/0bcbbcf4-9b83-4684-ba59-bc913c0d5905/c21bea90-f4f1-43d1-8118-8938bbb27a9d/logo.png" /></a>
+
+
+## Contributing
+We love all types of contributions: whether big or small helping in improving this community resource.
+
+1. There are a number of [open issues present](https://github.com/bolna-ai/bolna/issues) which can be good ones to start with
+2. If you have suggestions for enhancements, wish to contribute a simple fix such as correcting a typo, or want to address an apparent bug, please feel free to initiate a new issue or submit a pull request
+2. If you're contemplating a larger change or addition to this repository, be it in terms of its structure or the features, kindly begin by creating a new issue [open a new issue :octocat:](https://github.com/bolna-ai/bolna/issues/new) and outline your proposed changes. This will allow us to engage in a discussion before you dedicate a significant amount of time or effort. Your cooperation and understanding are appreciated

bolna-0.6.3/README.md

@@ -0,0 +1,131 @@
+<h1 align="center">
+</h1>
+<p align="center">
+  <p align="center"><b>End-to-end open-source voice agents platform</b>: Quickly build LLM based voice driven conversational applications</p>
+</p>
+
+<h4 align="center">
+  <a href="https://discord.gg/6fTq2F9s">Discord</a> |
+  <a href="https://docs.bolna.dev">Docs</a> |
+  <a href="https://bolna.dev">Website</a>
+</h4>
+
+<h4 align="center">
+  <a href="https://github.com/bolna-ai/bolna/blob/main/LICENSE">
+    <img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="Bolna is released under the MIT license." />
+  </a>
+  <a href="https://github.com/bolna-ai/bolna/blob/main/CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-Welcome-brightgreen" alt="PRs welcome!" />
+  </a>
+</h4>
+
+
+## Introduction
+
+**[Bolna](https://bolna.dev)** is the end--to-end open source production ready framework for quickly building LLM based voice driven conversational applications.
+
+
+## Demo
+https://github.com/bolna-ai/bolna/assets/1313096/2237f64f-1c5b-4723-b7e7-d11466e9b226
+
+
+
+## Components
+Bolna helps you create AI Voice Agents which can be instructed to do tasks beginning with:
+
+1. Initiating a phone call using telephony providers like `Twilio`, etc.
+2. Transcribing the conversations using `Deepgram`, etc.
+3. Using LLMs like `OpenAI`, etc to handle conversations
+4. Synthesizing LLM responses back to telephony using `AWS Polly`, `XTTS`, etc.
+5. Instructing the Agent to perform tasks like sending emails, text messages, booking calendar after the conversation has ended
+
+Refer to the [docs](https://docs.bolna.dev) for a deepdive into all supported providers.
+
+
+## Agents
+This repo contains the following types of agents in the `agents/agent_types` directory which can be used to create conversational applications:
+
+1. `contextual_conversational_agent`: LLM-based free flow agent
+2. `graph_based_conversational_agent`: LLM-based agent with classification
+3. `extraction_agent`: Currently WIP. [Feel free to contribute and open a PR](https://github.com/bolna-ai/bolna/compare)
+
+
+## Local setup
+A basic local setup uses Twilio for telephony. We have dockerized the setup in `local_setup/`. One will need to populate an environment `.env` file from `.env.sample`.
+
+The setup consists of four containers:
+
+1. Twilio web server: for initiating the calls one will need to set up a [Twilio account](https://www.twilio.com/docs/usage/tutorials/how-to-use-your-free-trial-account)
+2. Bolna server: for creating and handling agents 
+3. `ngrok`: for tunneling. One will need to add the `authtoken` to `ngrok-config.yml`
+4. `redis`: for persisting agents & users contextual data
+
+Running `docker-compose up --build` will use the `.env` as the environment file and the `agent_data` to start all containers.
+
+Once the docker containers are up, you can now start to create your agents and instruct them to initiate calls.
+
+
+## Agent Examples
+The repo contains examples as a reference for creating for application agents in the `agent_data` directory:
+
+1. `airbnb_job`: A `streaming` `conversation` agent where the agent screens potential candidates for a job at AirBnB
+2. `sorting_hat`: A `preprocessed` `conversation` agent which acts as a Sorting Hat for Hogwarts
+3. `yc_screening`: A `streaming` `conversation` agent which acts as a Y Combinator partner asking questions around the idea/startup
+4. `indian_elections_vernacular`: A `streaming` `conversation` agent which asks people for their outlook towards Indian elections in Hindi language
+5. `sample_agent`: A boilerplate sample agent to start building your own agent!
+
+
+## Anatomy of an agent
+All agents are read from the `agent_data` directory. We have provided some samples for getting started. There's a dashboard coming up [still in WIP] which will easily facilitate towards creating agents.
+
+General structure of the agents:
+
+    your-awesome-agent-name
+    ├── conversation_details.json         # Compiled prompt
+    └── users.json                        # List of users that the call would be made to
+
+| Agent type    | `streaming` agent                                                              | `preprocessed` agent                                                                                                                                                                                     |
+|---------------|--------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Introduction  | A streaming agent will work like a free-flow conversation following the prompt | Apart from following the prompt, a preprocessed agent will have all responses <br/>from the agent preprocessed in the form of audio which will be streamed <br/>as per the classification of human's response |
+| Prompt        | Required (defined in `conversation_details.json`)                              | Required (defined in `conversation_details.json`)                                                                                                                                                        |
+| Preprocessing | Not required                                                                   | Required (using `scripts/preprocessed.py`)                                                                                                                                                               |
+
+
+> [!note]
+> Currently, the `users.json` has the following user attributes which gets substituted in the prompt to make it customized for the call. More to be added soon! 
+> - first_name
+> - last_name
+> - honorific
+> 
+> 
+> 
+> For instance, in the case of a preprocessed agent, the initial intro could be customized to have the user's name.
+> 
+> Even the prompt could be customized to fill in user contextual details from users.json. For example, [{first_name} defined in prompt](https://github.com/bolna-ai/bolna/blob/master/agent_data/airbnb_job/conversation_details.json#L3) and [prompt intro](https://github.com/bolna-ai/bolna/blob/master/agent_data/sorting_hat/conversation_details.json#L10)
+
+
+## Setting up your agent
+1. Create a directory under `agent_data` directory with the name for your agent
+2. Create your prompt and save in a file called `conversation_details.json` using the example provided
+3. Optional: In case if you are creating a `preprocessed` agent, generate the audio data used by using the script `scripts/preprocess.py`
+
+
+## Creating your agent and invoking calls
+1. At this point, the docker containers should be up and running
+2. Your agent prompt should be defined in the `agent_data/` directory with `conversation_details.json` with the user list in `users.json`
+3. Create your agent using the [Bolna Create Agent API](https://docs.bolna.dev/api-reference/endpoint/create). An agent will get created with an `agent_id`
+4. Instruct the agent to initiate call to users via `scripts/initiate_agent_call.py <agent_name> <agent_id>`
+
+
+## Open-source v/s Paid
+Though the repository is completely open source, you can connect with us if interested in managed offerings or more customized solutions.
+
+<a href="https://calendly.com/bolna/30min"><img alt="Schedule a meeting" src="https://cdn.cookielaw.org/logos/122ecfc3-4694-42f1-863f-2db42d1b1e68/0bcbbcf4-9b83-4684-ba59-bc913c0d5905/c21bea90-f4f1-43d1-8118-8938bbb27a9d/logo.png" /></a>
+
+
+## Contributing
+We love all types of contributions: whether big or small helping in improving this community resource.
+
+1. There are a number of [open issues present](https://github.com/bolna-ai/bolna/issues) which can be good ones to start with
+2. If you have suggestions for enhancements, wish to contribute a simple fix such as correcting a typo, or want to address an apparent bug, please feel free to initiate a new issue or submit a pull request
+2. If you're contemplating a larger change or addition to this repository, be it in terms of its structure or the features, kindly begin by creating a new issue [open a new issue :octocat:](https://github.com/bolna-ai/bolna/issues/new) and outline your proposed changes. This will allow us to engage in a discussion before you dedicate a significant amount of time or effort. Your cooperation and understanding are appreciated

bolna-0.6.3/bolna/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.3"

bolna-0.6.3/bolna/agent_manager/__init__.py

@@ -0,0 +1,3 @@
+from .base_manager import BaseManager
+from .task_manager import TaskManager
+from .assistant_manager import AssistantManager

bolna-0.6.3/bolna/agent_manager/assistant_manager.py

@@ -0,0 +1,53 @@
+import asyncio
+import uvloop
+import time
+import os
+from twilio.rest import Client
+import requests
+import tiktoken
+from .base_manager import BaseManager
+from .task_manager import TaskManager
+
+# Find your Account SID and Auth Token at twilio.com/console
+# and set the environment variables. See http://twil.io/secure
+account_sid = os.environ['TWILIO_ACCOUNT_SID']
+auth_token = os.environ['TWILIO_AUTH_TOKEN']
+client = Client(account_sid, auth_token)
+enc = tiktoken.get_encoding("cl100k_base")
+
+
+class AssistantManager(BaseManager):
+    def __init__(self, agent_config, ws, context_data=None, user_id=None, assistant_id=None,
+                 connected_through_dashboard=None, log_dir_name=None):
+        super().__init__(log_dir_name=log_dir_name)
+        self.log_dir_name = log_dir_name
+        self.tools = {}
+        self.websocket = ws
+        self.agent_config = agent_config
+        self.context_data = context_data
+        self.tasks = agent_config.get('tasks', [])
+        self.task_states = [False] * len(self.tasks)
+        self.user_id = user_id
+        self.assistant_id = assistant_id
+        self.run_id = f"{self.assistant_id}#{str(int(time.time() * 1000))}"
+        self.connected_through_dashboard = connected_through_dashboard
+
+    async def run(self, is_local=False):
+        '''
+        Run will start all tasks in sequential format
+        '''
+        asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
+        input_parameters = None
+        for task_id, task in enumerate(self.tasks):
+            task_manager = TaskManager(self.agent_config["assistant_name"], task_id, task, self.websocket,
+                                       context_data=self.context_data, input_parameters=input_parameters,
+                                       user_id=self.user_id, assistant_id=self.assistant_id, run_id=self.run_id,
+                                       connected_through_dashboard=self.connected_through_dashboard,
+                                       log_dir_name=self.log_dir_name)
+            await task_manager.load_prompt(self.agent_config["assistant_name"], task_id, is_local=is_local)
+            task_output = await task_manager.run()
+            task_output['run_id'] = self.run_id
+            yield task_id, task_output
+            self.task_states[task_id] = True
+            input_parameters = task_output
+        self.logger.info("Done with execution of the agent")

bolna-0.6.3/bolna/agent_manager/base_manager.py

@@ -0,0 +1,8 @@
+from bolna.helpers.logger_config import CustomLogger
+
+custom_logger = CustomLogger(__name__)
+
+
+class BaseManager:
+    def __init__(self, log_dir_name=None):
+        self.logger = custom_logger.update_logger(log_dir_name=log_dir_name)