Some major changes. Incorporating Gradio Blocks. Incorporating db logging.

app.py

@@ -1,41 +1,70 @@
-#!/usr/bin/env python
 """
 Travel planner based on Agentic AI workflow.
 
 This module deploys a portal which can customize a day to day travel itinerary
 for a person using multiple specialized AI crews.
 
-Implemented using Gradio and Crew AI
+Implemented using Sambanova Cloud, Gradio and Crew AI.
 A deployment is available at https://huggingface.co/spaces/sambanovasystems/trip-planner
 """
 
+import datetime
 import json
 import logging
-import datetime
 from typing import List, Tuple
 
 import gradio as gr
 import plotly.graph_objects as go
+
 from crew import AddressSummaryCrew, TravelCrew
+from db import log_query
+from fpdf import FPDF
+
+def export_pdf(input_text:str):
+    """
+    Create a downloadable pdf for the given input text
 
+    Args:
+         input_text: The text that needs to be made a pdf
+
+    Result:
+         Downloadable pdf
+    """
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("helvetica", size=12)
+
+    for line in input_text.split('\n'):
+        clean_line = line.strip()
+        if clean_line.startswith('**'):
+            pdf.set_font("Arial", size=12, style='B')
+            pdf.multi_cell(0, 5, clean_line[2:].lstrip()[:-2].rstrip())
+            pdf.set_font("Arial", size=12, style='')
+        else:
+            pdf.multi_cell(0, 5, clean_line)
+
+    pdf.output("output.pdf")
+    return "output.pdf"
 
 def filter_map(text_list: List[str], lat: List[str], lon: List[str]) -> go.Figure:
     """
     Create a Map showing the points specified in the inputs.
 
     Args:
-        text_list: List of the description of all locations that will be shown on the map
-        lat:       List of latitude coordinates of the locations
-        lon:       List of longitude coordinates of the locations
+        text_list: List of the description of all locations that will be shown on the map.
+        lat:       List of latitude coordinates of the locations.
+        lon:       List of longitude coordinates of the locations.
 
     Returns:
         Figure: Map with the points specified in the inputs
     """
 
+    # Creating a map with the provided markers using their latitude and longitude coordinates.
     fig = go.Figure(
         go.Scattermapbox(lat=lat, lon=lon, mode='markers', marker=go.scattermapbox.Marker(size=11), hovertext=text_list)
     )
 
