google-adk 0.0.1__py3-none-any.whl → 0.0.3__py3-none-any.whl

google/adk/tests/integration/fixture/context_variable_agent/agent.py

@@ -0,0 +1,115 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import List
+from typing import Union
+
+from google.adk import Agent
+from google.adk.agents.invocation_context import InvocationContext
+from google.adk.planners import PlanReActPlanner
+from google.adk.tools import ToolContext
+
+
+def update_fc(
+    data_one: str,
+    data_two: Union[int, float, str],
+    data_three: list[str],
+    data_four: List[Union[int, float, str]],
+    tool_context: ToolContext,
+) -> str:
+  """Simply ask to update these variables in the context"""
+  tool_context.actions.update_state('data_one', data_one)
+  tool_context.actions.update_state('data_two', data_two)
+  tool_context.actions.update_state('data_three', data_three)
+  tool_context.actions.update_state('data_four', data_four)
+  return 'The function `update_fc` executed successfully'
+
+
+def echo_info(customer_id: str) -> str:
+  """Echo the context variable"""
+  return customer_id
+
+
+def build_global_instruction(invocation_context: InvocationContext) -> str:
+  return (
+      'This is the gloabl agent instruction for invocation:'
+      f' {invocation_context.invocation_id}.'
+  )
+
+
+def build_sub_agent_instruction(invocation_context: InvocationContext) -> str:
+  return 'This is the plain text sub agent instruction.'
+
+
+context_variable_echo_agent = Agent(
+    model='gemini-1.5-flash',
+    name='context_variable_echo_agent',
+    instruction=(
+        'Use the echo_info tool to echo {customerId}, {customerInt},'
+        ' {customerFloat}, and {customerJson}. Ask for it if you need to.'
+    ),
+    flow='auto',
+    tools=[echo_info],
+)
+
+context_variable_with_complicated_format_agent = Agent(
+    model='gemini-1.5-flash',
+    name='context_variable_echo_agent',
+    instruction=(
+        'Use the echo_info tool to echo { customerId }, {{customer_int  }, { '
+        " non-identifier-float}}, {artifact.fileName}, {'key1': 'value1'} and"
+        " {{'key2': 'value2'}}. Ask for it if you need to."
+    ),
+    flow='auto',
+    tools=[echo_info],
+)
+
+context_variable_with_nl_planner_agent = Agent(
+    model='gemini-1.5-flash',
+    name='context_variable_with_nl_planner_agent',
+    instruction=(
+        'Use the echo_info tool to echo {customerId}. Ask for it if you'
+        ' need to.'
+    ),
+    flow='auto',
+    planner=PlanReActPlanner(),
+    tools=[echo_info],
+)
+
+context_variable_with_function_instruction_agent = Agent(
+    model='gemini-1.5-flash',
+    name='context_variable_with_function_instruction_agent',
+    instruction=build_sub_agent_instruction,
+    flow='auto',
+)
+
+context_variable_update_agent = Agent(
+    model='gemini-1.5-flash',
+    name='context_variable_update_agent',
+    instruction='Call tools',
+    flow='auto',
+    tools=[update_fc],
+)
+
+root_agent = Agent(
+    model='gemini-1.5-flash',
+    name='root_agent',
+    description='The root agent.',
+    flow='auto',
+    global_instruction=build_global_instruction,
+    sub_agents=[
+        context_variable_with_nl_planner_agent,
+        context_variable_update_agent,
+    ],
+)

google/adk/tests/integration/fixture/customer_support_ma/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from . import agent

google/adk/tests/integration/fixture/customer_support_ma/agent.py

