aip-agents-binary 0.6.4__py3-none-any.whl

aip_agents/examples/tools/stock_tools.py

@@ -0,0 +1,82 @@
+"""Defines tools for stock market data.
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+    Raymond Christopher (raymond.christopher@gdplabs.id)
+"""
+
+import random
+from typing import Any
+
+from langchain_core.tools import tool
+from pydantic import BaseModel, Field
+
+from aip_agents.utils.logger import get_logger
+
+logger = get_logger(__name__)
+
+
+class StockPriceInput(BaseModel):
+    """Input for the stock price tool."""
+
+    symbol: str = Field(description="The stock symbol (e.g., AAPL, MSFT) to get the price for.")
+
+
+@tool(args_schema=StockPriceInput)
+def get_stock_price(symbol: str) -> dict[str, Any]:
+    """Get current stock price and performance data for a given symbol.
+
+    Args:
+        symbol (str): The stock symbol (e.g., AAPL, MSFT) to get the price for.
+
+    Returns:
+        dict[str, Any]: Dictionary containing stock price and performance data.
+    """
+    logger.info(f"Getting stock price for {symbol}")
+    # Simulate stock price data
+    price = round(random.uniform(100, 1000), 2)
+    change = round(random.uniform(-10, 10), 2)
+    change_percent = round((change / price) * 100, 2)
+    return {
+        "symbol": symbol.upper(),
+        "price": price,
+        "change": change,
+        "change_percent": change_percent,
+        "currency": "USD",
+    }
+
+
+class StockNewsInput(BaseModel):
+    """Input for the stock news tool."""
+
+    symbol: str = Field(description="The stock symbol (e.g., AAPL, MSFT) to get news for.")
+    days: int = Field(default=7, description="Number of days of news to retrieve.")
+
+
+@tool(args_schema=StockNewsInput)
+def get_stock_news(symbol: str, days: int = 7) -> dict[str, Any]:
+    """Get recent news for a stock for a specified number of days.
+
+    Args:
+        symbol (str): The stock symbol (e.g., AAPL, MSFT) to get news for.
+        days (int, optional): Number of days of news to retrieve. Defaults to 7.
+
+    Returns:
+        dict[str, Any]: Dictionary containing stock news data.
+    """
+    logger.info(f"Getting stock news for {symbol} for the last {days} days")
+    # Simulate news data
+    news_items = [
+        f"{symbol.upper()} announces breakthrough in AI technology",
+        f"Analysts raise price target for {symbol.upper()}",
+        f"{symbol.upper()} reports better than expected earnings",
+        f"New product launch boosts {symbol.upper()} shares",
+        f"{symbol.upper()} partners with a major tech firm",
+        f"Regulatory changes impact {symbol.upper()}'s sector",
+        f"{symbol.upper()} to release new sustainability report",
+    ]
+    return {
+        "symbol": symbol.upper(),
+        "news": random.sample(news_items, min(days, len(news_items))),
+        "days": days,
+    }

aip_agents/examples/tools/stock_tools.pyi

@@ -0,0 +1,36 @@
+from _typeshed import Incomplete
+from aip_agents.utils.logger import get_logger as get_logger
+from pydantic import BaseModel
+from typing import Any
+
+logger: Incomplete
+
+class StockPriceInput(BaseModel):
+    """Input for the stock price tool."""
+    symbol: str
+
+def get_stock_price(symbol: str) -> dict[str, Any]:
+    """Get current stock price and performance data for a given symbol.
+
+    Args:
+        symbol (str): The stock symbol (e.g., AAPL, MSFT) to get the price for.
+
+    Returns:
+        dict[str, Any]: Dictionary containing stock price and performance data.
+    """
+
+class StockNewsInput(BaseModel):
+    """Input for the stock news tool."""
+    symbol: str
+    days: int
+
+def get_stock_news(symbol: str, days: int = 7) -> dict[str, Any]:
+    """Get recent news for a stock for a specified number of days.
+
+    Args:
+        symbol (str): The stock symbol (e.g., AAPL, MSFT) to get news for.
+        days (int, optional): Number of days of news to retrieve. Defaults to 7.
+
+    Returns:
+        dict[str, Any]: Dictionary containing stock news data.
+    """