+    # Update the map by centering it on of the the provided longitude and latitude coordinates
     fig.update_layout(
         mapbox_style='open-street-map',
         hovermode='closest',
@@ -56,17 +85,17 @@ def run(
     budget: int,
 ) -> Tuple[str, go.Figure]:
     """
-    Run the specfied query using Crew AI agents
+    Run the specfied query using Crew AI agents.
 
     Args:
-        origin: Origin city of the traveller
-        destination: Destination that traveller is going to
-        arrival_date: Approximate date when the trip will begin in epoch time
-        age: Age profile of traveller
-        interests: Specific interests of the traveller
-        cuisine_preferences: Specific cuisine preferences of the traveller
-        children: Whether traveller has children travelling with them
-        budget: Total budget of traveller in US Dollars
+        origin: Origin city of the traveller.
+        destination: Destination to which the traveller is going.
+        arrival_date: Approximate date when the trip will begin in epoch time.
+        age: Age profile of traveller.
+        interests: Specific interests of the traveller.
+        cuisine_preferences: Specific cuisine preferences of the traveller.
+        children: Whether traveller has children travelling with them.
+        budget: Total budget of traveller in US Dollars.
 
     Returns:
         Returns a tuple containing the itinerary and map
@@ -75,12 +104,18 @@ def run(
         arrival_date_input = datetime.datetime.fromtimestamp(arrival_date).strftime("%m-%d-%Y")
     else:
         arrival_date_input = None
-
+    log_query(origin, destination, age, trip_duration, budget)
     logger.info(
-        f'Origin: {origin}, Destination: {destination}, Arrival Date: {arrival_date_input}, Age: {age}, Duration: {trip_duration},'
-        f' Interests: {interests}, Cuisines: {cuisine_preferences}, Children: {children}, Daily Budget: {budget}'
+        f'Origin: {origin}, Destination: {destination}, Arrival Date: {arrival_date_input},'
+        f' Age: {age}, Duration: {trip_duration},'
+        f' Interests: {interests}, Cuisines: {cuisine_preferences},'
+        f' Children: {children}, Daily Budget: {budget}'
     )
-    inputs = {
+
+    # Creating a dictionary of user provided preferences and providing these to the crew agents
+    # to work on.
+
+    user_preferences = {
         'origin': origin,
         'destination': destination,
         'arrival_date': arrival_date_input,
@@ -91,22 +126,35 @@ def run(
         'children': children,
         'budget': budget,
     }
-    result = TravelCrew().crew().kickoff(inputs=inputs)
+    result = TravelCrew().crew().kickoff(inputs=user_preferences)
+
+    """
+        Now we will pass the result to a address summary crew whose job is to extract position
+        coordinates of the addresses (latitude and longitude), so that the addresses in the
+        result can be displayed in map coordinates
+    """
+
     inputs_for_address = {'text': str(result)}
 
     addresses = AddressSummaryCrew().crew().kickoff(inputs=inputs_for_address)
+
+    """
+        We have requested the crew agent to return latitude, longitude coordinates.
+        But the exact way the LLMs return varies. Hence we try multiple different ways of
+        extracting addresses in JSON format from the result.
+    """
     json_addresses = None
-    if addresses.json_dict:
+    if addresses.json_dict is not None:
         json_addresses = addresses.json_dict
-    if not json_addresses:
+    if json_addresses is None:
         try:
             json_addresses = json.loads(addresses.raw)
         except json.JSONDecodeError as e:
-            # Try with different format of result data generated with ```json and ending with ```
+            # Try with different format of result data generated with ```json and ending with ```.
             try:
                 json_addresses = json.loads(addresses.raw[8:-4])
             except json.JSONDecodeError as e:
-                # Try with different format of result data generated with ``` and ending with ```
+                # Try with different format of result data generated with ``` and ending with ```.
                 try:
                     json_addresses = json.loads(addresses.raw[4:-4])
                 except json.JSONDecodeError as e:
@@ -120,50 +168,56 @@ def run(
 logger = logging.getLogger()
 logger.setLevel(logging.INFO)
 
-demo = gr.Interface(
-    title='Plan your itinerary with the help of AI',
-    description='Use this app to create a detailed itinerary on how to explore a new place.'
-    ' Itinerary is customized to your taste. Powered by Sambanova Cloud.',
-    fn=run,
-    inputs=[
-        gr.Textbox(label='Where are you travelling from?'),
-        gr.Textbox(label='Where are you going?'),
-        gr.DateTime(label="Approximate arrival date"),
-        gr.Slider(label='Your age?', value=30, minimum=15, maximum=90, step=5),
-        gr.Slider(label='How many days are you travelling?', value=5, minimum=1, maximum=14, step=1),
-        gr.CheckboxGroup(
-            ['Museums', 'Shopping', 'Entertainment', 'Nightlife', 'Outdoor Adventures'],
-            label='Checkbox your specific interests.',
-        ),
-        gr.CheckboxGroup(
-            [
-                'Ethnic',
-                'American',
-                'Italian',
-                'Mexican',
-                'Chinese',
-                'Japanese',
-                'Indian',
-                'Thai',
-                'French',
-                'Vietnamese',
-                'Vegan',
-            ],
-            label='Checkbox your cuisine preferences.',
-        ),
-        gr.Checkbox(label='Check if children are travelling with you'),
-        gr.Slider(
-            label='Total budget of trip in USD', show_label=True, value=1000, minimum=500, maximum=10000, step=500
-        ),
-    ],
-    outputs=[
-        gr.Textbox(
-            label='Complete Personalized Itinerary of your Trip',
-            show_label=True,
-            show_copy_button=True,
-            autoscroll=False,
-        ),
-        gr.Plot(label='Venues on a Map. Please verify with a Navigation System before traveling.'),
-    ],
-)
+with gr.Blocks() as demo:
+    gr.Markdown('Use this app to create a detailed itinerary on how to explore a new place.'
+                ' Itinerary is customized to your taste. Powered by Sambanova Cloud.')
+    with gr.Row():
+        with gr.Column(scale=1):
+            inp_source = gr.Textbox(label='Where are you travelling from?')
+            inp_dest = gr.Textbox(label='Where are you going?')
+            inp_cal = gr.DateTime(label='Approximate arrival date')
+            inp_age = gr.Slider(label='Your age?', value=30, minimum=15, maximum=90, step=5)
+            inp_days = gr.Slider(label='How many days are you travelling?', value=5, minimum=1, maximum=14, step=1)
+            inp_cuisine =\
+            gr.CheckboxGroup(
+                [
+                    'Ethnic',
+                    'American',
+                    'Italian',
+                    'Mexican',
+                    'Chinese',
+                    'Japanese',
+                    'Indian',
+                    'Thai',
+                    'French',
+                    'Vietnamese',
+                    'Vegan',
+               ],
+               label='Checkbox your cuisine preferences.',
+            )
+            inp_children = gr.Checkbox(label='Check if children are travelling with you')
+            inp_budget =\
+               gr.Slider(
+               label='Total budget of trip in USD', show_label=True, value=1000, minimum=500, maximum=10000, step=500
+            )
+            button = gr.Button("Plan your Trip")
+            inputs = [inp_source, inp_dest, inp_cal, inp_age, inp_days, inp_cuisine, inp_children, inp_budget]
+
+        with gr.Column(scale=2):
+            output_itinerary =\
+            gr.Textbox(
+                label='Complete Personalized Itinerary of your Trip',
+                show_label=True,
+                show_copy_button=True,
+                autoscroll=False,
+            )
+            download_btn = gr.Button("Download Itinerary")
+
+            output_map = gr.Plot(label='Venues on a Map. Please verify with a Navigation System before traveling.')
+            output = [output_itinerary, output_map]
+
+            button.click(fn=run, inputs=inputs, outputs=output)
+            download_btn_hidden = gr.DownloadButton(visible=False, elem_id="download_btn_hidden")
+            download_btn.click(fn=export_pdf, inputs=output_itinerary, outputs=[download_btn_hidden]).then(fn=None, inputs=None, outputs=None, js="() => document.querySelector('#download_btn_hidden').click()")
+
 demo.launch()

config/address_agents.yaml

@@ -1,8 +1,8 @@
 address_summarizer:
   role: >
-    Summarize Addresses into Latitude and Longitude coordinates 
+    Summarize Addresses into Latitude and Longitude coordinates.
   goal: >
-    You need to extract addresses from a provided text and convert those addresses into latitude and longitude coordinates so that they can be easily shown on a map
+    You need to extract addresses from a provided text and convert those addresses into latitude and longitude coordinates so that they can be easily shown on a map.
   backstory: >
-    You are skilled at extracting addresses from lines of text into latitude and longitude coordinates
+    You are skilled at extracting addresses from lines of text into latitude and longitude coordinates.
 

config/address_tasks.yaml

@@ -1,6 +1,6 @@
 address_compilation_task:
   description: >
-    Extract the list of addresses from {text} in convert them to latitudes and longitudes.
+    Extract the list of addresses from {text} and convert them to latitudes and longitudes.
 
   expected_output: >
-    Output is expected in simple JSON format with three lists. The first list should contain the name of the venue or the name of the restaurant and should be indexed by the keyword "name". The second list should contain the latitudes and indexed with the keyword "lat". The third list should contain the longitudes and indexed with the keyword "lon".
+    Output is expected in simple JSON format with three lists. The first list should contain the name of the venue or the name of the restaurant or the activity and should be indexed by the keyword "name". The second list should contain the latitudes and indexed with the keyword "lat". The third list should contain the longitudes and indexed with the keyword "lon".

config/agents.yaml

@@ -2,7 +2,7 @@ personalized_activity_planner:
   role: >
     Activity Planner
   goal: >
-    Research and find cool things to do at the destination, including activities and events that match the traveler's interests and age group. Create detailed notes on the activity or event. Pay importance to the planned arrival date of the traveller, which will indicate which will indicate the season.
+    Research and find cool things to do at the destination, including activities and events that match the traveler's interests and age group. Create detailed notes on the activity or event.
   backstory: >
     You are skilled at creating personalized itineraries that cater to the specific preferences and demographics of travelers.
 

config/requirements.txt

@@ -0,0 +1,6 @@
+plotly==6.0.0
+crewai==0.100.1
+crewai-tools==0.33.0
+gradio==5.15.0
+gradio_client==1.7.0
+fpdf==1.7.2

config/tasks.yaml

@@ -11,7 +11,7 @@ personalized_activity_planning_task:
     - origin: {origin}
 
     - destination: {destination}
- 
+
     - Approximate arrival data in month-day-year format: {arrival_date}
 
     - Approximate age of the adult travelers: {age}

crew.py

@@ -1,11 +1,17 @@
 """Implementation based on the Crew AI workflow"""
 
+import typing
+
 from crewai import LLM, Agent, Crew, Process, Task
 from crewai.project import CrewBase, agent, crew, task
+
+# Import tools from crewai_tools
+# ScrapWebsiteTool: Extract content of wensite, https://docs.crewai.com/tools/scrapewebsitetool
+# SerperDevTool: Search Internet, https://docs.crewai.com/tools/serperdevtool
 from crewai_tools import ScrapeWebsiteTool, SerperDevTool
 
 # Change the model which you want to use below.
-# Currently, we use the Llama 3.1 70B model because it seems the most versatile
+# Currently, we use the Llama 3.1 70B model because it seems the most versatile.
 llm = LLM(model='sambanova/Meta-Llama-3.1-70B-Instruct')
 
 
@@ -19,6 +25,7 @@ class TravelCrew:
         self.agents_config = 'config/agents.yaml'
         self.tasks_config = 'config/tasks.yaml'
 
+    @typing.no_type_check
     @agent
     def personalized_activity_planner(self) -> Agent:
         """
@@ -34,6 +41,7 @@ class TravelCrew:
             allow_delegation=False,
         )
 
