Update app.py

app.py

@@ -7,7 +7,88 @@ from tools.final_answer import FinalAnswerTool
 
 from Gradio_UI import GradioUI
 
-# Below is an example of a tool that does nothing. Amaze us with your creativity !
+
+from typing import Optional, Dict, Any
+import requests
+from pydantic import BaseModel, Field, validator
+
+class PDOKLocationSearchInput(BaseModel):
+    """Input for the PDOK location search tool."""
+    postal_code: Optional[str] = Field(None, description="Postal code in the format '1234 AA'.")
+    house_number: Optional[str] = Field(None, description="House number.")
+    street_name: Optional[str] = Field(None, description="Street name.")
+    city: Optional[str] = Field(None, description="City name.")
+
+    @validator("postal_code")
+    def validate_postal_code(cls, v):
+        if v is not None and (len(v) != 7 or not v[0:4].isdigit() or v[4] != " " or not v[5:7].isalpha()):
+            raise ValueError("Invalid postal code format.  It must be '1234 AA'.")
+        return v
+
+    def construct_query(self) -> str:
+        """Constructs the query string based on provided inputs."""
+        if self.postal_code and self.house_number:
+            return f"{self.postal_code} {self.house_number}"
+        elif self.street_name and self.city and self.house_number:
+            return f"{self.street_name} {self.house_number}, {self.city}"
+        else:
+            return ""  # Will raise error in the tool itself
+
+@tool
+def pdok_location_search(input_data: PDOKLocationSearchInput) -> str:
+    """A tool that queries the PDOK API to find the province related to an adress in the Netherlands.
+
+    Args:
+        input_data:  Input parameters, provide either 'postal_code' and 'house_number' OR 'street_name', 'city', and 'house_number'.
+    """
+    base_url = "https://api.pdok.nl/bzk/locatieserver/search/v3_1/free"
+    headers = {"accept": "application/json"}
+
+    query_string = input_data.construct_query()
+    if not query_string:
+        return "Please provide either a postal code and house number, or a street name, city, and house number."
+    
+    params = {
+        "q": query_string,
+        "fl": "provincienaam",  # Only fetch provincienaam
+        "fq": "type:(gemeente OR woonplaats OR weg OR postcode OR adres)",
+        "df": "tekst",
+        "bq": "type:provincie^1.5",
+        "bq": "type:gemeente^1.5",
+        "bq": "type:woonplaats^1.5",
+        "bq": "type:weg^1.5",
+        "bq": "type:postcode^0.5",
+        "bq": "type:adres^1",
+        "start": 0,
+        "rows": 10,
+        "sort": "score desc,sortering asc,weergavenaam asc",
+        "wt": "json",
+    }
+
+    try:
+        response = requests.get(base_url, params=params, headers=headers)
+        response.raise_for_status()  # Raise HTTPError for bad responses (4xx or 5xx)
+        data = response.json()
+
+        docs = data.get("response", {}).get("docs", [])
+        if not docs:
+            return "No results found for the given query."
+
+        # Extract and return the 'provincienaam' from the first result.
+        first_result = docs[0]
+        provincie_naam = first_result.get("provincienaam")
+
+        if provincie_naam:
+              return f"The province is: {provincie_naam}"
+        else:
+            return "Provincienaam not found in the API response."
+
+
+    except requests.exceptions.RequestException as e:
+        return f"Error during API request: {e}"
+    except (ValueError, KeyError) as e:
+        return f"Error processing API response: {e}"
+
 @tool
 def my_custom_tool(arg1:str, arg2:int)-> str: #it's import to specify the return type
     #Keep this format for the description / args / args description but feel free to modify the tool
@@ -55,7 +136,7 @@ with open("prompts.yaml", 'r') as stream:
     
 agent = CodeAgent(
     model=model,
-    tools=[final_answer, get_current_time_in_timezone], ## add your tools here (don't remove final answer)
+    tools=[final_answer, get_current_time_in_timezone, pdok_location_search], ## add your tools here (don't remove final answer)
     max_steps=6,
     verbosity_level=1,
     grammar=None,