aip_agents/examples/tools/table_generator_tool.py

@@ -0,0 +1,167 @@
+"""Table generator tool for demonstrating artifact generation.
+
+This tool generates sample data tables and returns both a markdown representation
+for the agent and a CSV file artifact for the user.
+
+Authors:
+    Christian Trisno Sen Long Chen (christian.t.s.l.chen@gdplabs.id)
+"""
+
+import csv
+import io
+import random
+from typing import Any
+
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel, Field
+
+from aip_agents.a2a.types import MimeType
+from aip_agents.utils.artifact_helpers import create_artifact_response
+
+
+class TableGeneratorInput(BaseModel):
+    """Input schema for table generator tool."""
+
+    rows: int = Field(default=5, description="Number of rows to generate", ge=1, le=100)
+    columns: list[str] = Field(default=["Name", "Age", "City"], description="Column names for the table")
+    table_name: str = Field(default="sample_data", description="Name for the generated table")
+
+
+class TableGeneratorTool(BaseTool):
+    """Tool that generates sample data tables with artifact support.
+
+    This tool demonstrates the standardized artifact format by:
+    1. Generating sample data
+    2. Creating a markdown table for the agent's context
+    3. Creating a CSV file artifact for the user
+    """
+
+    name: str = "table_generator"
+    description: str = "Generate sample data tables with specified columns and rows"
+    args_schema: type[BaseModel] = TableGeneratorInput
+
+    def _run(self, rows: int = 5, columns: list[str] = None, table_name: str = "sample_data") -> dict[str, Any]:
+        """Generate a table synchronously.
+
+        Args:
+            rows (int, optional): Number of rows to generate. Defaults to 5.
+            columns (list[str], optional): Column names for the table. Defaults to None.
+            table_name (str, optional): Name for the generated table. Defaults to "sample_data".
+
+        Returns:
+            dict[str, Any]: Response containing artifact data and metadata.
+        """
+        if columns is None:
+            columns = ["Name", "Age", "City"]
+
+        # Generate sample data
+        sample_data = self._generate_sample_data(rows, columns)
+
+        # Create markdown table for agent
+        markdown_table = self._create_markdown_table(sample_data, columns)
+
+        # Create CSV data for artifact
+        csv_data = self._create_csv_data(sample_data, columns)
+        csv_bytes = csv_data.encode("utf-8")
+
+        # Return standardized format using utility function
+        return create_artifact_response(
+            result=f"I have generated a {rows}-row table with columns: {', '.join(columns)}.\n\n{markdown_table}",
+            artifact_data=csv_bytes,
+            artifact_name=f"{table_name}.csv",
+            artifact_description=f"Generated table with {rows} rows and {len(columns)} columns",
+            mime_type=MimeType.TEXT_CSV,
+        )
+
+    async def _arun(self, rows: int = 5, columns: list[str] = None, table_name: str = "sample_data") -> dict[str, Any]:
+        """Generate a table asynchronously.
+
+        Args:
+            rows (int, optional): Number of rows to generate. Defaults to 5.
+            columns (list[str], optional): Column names for the table. Defaults to None.
+            table_name (str, optional): Name for the generated table. Defaults to "sample_data".
+
+        Returns:
+            dict[str, Any]: Response containing artifact data and metadata.
+        """
+        return self._run(rows, columns, table_name)
+
+    def _generate_sample_data(self, rows: int, columns: list[str]) -> list[list[str]]:
+        """Generate sample data based on column names.
+
+        Args:
+            rows (int): Number of rows to generate.
+            columns (list[str]): Column names for the table.
+
+        Returns:
+            list[list[str]]: Generated sample data as list of rows.
+        """
+        data = []
+        for i in range(rows):
+            row = []
+            for col in columns:
+                col_lower = col.lower()
+                if "name" in col_lower:
+                    names = ["Alice", "Bob", "Charlie", "Diana", "Eve", "Frank", "Grace", "Henry"]
+                    row.append(random.choice(names))
+                elif "age" in col_lower:
+                    row.append(str(random.randint(20, 65)))
+                elif "city" in col_lower:
+                    cities = ["New York", "London", "Tokyo", "Paris", "Sydney", "Berlin", "Toronto", "Mumbai"]
+                    row.append(random.choice(cities))
+                elif "email" in col_lower:
+                    domains = ["gmail.com", "yahoo.com", "outlook.com", "company.com"]
+                    username = f"user{i + 1}"
+                    row.append(f"{username}@{random.choice(domains)}")
+                elif "score" in col_lower or "rating" in col_lower:
+                    row.append(str(random.randint(1, 100)))
+                else:
+                    row.append(f"Value{i + 1}")
+            data.append(row)
+        return data
+
+    def _create_markdown_table(self, data: list[list[str]], columns: list[str]) -> str:
+        """Create a markdown table representation.
+
+        Args:
+            data (list[list[str]]): Table data as list of rows.
+            columns (list[str]): Column names for the table.
+
+        Returns:
+            str: Markdown formatted table string.
+        """
+        if not data:
+            return "| No data |\n|---------|"
+
+        # Header
+        header = "| " + " | ".join(columns) + " |"
+        separator = "| " + " | ".join(["---"] * len(columns)) + " |"
+
+        # Rows
+        rows = []
+        for row in data:
+            rows.append("| " + " | ".join(row) + " |")
+
+        return "\n".join([header, separator] + rows)
+
+    def _create_csv_data(self, data: list[list[str]], columns: list[str]) -> str:
+        """Create CSV data string.
+
+        Args:
+            data (list[list[str]]): Table data as list of rows.
+            columns (list[str]): Column names for the table.
+
+        Returns:
+            str: CSV formatted data string.
+        """
+        output = io.StringIO()
+        writer = csv.writer(output)
+
+        # Write header
+        writer.writerow(columns)
+
+        # Write data
+        for row in data:
+            writer.writerow(row)
+
+        return output.getvalue()