+    @typing.no_type_check
     @agent
     def restaurant_scout(self) -> Agent:
         """
@@ -49,6 +57,7 @@ class TravelCrew:
             allow_delegation=False,
         )
 
+    @typing.no_type_check
     @agent
     def interest_scout(self) -> Agent:
         """
@@ -64,6 +73,7 @@ class TravelCrew:
             allow_delegation=False,
         )
 
+    @typing.no_type_check
     @agent
     def itinerary_compiler(self) -> Agent:
         """
@@ -78,6 +88,7 @@ class TravelCrew:
             allow_delegation=False,
         )
 
+    @typing.no_type_check
     @task
     def personalized_activity_planning_task(self) -> Task:
         """
@@ -92,6 +103,7 @@ class TravelCrew:
             agent=self.personalized_activity_planner(),
         )
 
+    @typing.no_type_check
     @task
     def interest_scout_task(self) -> Task:
         """
@@ -101,6 +113,7 @@ class TravelCrew:
         """
         return Task(config=self.tasks_config['interest_scout_task'], llm=llm, max_iter=1, agent=self.interest_scout())
 
+    @typing.no_type_check
     @task
     def restaurant_scenic_location_scout_task(self) -> Task:
         """
@@ -115,6 +128,7 @@ class TravelCrew:
             agent=self.restaurant_scout(),
         )
 
+    @typing.no_type_check
     @task
     def itinerary_compilation_task(self) -> Task:
         """
