feat: Updated Quickstart

README.md

@@ -57,7 +57,6 @@ The following dangerous builtins are restricted for security:
 - execfile
 - compile
 - importlib
-- __import__
 - input
 - exit
 
@@ -74,16 +73,9 @@ DO NOT use print() statements AT ALL. Avoid mutating variables whenever possible
 
 
 get_sample_data = """
-def get_current_date():
-    \"\"\" Get the current date.
-
-    Returns:
-    - Current date in YYYY-MM-DD format
-    \"\"\"
-    pass
-
-def check_availability(day: str, start_time: str, end_time: str):
-    \"\"\" Check if a time slot is available on a given day.
+def check_availability(day: str, start_time: str, end_time: str) -> bool:
+    \"\"\" 
+    Check if a time slot is available on a given day.
 
     Args:
     - day: The day to check in YYYY-MM-DD format
@@ -95,8 +87,9 @@ def check_availability(day: str, start_time: str, end_time: str):
     \"\"\"
     pass
 
-def make_appointment(day: str, start_time: str, end_time: str):
-    \"\"\" Make an appointment for a given time slot.
+def make_appointment(day: str, start_time: str, end_time: str) -> dict:
+    \"\"\" 
+    Make an appointment for a given time slot.
 
     Args:
     - day: The day to make appointment in YYYY-MM-DD format
@@ -105,7 +98,24 @@ def make_appointment(day: str, start_time: str, end_time: str):
     - title: The title of the appointment
 
     Returns:
-    - True if appointment was made successfully, False otherwise
+    - A dictionary with the appointment details and if it's made or not.
+        dict keys:
+            - day (str): The day the appointment is on, in YYYY-MM-DD format
+            - start_time (str): Start time in HH:MM format
+            - end_time (str): End time in HH:MM format
+            - appointment_made (bool): Whether the appointment is successfully made or not. 
+    \"\"\"
+    pass
+
+def add_to_reminders(reminder_text: str) -> bool:
+    \"\"\" 
+    Add a text to reminders.
+
+    Args: 
+    - reminder_text: The text to add to reminders
+
+    Returns:
+    - Whether the reminder was successfully created or not.
     \"\"\"
     pass
 """
@@ -116,9 +126,14 @@ def format_prompt(tools: str):
 
 system_prompt = SYSTEM_PROMPT.replace("{{functions_schema}}", get_sample_data)
 
+USER_QUERY = """
+Can you check if I have tomorrow 10:00-12:00 available and make an appointment for a meeting 
+with my thesis supervisor if so? If you made the appointment, please add it to my reminders.
+"""
+
 messages = [
     {"role": "system", "content": system_prompt},
-    {"role": "user", "content": "Can you check if I have tomorrow 10:00-12:00 available and make an appointment for a meeting with my thesis supervisor if so?"},
+    {"role": "user", "content": USER_QUERY},
 ]
 
 text = tokenizer.apply_chat_template(
@@ -143,35 +158,44 @@ print(response)
 The output should be something like:
 
 ````
-To accomplish this task, we need to follow these steps:
+I'll help you check availability and make the appointment. Let's break this down into steps:
 
-1. Determine the current date and add one day to it to find tomorrow's date.
-2. Check the availability of the time slot from 10:00 to 12:00 on that day.
-3. If the slot is available, make an appointment for the meeting.
+1. First, we need to check if tomorrow's 10:00-12:00 time slot is available using check_availability()
+2. If available, we'll make the appointment using make_appointment()
+3. Finally, we'll add the appointment to reminders if it was successfully made
 
-Here's the Python code to achieve this:
+Here's the code to accomplish this:
 
 ```python
 from datetime import datetime, timedelta
 
-# Step 1: Determine the current date and add one day to get tomorrow's date
-current_date = get_current_date()
-tomorrow_date = (datetime.strptime(current_date, '%Y-%m-%d') + timedelta(days=1)).strftime('%Y-%m-%d')
+# Calculate tomorrow's date
+tomorrow = (datetime.now() + timedelta(days=1)).strftime("%Y-%m-%d")
 
-# Step 2: Check the availability of the time slot from 10:00 to 12:00 on that day
-slot_start_time = '10:00'
-slot_end_time = '12:00'
-is_slot_available = check_availability(tomorrow_date, slot_start_time, slot_end_time)
+# Check availability for 10:00-12:00
+available = check_availability(tomorrow, "10:00", "12:00")
 
-# Step 3: If the slot is available, make an appointment for the meeting
-appointment_title = "Meeting with thesis supervisor"
-appointment_made = False
+# If available, make the appointment
+appointment_details = make_appointment(
+    day=tomorrow,
+    start_time="10:00",
+    end_time="12:00",
+    title="Meeting with thesis supervisor"
+)
 
-if is_slot_available:
-    appointment_made = make_appointment(tomorrow_date, slot_start_time, slot_end_time, appointment_title)
+# Add appointment to reminders if it was successfully made
+if appointment_details["appointment_made"]:
+    reminder_text = f"Meeting with thesis supervisor on {tomorrow} from 10:00-12:00"
+    add_to_reminders(reminder_text)
 ```
 
-This code first calculates tomorrow's date, then checks if the time slot from 10:00 to 12:00 is available, and finally makes an appointment if the slot is available.
+This code will:
+1. Calculate tomorrow's date in YYYY-MM-DD format
+2. Check if the 10:00-12:00 slot is available
+3. If available, make the appointment with the specified details
+4. If the appointment is successfully made, add a reminder to the system
+
+The code handles all error cases implicitly through the boolean returns of the functions. If any step fails, the subsequent steps won't execute, preventing partial or invalid appointments.
 ````
 
 ## Evaluation & Performance