aip_agents/examples/tools/table_generator_tool.pyi

@@ -0,0 +1,22 @@
+from aip_agents.a2a.types import MimeType as MimeType
+from aip_agents.utils.artifact_helpers import create_artifact_response as create_artifact_response
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel
+
+class TableGeneratorInput(BaseModel):
+    """Input schema for table generator tool."""
+    rows: int
+    columns: list[str]
+    table_name: str
+
+class TableGeneratorTool(BaseTool):
+    """Tool that generates sample data tables with artifact support.
+
+    This tool demonstrates the standardized artifact format by:
+    1. Generating sample data
+    2. Creating a markdown table for the agent's context
+    3. Creating a CSV file artifact for the user
+    """
+    name: str
+    description: str
+    args_schema: type[BaseModel]

aip_agents/examples/tools/time_tool.py

@@ -0,0 +1,82 @@
+"""Tool to get the current time.
+
+Authors:
+    Saul Sayers (saul.sayers@gdplabs.id)
+"""
+
+from datetime import datetime
+
+from gllm_core.schema import Chunk
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel, Field
+
+FORMAT_STRING = "%m/%d/%y %H:%M:%S"
+
+
+class TimeToolInput(BaseModel):
+    """Input schema for the TimeTool."""
+
+    datetime_format: str = Field(
+        default=FORMAT_STRING,
+        description="""
+        Optional datetime format string. Default: '%m/%d/%y %H:%M:%S'
+
+        Common format codes:
+        %Y: Year with century (2024)
+        %m: Month as number (01-12)
+        %d: Day of month (01-31)
+        %A: Full weekday name (Wednesday)
+        %a: Short weekday name (Wed)
+        %H: Hour (00-23)
+        %M: Minute (00-59)
+        %S: Second (00-59)
+        %Z: Timezone name
+        %j: Day of year (001-366)
+        %W: Week number (00-53, Monday first)
+        %U: Week number (00-53, Sunday first)
+        %c: Locale's date and time
+        %x: Locale's date
+        %X: Locale's time
+        """,
+    )
+
+
+class TimeTool(BaseTool):
+    """Tool to get the current time."""
+
+    name: str = "time_tool"
+    description: str = """
+    Useful for getting the current time in a specified format or the default format.
+    Default format: '%m/%d/%y %H:%M:%S' (e.g., '05/15/24 17:30:00')
+    """
+    save_output_history: bool = True
+    args_schema: type[BaseModel] = TimeToolInput
+
+    def _run(self, datetime_format: str = FORMAT_STRING) -> str:
+        """Get the current time formatted as a string.
+
+        Args:
+            datetime_format (str): The format string to use for the datetime output. Defaults to FORMAT_STRING.
+
+        Returns:
+            str: The current time formatted according to the provided format string.
+        """
+        return datetime.now().strftime(datetime_format)
+
+    def _format_agent_reference(self, tool_output: str) -> list[Chunk]:
+        """Format the tool output as a reference chunk for agent use.
+
+        Args:
+            tool_output (str): The output string from the tool execution.
+
+        Returns:
+            list[Chunk]: A list containing a single reference chunk with the tool output and metadata.
+        """
+        return [
+            Chunk(
+                content=tool_output,
+                metadata={
+                    "tool_name": self.name,
+                },
+            )
+        ]