@@ -0,0 +1,172 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import sys
+
+from google.adk import Agent
+from google.adk.agents import RemoteAgent
+from google.adk.examples import Example
+from google.adk.sessions import Session
+from google.genai import types
+
+
+def reset_data():
+  pass
+
+
+def fetch_user_flight_information(customer_email: str) -> str:
+  """Fetch user flight information."""
+  return """
+[{"ticket_no": "7240005432906569", "book_ref": "C46E9F", "flight_id": 19250, "flight_no": "LX0112", "departure_airport": "CDG", "arrival_airport": "BSL", "scheduled_departure": "2024-12-30 12:09:03.561731-04:00", "scheduled_arrival": "2024-12-30 13:39:03.561731-04:00", "seat_no": "18E", "fare_conditions": "Economy"}]
+"""
+
+
+def list_customer_flights(customer_email: str) -> str:
+  return "{'flights': [{'book_ref': 'C46E9F'}]}"
+
+
+def update_ticket_to_new_flight(ticket_no: str, new_flight_id: str) -> str:
+  return 'OK, your ticket has been updated.'
+
+
+def lookup_company_policy(topic: str) -> str:
+  """Lookup policies for flight cancelation and rebooking."""
+  return """
+1. How can I change my booking?
+	* The ticket number must start with 724 (SWISS ticket no./plate).
+	* The ticket was not paid for by barter or voucher (there are exceptions to voucher payments; if the ticket was paid for in full by voucher, then it may be possible to rebook online under certain circumstances. If it is not possible to rebook online because of the payment method, then you will be informed accordingly during the rebooking process).
+	* There must be an active flight booking for your ticket. It is not possible to rebook open tickets or tickets without the corresponding flight segments online at the moment.
+	* It is currently only possible to rebook outbound (one-way) tickets or return tickets with single flight routes (point-to-point).
+"""
+
+
+def search_flights(
+    departure_airport: str = None,
+    arrival_airport: str = None,
+    start_time: str = None,
+    end_time: str = None,
+) -> list[dict]:
+  return """
+[{"flight_id": 19238, "flight_no": "LX0112", "scheduled_departure": "2024-05-08 12:09:03.561731-04:00", "scheduled_arrival": "2024-05-08 13:39:03.561731-04:00", "departure_airport": "CDG", "arrival_airport": "BSL", "status": "Scheduled", "aircraft_code": "SU9", "actual_departure": null, "actual_arrival": null}, {"flight_id": 19242, "flight_no": "LX0112", "scheduled_departure": "2024-05-09 12:09:03.561731-04:00", "scheduled_arrival": "2024-05-09 13:39:03.561731-04:00", "departure_airport": "CDG", "arrival_airport": "BSL", "status": "Scheduled", "aircraft_code": "SU9", "actual_departure": null, "actual_arrival": null}]"""
+
+
+def search_hotels(
+    location: str = None,
+    price_tier: str = None,
+    checkin_date: str = None,
+    checkout_date: str = None,
+) -> list[dict]:
+  return """
+[{"id": 1, "name": "Hilton Basel", "location": "Basel", "price_tier": "Luxury"}, {"id": 3, "name": "Hyatt Regency Basel", "location": "Basel", "price_tier": "Upper Upscale"}, {"id": 8, "name": "Holiday Inn Basel", "location": "Basel", "price_tier": "Upper Midscale"}]
+"""
+
+
+def book_hotel(hotel_name: str) -> str:
+  return 'OK, your hotel has been booked.'
+
+
+def before_model_call(agent: Agent, session: Session, user_message):
+  if 'expedia' in user_message.lower():
+    response = types.Content(
+        role='model',
+        parts=[types.Part(text="Sorry, I can't answer this question.")],
+    )
+    return response
+  return None
+
+
+def after_model_call(
+    agent: Agent, session: Session, content: types.Content
+) -> bool:
+  model_message = content.parts[0].text
+  if 'expedia' in model_message.lower():
+    response = types.Content(
+        role='model',
+        parts=[types.Part(text="Sorry, I can't answer this question.")],
+    )
+    return response
+  return None
+
+
+flight_agent = Agent(
+    model='gemini-1.5-pro',
+    name='flight_agent',
+    description='Handles flight information, policy and updates',
+    instruction="""
+      You are a specialized assistant for handling flight updates.
+        The primary assistant delegates work to you whenever the user needs help updating their bookings.
+      Confirm the updated flight details with the customer and inform them of any additional fees.
+        When searching, be persistent. Expand your query bounds if the first search returns no results.
+        Remember that a booking isn't completed until after the relevant tool has successfully been used.
+      Do not waste the user's time. Do not make up invalid tools or functions.
+""",
+    tools=[
+        list_customer_flights,
+        lookup_company_policy,
+        fetch_user_flight_information,
+        search_flights,
+        update_ticket_to_new_flight,
+    ],
+)
+
+hotel_agent = Agent(
+    model='gemini-1.5-pro',
+    name='hotel_agent',
+    description='Handles hotel information and booking',
+    instruction="""
+      You are a specialized assistant for handling hotel bookings.
+      The primary assistant delegates work to you whenever the user needs help booking a hotel.
+      Search for available hotels based on the user's preferences and confirm the booking details with the customer.
+        When searching, be persistent. Expand your query bounds if the first search returns no results.
+""",
+    tools=[search_hotels, book_hotel],
+)
+
+
+idea_agent = RemoteAgent(
+    model='gemini-1.5-pro',
+    name='idea_agent',
+    description='Provide travel ideas base on the destination.',
+    url='http://localhost:8000/agent/run',
+)
+
+
+root_agent = Agent(
+    model='gemini-1.5-pro',
+    name='root_agent',
+    instruction="""
+      You are a helpful customer support assistant for Swiss Airlines.
+""",
+    sub_agents=[flight_agent, hotel_agent, idea_agent],
+    flow='auto',
+    examples=[
+        Example(
+            input=types.Content(
+                role='user',
+                parts=[types.Part(text='How were you built?')],
+            ),
+            output=[
+                types.Content(
+                    role='model',
+                    parts=[
+                        types.Part(
+                            text='I was built with the best agent framework.'
+                        )
+                    ],
+                )
+            ],
+        ),
+    ],
+)