@@ -126,6 +140,7 @@ class TravelCrew:
             config=self.tasks_config['itinerary_compilation_task'], llm=llm, max_iter=1, agent=self.itinerary_compiler()
         )
 
+    @typing.no_type_check
     @crew
     def crew(self) -> Crew:
         """
@@ -147,6 +162,7 @@ class AddressSummaryCrew:
     agents_config = 'config/address_agents.yaml'
     tasks_config = 'config/address_tasks.yaml'
 
+    @typing.no_type_check
     @agent
     def address_summarizer(self) -> Agent:
         """
@@ -161,6 +177,7 @@ class AddressSummaryCrew:
             allow_delegation=False,
         )
 
+    @typing.no_type_check
     @task
     def address_compilation_task(self) -> Task:
         """
@@ -175,6 +192,7 @@ class AddressSummaryCrew:
             agent=self.address_summarizer(),
         )
 
+    @typing.no_type_check
     @crew
     def crew(self) -> Crew:
         """

db.py

@@ -0,0 +1,74 @@
+import os
+import sqlite3
+from datetime import datetime
+
+_DB_FILE_NAME = 'query_logs.db'
+
+
+def initialize_database() -> None:
+    """Create database and table if they don't exist"""
+    conn = sqlite3.connect(_DB_FILE_NAME)
+    c = conn.cursor()
+
+    # Create table
+    c.execute("""CREATE TABLE IF NOT EXISTS query_logs
+                 (id INTEGER PRIMARY KEY AUTOINCREMENT,
+                  timestamp DATETIME NOT NULL,
+                  origin TEXT,
+                  destination TEXT NOT NULL,
+                  age INTEGER NOT NULL,
+                  trip_duration INTEGER NOT NULL,
+                  budget INTEGER)""")
+    conn.commit()
+    conn.close()
+
+def retrieve_data():
+    """
+    Retrieves all data fron the table.
+    """
+
+    try:
+       # Connect to the SQLite database
+        conn = sqlite3.connect(_DB_FILE_NAME)
+        cursor = conn.cursor()
+
+        # Retrieve all data from the specified table
+        cursor.execute(f"SELECT * FROM query_logs")
+        data = cursor.fetchall()
+
+        # Close the database connection
+        conn.close()
+        for item in data:
+            print (item)
+
+    except sqlite3.Error as e:
+        print(f"Error: {e}")
+        return None
+
+
+def log_query(origin: str, destination: str,
+              age: int, trip_duration: int, budget: int) -> None:
+    """Log a query to the database"""
+
+    # Check if file exists, if not initialize the db
+    if not os.path.isfile(_DB_FILE_NAME):
+        initialize_database()
+
+    conn = sqlite3.connect(_DB_FILE_NAME)
+    c = conn.cursor()
+
+    # Insert log record
+    c.execute(
+        """INSERT INTO query_logs 
+                 (timestamp, origin, destination, age, trip_duration, budget)
+                 VALUES (?, ?, ?, ?, ?, ?)""",
+        (datetime.now(), origin, destination, age, trip_duration, budget),
+    )
+    conn.commit()
+    conn.close()
+
+"""
+    If this program is executed directly, just print out all the data in the tables
+"""
+if __name__ == "__main__":
+    retrieve_data()