aip_agents/examples/tools/time_tool.pyi

@@ -0,0 +1,15 @@
+from langchain_core.tools import BaseTool
+from pydantic import BaseModel
+
+FORMAT_STRING: str
+
+class TimeToolInput(BaseModel):
+    """Input schema for the TimeTool."""
+    datetime_format: str
+
+class TimeTool(BaseTool):
+    """Tool to get the current time."""
+    name: str
+    description: str
+    save_output_history: bool
+    args_schema: type[BaseModel]

aip_agents/examples/tools/weather_forecast_tool.py

@@ -0,0 +1,38 @@
+"""Weather Forecast Tool."""
+
+from typing import Literal
+
+# Predefined weather data for each day
+DAILY_WEATHER = {
+    "monday": {"condition": "sunny", "temp_low": 28, "temp_high": 32},
+    "tuesday": {"condition": "partly cloudy", "temp_low": 25, "temp_high": 28},
+    "wednesday": {"condition": "cloudy", "temp_low": 22, "temp_high": 25},
+    "thursday": {"condition": "light rain", "temp_low": 20, "temp_high": 23},
+    "friday": {"condition": "windy", "temp_low": 19, "temp_high": 24},
+    "saturday": {"condition": "sunny", "temp_low": 27, "temp_high": 31},
+    "sunday": {"condition": "partly cloudy", "temp_low": 24, "temp_high": 27},
+}
+
+DayOfWeek = Literal["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
+
+
+def get_weather_forecast(day: DayOfWeek) -> str:
+    """Get the weather forecast for a specific day of the week.
+
+    Args:
+        day: The day of the week (monday, tuesday, wednesday, etc.)
+
+    Returns:
+        str: A weather forecast message including conditions and temperature.
+    """
+    # Get the predefined weather data for the day
+    weather_data = DAILY_WEATHER[day]
+
+    # Format the forecast message
+    forecast = (
+        f"Weather forecast for {day.capitalize()}: "
+        f"{weather_data['condition'].capitalize()} with temperatures between "
+        f"{weather_data['temp_low']}°C and {weather_data['temp_high']}°C"
+    )
+
+    return forecast

aip_agents/examples/tools/weather_forecast_tool.pyi

@@ -0,0 +1,14 @@
+from _typeshed import Incomplete
+
+DAILY_WEATHER: Incomplete
+DayOfWeek: Incomplete
+
+def get_weather_forecast(day: DayOfWeek) -> str:
+    """Get the weather forecast for a specific day of the week.
+
+    Args:
+        day: The day of the week (monday, tuesday, wednesday, etc.)
+
+    Returns:
+        str: A weather forecast message including conditions and temperature.
+    """