google/adk/tests/integration/fixture/ecommerce_customer_service_agent/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from . import agent

google/adk/tests/integration/fixture/ecommerce_customer_service_agent/agent.py

@@ -0,0 +1,338 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from google.adk import Agent
+
+# A lightweight in-memory mock database
+ORDER_DB = {
+    "1": "FINISHED",
+    "2": "CANCELED",
+    "3": "PENDING",
+    "4": "PENDING",
+}  # Order id to status mapping. Available states: 'FINISHED', 'PENDING', and 'CANCELED'
+USER_TO_ORDER_DB = {
+    "user_a": ["1", "4"],
+    "user_b": ["2"],
+    "user_c": ["3"],
+}  # User id to Order id mapping
+TICKET_DB = [{
+    "ticket_id": "1",
+    "user_id": "user_a",
+    "issue_type": "LOGIN_ISSUE",
+    "status": "OPEN",
+}]  # Available states: 'OPEN', 'CLOSED', 'ESCALATED'
+USER_INFO_DB = {
+    "user_a": {"name": "Alice", "email": "alice@example.com"},
+    "user_b": {"name": "Bob", "email": "bob@example.com"},
+}
+
+
+def reset_data():
+  global ORDER_DB
+  global USER_TO_ORDER_DB
+  global TICKET_DB
+  global USER_INFO_DB
+  ORDER_DB = {
+      "1": "FINISHED",
+      "2": "CANCELED",
+      "3": "PENDING",
+      "4": "PENDING",
+  }
+  USER_TO_ORDER_DB = {
+      "user_a": ["1", "4"],
+      "user_b": ["2"],
+      "user_c": ["3"],
+  }
+  TICKET_DB = [{
+      "ticket_id": "1",
+      "user_id": "user_a",
+      "issue_type": "LOGIN_ISSUE",
+      "status": "OPEN",
+  }]
+  USER_INFO_DB = {
+      "user_a": {"name": "Alice", "email": "alice@example.com"},
+      "user_b": {"name": "Bob", "email": "bob@example.com"},
+  }
+
+
+def get_order_status(order_id: str) -> str:
+  """Get the status of an order.
+
+  Args:
+      order_id (str): The unique identifier of the order.
+
+  Returns:
+      str: The status of the order (e.g., 'FINISHED', 'CANCELED', 'PENDING'),
+           or 'Order not found' if the order_id does not exist.
+  """
+  return ORDER_DB.get(order_id, "Order not found")
+
+
+def get_order_ids_for_user(user_id: str) -> list:
+  """Get the list of order IDs assigned to a specific transaction associated with a user.
+
+  Args:
+      user_id (str): The unique identifier of the user.
+
+  Returns:
+      List[str]: A list of order IDs associated with the user, or an empty list
+      if no orders are found.
+  """
+  return USER_TO_ORDER_DB.get(user_id, [])
+
+
+def cancel_order(order_id: str) -> str:
+  """Cancel an order if it is in a 'PENDING' state.
+
+  You should call "get_order_status" to check the status first, before calling
+  this tool.
+
+  Args:
+      order_id (str): The unique identifier of the order to be canceled.
+
+  Returns:
+      str: A message indicating whether the order was successfully canceled or
+      not.
+  """
+  if order_id in ORDER_DB and ORDER_DB[order_id] == "PENDING":
+    ORDER_DB[order_id] = "CANCELED"
+    return f"Order {order_id} has been canceled."
+  return f"Order {order_id} cannot be canceled."
+
+
+def refund_order(order_id: str) -> str:
+  """Process a refund for an order if it is in a 'CANCELED' state.
+
+  You should call "get_order_status" to check if status first, before calling
+  this tool.
+
+  Args:
+      order_id (str): The unique identifier of the order to be refunded.
+
+  Returns:
+      str: A message indicating whether the order was successfully refunded or
+      not.
+  """
+  if order_id in ORDER_DB and ORDER_DB[order_id] == "CANCELED":
+    return f"Order {order_id} has been refunded."
+  return f"Order {order_id} cannot be refunded."
+
+
+def create_ticket(user_id: str, issue_type: str) -> str:
+  """Create a new support ticket for a user.
+
+  Args:
+      user_id (str): The unique identifier of the user creating the ticket.
+      issue_type (str): An issue type the user is facing. Available types:
+        'LOGIN_ISSUE', 'ORDER_ISSUE', 'OTHER'.
+
+  Returns:
+      str: A message indicating that the ticket was created successfully,
+      including the ticket ID.
+  """
+  ticket_id = str(len(TICKET_DB) + 1)
+  TICKET_DB.append({
+      "ticket_id": ticket_id,
+      "user_id": user_id,
+      "issue_type": issue_type,
+      "status": "OPEN",
+  })
+  return f"Ticket {ticket_id} created successfully."
+
+
+def get_ticket_info(ticket_id: str) -> str:
+  """Retrieve the information of a support ticket.
+
+  current status of a support ticket.
+
+  Args:
+      ticket_id (str): The unique identifier of the ticket.
+
+  Returns:
+      A dictionary contains the following fields, or 'Ticket not found' if the
+      ticket_id does not exist:
+        - "ticket_id": str, the current ticket id
+        - "user_id": str, the associated user id
+        - "issue": str, the issue type
+        - "status": The current status of the ticket (e.g., 'OPEN', 'CLOSED',
+        'ESCALATED')
+
+      Example: {"ticket_id": "1", "user_id": "user_a", "issue": "Login issue",
+      "status": "OPEN"}
+  """
+  for ticket in TICKET_DB:
+    if ticket["ticket_id"] == ticket_id:
+      return ticket
+  return "Ticket not found"
+
+
+def get_tickets_for_user(user_id: str) -> list:
+  """Get all the ticket IDs associated with a user.
+
+  Args:
+      user_id (str): The unique identifier of the user.
+
+  Returns:
+      List[str]: A list of ticket IDs associated with the user.
+                 If no tickets are found, returns an empty list.
+  """
+  return [
+      ticket["ticket_id"]
+      for ticket in TICKET_DB
+      if ticket["user_id"] == user_id
+  ]
+
+
+def update_ticket_status(ticket_id: str, status: str) -> str:
+  """Update the status of a support ticket.
+
+  Args:
+      ticket_id (str): The unique identifier of the ticket.
+      status (str): The new status to assign to the ticket (e.g., 'OPEN',
+        'CLOSED', 'ESCALATED').
+
+  Returns:
+      str: A message indicating whether the ticket status was successfully
+      updated.
+  """
+  for ticket in TICKET_DB:
+    if ticket["ticket_id"] == ticket_id:
+      ticket["status"] = status
+      return f"Ticket {ticket_id} status updated to {status}."
+  return "Ticket not found"
+
+
+def get_user_info(user_id: str) -> dict:
+  """Retrieve information (name, email) about a user.
+
+  Args:
+      user_id (str): The unique identifier of the user.
+
+  Returns:
+      dict or str: A dictionary containing user information of the following
+        fields, or 'User not found' if the user_id does not exist:
+
+       - name:  The name of the user
+       - email: The email address of the user
+
+       For example, {"name": "Chelsea", "email": "123@example.com"}
+  """
+  return USER_INFO_DB.get(user_id, "User not found")
+
+
+def send_email(user_id: str, email: str) -> list:
+  """Send email to user for notification.
+
+  Args:
+      user_id (str): The unique identifier of the user.
+      email (str): The email address of the user.
+
+  Returns:
+      str: A message indicating whether the email was successfully sent.
+  """
+  if user_id in USER_INFO_DB:
+    return f"Email sent to {email} for user id {user_id}"
+  return "Cannot find this user"
+
+
+# def update_user_info(user_id: str, new_info: dict[str, str]) -> str:
+def update_user_info(user_id: str, email: str, name: str) -> str:
+  """Update a user's information.
+
+  Args:
+      user_id (str): The unique identifier of the user.
+      new_info (dict): A dictionary containing the fields to be updated (e.g.,
+        {'email': 'new_email@example.com'}). Available field keys: 'email' and
+        'name'.
+
+  Returns:
+      str: A message indicating whether the user's information was successfully
+      updated or not.
+  """
+  if user_id in USER_INFO_DB:
+    # USER_INFO_DB[user_id].update(new_info)
+    if email and name:
+      USER_INFO_DB[user_id].update({"email": email, "name": name})
+    elif email:
+      USER_INFO_DB[user_id].update({"email": email})
+    elif name:
+      USER_INFO_DB[user_id].update({"name": name})
+    else:
+      raise ValueError("this should not happen.")
+    return f"User {user_id} information updated."
+  return "User not found"
+
+
+def get_user_id_from_cookie() -> str:
+  """Get user ID(username) from the cookie.
+
+  Only use this function when you do not know user ID(username).
+
+  Args: None
+
+  Returns:
+      str: The user ID.
+  """
+  return "user_a"
+
+
+root_agent = Agent(
+    model="gemini-2.0-flash-001",
+    name="Ecommerce_Customer_Service",
+    instruction="""
+      You are an intelligent customer service assistant for an e-commerce platform. Your goal is to accurately understand user queries and use the appropriate tools to fulfill requests. Follow these guidelines:
+
+      1. **Understand the Query**:
+        - Identify actions and conditions (e.g., create a ticket only for pending orders).
+        - Extract necessary details (e.g., user ID, order ID) from the query or infer them from the context.
+
+      2. **Plan Multi-Step Workflows**:
+        - Break down complex queries into sequential steps. For example
+        - typical workflow:
+          - Retrieve IDs or references first (e.g., orders for a user).
+          - Evaluate conditions (e.g., check order status).
+          - Perform actions (e.g., create a ticket) only when conditions are met.
+        - another typical workflows - order cancellation and refund:
+          - Retrieve all orders for the user (`get_order_ids_for_user`).
+          - Cancel pending orders (`cancel_order`).
+          - Refund canceled orders (`refund_order`).
+          - Notify the user (`send_email`).
+        - another typical workflows - send user report:
+          - Get user id.
+          - Get user info(like emails)
+          - Send email to user.
+
+      3. **Avoid Skipping Steps**:
+        - Ensure each intermediate step is completed before moving to the next.
+        - Do not create tickets or take other actions without verifying the conditions specified in the query.
+
+      4. **Provide Clear Responses**:
+        - Confirm the actions performed, including details like ticket ID or pending orders.
+        - Ensure the response aligns with the steps taken and query intent.
+      """,
+    tools=[
+        get_order_status,
+        cancel_order,
+        get_order_ids_for_user,
+        refund_order,
+        create_ticket,
+        update_ticket_status,
+        get_tickets_for_user,
+        get_ticket_info,
+        get_user_info,
+        send_email,
+        update_user_info,
+        get_user_id_from_cookie,
+    ],
+)