google-adk 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

google/adk/cli/cli_deploy.py

@@ -54,7 +54,7 @@ COPY "agents/{app_name}/" "/app/agents/{app_name}/"
 
 EXPOSE {port}
 
-CMD adk {command} --port={port} {trace_to_cloud_option} "/app/agents"
+CMD adk {command} --port={port} {session_db_option} {trace_to_cloud_option} "/app/agents"
 """
 
 
@@ -85,6 +85,7 @@ def to_cloud_run(
     trace_to_cloud: bool,
     with_ui: bool,
     verbosity: str,
+    session_db_url: str,
 ):
   """Deploys an agent to Google Cloud Run.
 
@@ -112,6 +113,7 @@ def to_cloud_run(
     trace_to_cloud: Whether to enable Cloud Trace.
     with_ui: Whether to deploy with UI.
     verbosity: The verbosity level of the CLI.
+    session_db_url: The database URL to connect the session.
   """
   app_name = app_name or os.path.basename(agent_folder)
 
@@ -144,6 +146,9 @@ def to_cloud_run(
         port=port,
         command='web' if with_ui else 'api_server',
         install_agent_deps=install_agent_deps,
+        session_db_option=f'--session_db_url={session_db_url}'
+        if session_db_url
+        else '',
         trace_to_cloud_option='--trace_to_cloud' if trace_to_cloud else '',
     )
     dockerfile_path = os.path.join(temp_folder, 'Dockerfile')

google/adk/cli/cli_eval.py

@@ -256,7 +256,7 @@ def run_evals(
         )
 
         if final_eval_status == EvalStatus.PASSED:
-          result = "✅ Passsed"
+          result = "✅ Passed"
         else:
           result = "❌ Failed"
 

google/adk/cli/cli_tools_click.py

@@ -245,12 +245,13 @@ def cli_eval(
 @click.option(
     "--session_db_url",
     help=(
-        "Optional. The database URL to store the session.\n\n  - Use"
-        " 'agentengine://<agent_engine_resource_id>' to connect to Vertex"
-        " managed session service.\n\n  - Use 'sqlite://<path_to_sqlite_file>'"
-        " to connect to a SQLite DB.\n\n  - See"
-        " https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls"
-        " for more details on supported DB URLs."
+        """Optional. The database URL to store the session.
+
+  - Use 'agentengine://<agent_engine_resource_id>' to connect to Agent Engine sessions.
+
+  - Use 'sqlite://<path_to_sqlite_file>' to connect to a SQLite DB.
+
+  - See https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls for more details on supported DB URLs."""
     ),
 )
 @click.option(
@@ -366,12 +367,13 @@ def cli_web(
 @click.option(
     "--session_db_url",
     help=(
-        "Optional. The database URL to store the session.\n\n  - Use"
-        " 'agentengine://<agent_engine_resource_id>' to connect to Vertex"
-        " managed session service.\n\n  - Use 'sqlite://<path_to_sqlite_file>'"
-        " to connect to a SQLite DB.\n\n  - See"
-        " https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls"
-        " for more details on supported DB URLs."
+        """Optional. The database URL to store the session.
+
+  - Use 'agentengine://<agent_engine_resource_id>' to connect to Agent Engine sessions.
+
+  - Use 'sqlite://<path_to_sqlite_file>' to connect to a SQLite DB.
+
+  - See https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls for more details on supported DB URLs."""
     ),
 )
 @click.option(
@@ -541,6 +543,18 @@ def cli_api_server(
     default="WARNING",
     help="Optional. Override the default verbosity level.",
 )
+@click.option(
+    "--session_db_url",
+    help=(
+        """Optional. The database URL to store the session.
+
+  - Use 'agentengine://<agent_engine_resource_id>' to connect to Agent Engine sessions.
+
+  - Use 'sqlite://<path_to_sqlite_file>' to connect to a SQLite DB.
+
+  - See https://docs.sqlalchemy.org/en/20/core/engines.html#backend-specific-urls for more details on supported DB URLs."""
+    ),
+)
 @click.argument(
     "agent",
     type=click.Path(
@@ -558,6 +572,7 @@ def cli_deploy_cloud_run(
     trace_to_cloud: bool,
     with_ui: bool,
     verbosity: str,
+    session_db_url: str,
 ):
   """Deploys an agent to Cloud Run.
 
@@ -579,6 +594,7 @@ def cli_deploy_cloud_run(
         trace_to_cloud=trace_to_cloud,
         with_ui=with_ui,
         verbosity=verbosity,
+        session_db_url=session_db_url,
     )
   except Exception as e:
     click.secho(f"Deploy failed: {e}", fg="red", err=True)

google/adk/cli/fast_api.py

@@ -756,6 +756,12 @@ def get_fast_api_app(
     except Exception as e:
       logger.exception("Error during live websocket communication: %s", e)
       traceback.print_exc()
+      WEBSOCKET_INTERNAL_ERROR_CODE = 1011
+      WEBSOCKET_MAX_BYTES_FOR_REASON = 123
+      await websocket.close(
+          code=WEBSOCKET_INTERNAL_ERROR_CODE,
+          reason=str(e)[:WEBSOCKET_MAX_BYTES_FOR_REASON],
+      )
     finally:
       for task in pending:
         task.cancel()

google/adk/evaluation/agent_evaluator.py

@@ -55,7 +55,7 @@ def load_json(file_path: str) -> Union[Dict, List]:
 
 
 class AgentEvaluator:
-  """An evaluator for Agents, mainly intented for helping with test cases."""
+  """An evaluator for Agents, mainly intended for helping with test cases."""
 
   @staticmethod
   def find_config_for_test_file(test_file: str):
@@ -91,7 +91,7 @@ class AgentEvaluator:
         look for 'root_agent' in the loaded module.
       eval_dataset: The eval data set. This can be either a string representing
         full path to the file containing eval dataset, or a directory that is
-        recusively explored for all files that have a `.test.json` suffix.
+        recursively explored for all files that have a `.test.json` suffix.
       num_runs: Number of times all entries in the eval dataset should be
         assessed.
       agent_name: The name of the agent.

google/adk/evaluation/response_evaluator.py

@@ -35,7 +35,7 @@ class ResponseEvaluator:
     Args:
       raw_eval_dataset: The dataset that will be evaluated.
       evaluation_criteria: The evaluation criteria to be used. This method
-        support two criterias, `response_evaluation_score` and
+        support two criteria, `response_evaluation_score` and
         `response_match_score`.
       print_detailed_results: Prints detailed results on the console. This is
         usually helpful during debugging.
@@ -56,7 +56,7 @@ class ResponseEvaluator:
         Value range: [0, 5], where 0 means that the agent's response is not
         coherent, while 5 means it is . High values are good.
     A note on raw_eval_dataset:
-      The dataset should be a list session, where each sesssion is represented
+      The dataset should be a list session, where each session is represented
       as a list of interaction that need evaluation. Each evaluation is
       represented as a dictionary that is expected to have values for the
       following keys:

google/adk/evaluation/trajectory_evaluator.py

@@ -31,10 +31,9 @@ class TrajectoryEvaluator:
   ):
     r"""Returns the mean tool use accuracy of the eval dataset.
 
-    Tool use accuracy is calculated by comparing the expected and actuall tool
-    use trajectories. An exact match scores a 1, 0 otherwise. The final number
-    is an
-    average of these individual scores.
+    Tool use accuracy is calculated by comparing the expected and the actual
+    tool use trajectories. An exact match scores a 1, 0 otherwise. The final
+    number is an average of these individual scores.
 
     Value range: [0, 1], where 0 is means none of the too use entries aligned,
     and 1 would mean all of them aligned. Higher value is good.
@@ -45,7 +44,7 @@ class TrajectoryEvaluator:
         usually helpful during debugging.
 
     A note on eval_dataset:
-      The dataset should be a list session, where each sesssion is represented
+      The dataset should be a list session, where each session is represented
       as a list of interaction that need evaluation. Each evaluation is
       represented as a dictionary that is expected to have values for the
       following keys:

google/adk/flows/llm_flows/agent_transfer.py

@@ -94,7 +94,7 @@ can answer it.
 
 If another agent is better for answering the question according to its
 description, call `{_TRANSFER_TO_AGENT_FUNCTION_NAME}` function to transfer the
-question to that agent. When transfering, do not generate any text other than
+question to that agent. When transferring, do not generate any text other than
 the function call.
 """
 

google/adk/flows/llm_flows/base_llm_flow.py

@@ -115,7 +115,7 @@ class BaseLlmFlow(ABC):
           yield event
           # send back the function response
           if event.get_function_responses():
-            logger.debug('Sending back last function resonse event: %s', event)
+            logger.debug('Sending back last function response event: %s', event)
             invocation_context.live_request_queue.send_content(event.content)
           if (
               event.content

google/adk/flows/llm_flows/contents.py

@@ -111,7 +111,7 @@ def _rearrange_events_for_latest_function_response(
   """Rearrange the events for the latest function_response.
 
   If the latest function_response is for an async function_call, all events
-  bewteen the initial function_call and the latest function_response will be
+  between the initial function_call and the latest function_response will be
   removed.
 
   Args:

google/adk/flows/llm_flows/functions.py

@@ -310,9 +310,7 @@ async def _process_function_live_helper(
       function_response = {
           'status': f'No active streaming function named {function_name} found'
       }
-  elif inspect.isasyncgenfunction(tool.func):
-    print('is async')
-
+  elif hasattr(tool, "func") and inspect.isasyncgenfunction(tool.func):
     # for streaming tool use case
     # we require the function to be a async generator function
     async def run_tool_and_update_queue(tool, function_args, tool_context):

google/adk/flows/llm_flows/instructions.py

@@ -52,7 +52,7 @@ class _InstructionsLlmRequestProcessor(BaseLlmRequestProcessor):
     # Appends global instructions if set.
     if (
         isinstance(root_agent, LlmAgent) and root_agent.global_instruction
-    ):  # not emtpy str
+    ):  # not empty str
       raw_si = root_agent.canonical_global_instruction(
           ReadonlyContext(invocation_context)
       )
@@ -60,7 +60,7 @@ class _InstructionsLlmRequestProcessor(BaseLlmRequestProcessor):
       llm_request.append_instructions([si])
 
     # Appends agent instructions if set.
-    if agent.instruction:  # not emtpy str
+    if agent.instruction:  # not empty str
       raw_si = agent.canonical_instruction(ReadonlyContext(invocation_context))
       si = _populate_values(raw_si, invocation_context)
       llm_request.append_instructions([si])

google/adk/models/gemini_llm_connection.py

@@ -152,7 +152,7 @@ class GeminiLlmConnection(BaseLlmConnection):
         ):
           # TODO: Right now, we just support output_transcription without
           # changing interface and data protocol. Later, we can consider to
-          # support output_transcription as a separete field in LlmResponse.
+          # support output_transcription as a separate field in LlmResponse.
 
           # Transcription is always considered as partial event
           # We rely on other control signals to determine when to yield the
@@ -179,7 +179,7 @@ class GeminiLlmConnection(BaseLlmConnection):
         # in case of empty content or parts, we sill surface it
         # in case it's an interrupted message, we merge the previous partial
         # text. Other we don't merge. because content can be none when model
-        # safty threshold is triggered
+        # safety threshold is triggered
         if message.server_content.interrupted and text:
           yield self.__build_full_text_response(text)
           text = ''

google/adk/models/llm_response.py

@@ -14,7 +14,7 @@
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import Any, Optional
 
 from google.genai import types
 from pydantic import BaseModel
@@ -37,6 +37,7 @@ class LlmResponse(BaseModel):
     error_message: Error message if the response is an error.
     interrupted: Flag indicating that LLM was interrupted when generating the
       content. Usually it's due to user interruption during a bidi streaming.
+    custom_metadata: The custom metadata of the LlmResponse.
   """
 
   model_config = ConfigDict(extra='forbid')
@@ -71,6 +72,14 @@ class LlmResponse(BaseModel):
   Usually it's due to user interruption during a bidi streaming.
   """
 
+  custom_metadata: Optional[dict[str, Any]] = None
+  """The custom metadata of the LlmResponse.
+
+  An optional key-value pair to label an LlmResponse.
+
+  NOTE: the entire dict must be JSON serializable.
+  """
+
   @staticmethod
   def create(
       generate_content_response: types.GenerateContentResponse,

google/adk/planners/built_in_planner.py

@@ -56,6 +56,7 @@ class BuiltInPlanner(BasePlanner):
       llm_request: The LLM request to apply the thinking config to.
     """
     if self.thinking_config:
+      llm_request.config = llm_request.config or types.GenerateContentConfig()
       llm_request.config.thinking_config = self.thinking_config
 
   @override

google/adk/sessions/database_session_service.py

@@ -17,10 +17,10 @@ import copy
 from datetime import datetime
 import json
 import logging
-from typing import Any
-from typing import Optional
+from typing import Any, Optional
 import uuid
 
+from google.genai import types
 from sqlalchemy import Boolean
 from sqlalchemy import delete
 from sqlalchemy import Dialect
@@ -136,7 +136,7 @@ class StorageEvent(Base):
   author: Mapped[str] = mapped_column(String)
   branch: Mapped[str] = mapped_column(String, nullable=True)
   timestamp: Mapped[DateTime] = mapped_column(DateTime(), default=func.now())
-  content: Mapped[dict[str, Any]] = mapped_column(DynamicJSON)
+  content: Mapped[dict[str, Any]] = mapped_column(DynamicJSON, nullable=True)
   actions: Mapped[MutableDict[str, Any]] = mapped_column(PickleType)
 
   long_running_tool_ids_json: Mapped[Optional[str]] = mapped_column(
@@ -217,7 +217,7 @@ class DatabaseSessionService(BaseSessionService):
     """
     # 1. Create DB engine for db connection
     # 2. Create all tables based on schema
-    # 3. Initialize all properies
+    # 3. Initialize all properties
 
     try:
       db_engine = create_engine(db_url)
@@ -576,8 +576,12 @@ def _merge_state(app_state, user_state, session_state):
   return merged_state
 
 
-def _decode_content(content: dict[str, Any]) -> dict[str, Any]:
+def _decode_content(
+    content: Optional[dict[str, Any]],
+) -> Optional[types.Content]:
+  if not content:
+    return None
   for p in content["parts"]:
     if "inline_data" in p:
       p["inline_data"]["data"] = base64.b64decode(p["inline_data"]["data"][0])
-  return content
+  return types.Content.model_validate(content)

google/adk/sessions/state.py

@@ -26,7 +26,7 @@ class State:
     """
     Args:
       value: The current value of the state dict.
-      delta: The delta change to the current value that hasn't been commited.
+      delta: The delta change to the current value that hasn't been committed.
     """
     self._value = value
     self._delta = delta

google/adk/tools/agent_tool.py

@@ -45,10 +45,9 @@ class AgentTool(BaseTool):
     skip_summarization: Whether to skip summarization of the agent output.
   """
 
-  def __init__(self, agent: BaseAgent):
+  def __init__(self, agent: BaseAgent, skip_summarization: bool = False):
     self.agent = agent
-    self.skip_summarization: bool = False
-    """Whether to skip summarization of the agent output."""
+    self.skip_summarization: bool = skip_summarization
 
     super().__init__(name=agent.name, description=agent.description)
 

google/adk/tools/google_api_tool/google_api_tool_set.py

@@ -11,10 +11,12 @@
 # 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 __future__ import annotations
+
 import inspect
 import os
 from typing import Any
-from typing import Dict
 from typing import Final
 from typing import List
 from typing import Optional
@@ -28,6 +30,7 @@ from .googleapi_to_openapi_converter import GoogleApiToOpenApiConverter
 
 
 class GoogleApiToolSet:
+  """Google API Tool Set."""
 
   def __init__(self, tools: List[RestApiTool]):
     self.tools: Final[List[GoogleApiTool]] = [
@@ -45,10 +48,10 @@ class GoogleApiToolSet:
 
   @staticmethod
   def _load_tool_set_with_oidc_auth(
-      spec_file: str = None,
-      spec_dict: Dict[str, Any] = None,
-      scopes: list[str] = None,
-  ) -> Optional[OpenAPIToolset]:
+      spec_file: Optional[str] = None,
+      spec_dict: Optional[dict[str, Any]] = None,
+      scopes: Optional[list[str]] = None,
+  ) -> OpenAPIToolset:
     spec_str = None
     if spec_file:
       # Get the frame of the caller
@@ -90,18 +93,18 @@ class GoogleApiToolSet:
 
   @classmethod
   def load_tool_set(
-      cl: Type['GoogleApiToolSet'],
+      cls: Type[GoogleApiToolSet],
       api_name: str,
       api_version: str,
-  ) -> 'GoogleApiToolSet':
+  ) -> GoogleApiToolSet:
     spec_dict = GoogleApiToOpenApiConverter(api_name, api_version).convert()
     scope = list(
         spec_dict['components']['securitySchemes']['oauth2']['flows'][
             'authorizationCode'
         ]['scopes'].keys()
     )[0]
-    return cl(
-        cl._load_tool_set_with_oidc_auth(
+    return cls(
+        cls._load_tool_set_with_oidc_auth(
             spec_dict=spec_dict, scopes=[scope]
         ).get_tools()
     )

google/adk/tools/load_artifacts_tool.py

@@ -89,7 +89,7 @@ class LoadArtifactsTool(BaseTool):
   than the function call.
   """])
 
-    # Attache the content of the artifacts if the model requests them.
+    # Attach the content of the artifacts if the model requests them.
     # This only adds the content to the model request, instead of the session.
     if llm_request.contents and llm_request.contents[-1].parts:
       function_response = llm_request.contents[-1].parts[0].function_response

google/adk/tools/openapi_tool/auth/credential_exchangers/oauth2_exchanger.py

@@ -66,10 +66,10 @@ class OAuth2CredentialExchanger(BaseAuthCredentialExchanger):
 
     Returns:
         An AuthCredential object containing the HTTP bearer access token. If the
-        HTTO bearer token cannot be generated, return the origianl credential
+        HTTP bearer token cannot be generated, return the original credential.
     """
 
-    if "access_token" not in auth_credential.oauth2.token:
+    if not auth_credential.oauth2.access_token:
       return auth_credential
 
     # Return the access token as a bearer token.
@@ -78,7 +78,7 @@ class OAuth2CredentialExchanger(BaseAuthCredentialExchanger):
         http=HttpAuth(
             scheme="bearer",
             credentials=HttpCredentials(
-                token=auth_credential.oauth2.token["access_token"]
+                token=auth_credential.oauth2.access_token
             ),
         ),
     )
@@ -111,7 +111,7 @@ class OAuth2CredentialExchanger(BaseAuthCredentialExchanger):
       return auth_credential
 
     # If access token is exchanged, exchange a HTTPBearer token.
-    if auth_credential.oauth2.token:
+    if auth_credential.oauth2.access_token:
       return self.generate_auth_token(auth_credential)
 
     return None

google/adk/tools/openapi_tool/openapi_spec_parser/openapi_toolset.py

@@ -124,7 +124,7 @@ class OpenAPIToolset:
   def _load_spec(
       self, spec_str: str, spec_type: Literal["json", "yaml"]
   ) -> Dict[str, Any]:
-    """Loads the OpenAPI spec string into adictionary."""
+    """Loads the OpenAPI spec string into a dictionary."""
     if spec_type == "json":
       return json.loads(spec_str)
     elif spec_type == "yaml":

google/adk/tools/openapi_tool/openapi_spec_parser/operation_parser.py

@@ -14,20 +14,12 @@
 
 import inspect
 from textwrap import dedent
-from typing import Any
-from typing import Dict
-from typing import List
-from typing import Optional
-from typing import Union
+from typing import Any, Dict, List, Optional, Union
 
 from fastapi.encoders import jsonable_encoder
-from fastapi.openapi.models import Operation
-from fastapi.openapi.models import Parameter
-from fastapi.openapi.models import Schema
+from fastapi.openapi.models import Operation, Parameter, Schema
 
-from ..common.common import ApiParameter
-from ..common.common import PydocHelper
-from ..common.common import to_snake_case
+from ..common.common import ApiParameter, PydocHelper, to_snake_case
 
 
 class OperationParser:
@@ -110,7 +102,8 @@ class OperationParser:
       description = request_body.description or ''
 
       if schema and schema.type == 'object':
-        for prop_name, prop_details in schema.properties.items():
+        properties = schema.properties or {}
+        for prop_name, prop_details in properties.items():
           self.params.append(
               ApiParameter(
                   original_name=prop_name,

google/adk/tools/openapi_tool/openapi_spec_parser/rest_api_tool.py

@@ -17,6 +17,7 @@ from typing import Dict
 from typing import List
 from typing import Literal
 from typing import Optional
+from typing import Sequence
 from typing import Tuple
 from typing import Union
 
@@ -59,6 +60,40 @@ def snake_to_lower_camel(snake_case_string: str):
   ])
 
 
+# TODO: Switch to Gemini `from_json_schema` util when it is released
+# in Gemini SDK.
+def normalize_json_schema_type(
+    json_schema_type: Optional[Union[str, Sequence[str]]],
+) -> tuple[Optional[str], bool]:
+  """Converts a JSON Schema Type into Gemini Schema type.
+
+  Adopted and modified from Gemini SDK. This gets the first available schema
+  type from JSON Schema, and use it to mark Gemini schema type. If JSON Schema
+  contains a list of types, the first non null type is used.
+
+  Remove this after switching to Gemini `from_json_schema`.
+  """
+  if json_schema_type is None:
+    return None, False
+  if isinstance(json_schema_type, str):
+    if json_schema_type == "null":
+      return None, True
+    return json_schema_type, False
+
+  non_null_types = []
+  nullable = False
+  # If json schema type is an array, pick the first non null type.
+  for type_value in json_schema_type:
+    if type_value == "null":
+      nullable = True
+    else:
+      non_null_types.append(type_value)
+  non_null_type = non_null_types[0] if non_null_types else None
+  return non_null_type, nullable
+
+
+# TODO: Switch to Gemini `from_json_schema` util when it is released
+# in Gemini SDK.
 def to_gemini_schema(openapi_schema: Optional[Dict[str, Any]] = None) -> Schema:
   """Converts an OpenAPI schema dictionary to a Gemini Schema object.
 
@@ -82,13 +117,6 @@ def to_gemini_schema(openapi_schema: Optional[Dict[str, Any]] = None) -> Schema:
   if not openapi_schema.get("type"):
     openapi_schema["type"] = "object"
 
-  # Adding this to avoid "properties: should be non-empty for OBJECT type" error
-  # See b/385165182
-  if openapi_schema.get("type", "") == "object" and not openapi_schema.get(
-      "properties"
-  ):
-    openapi_schema["properties"] = {"dummy_DO_NOT_GENERATE": {"type": "string"}}
-
   for key, value in openapi_schema.items():
     snake_case_key = to_snake_case(key)
     # Check if the snake_case_key exists in the Schema model's fields.
@@ -99,7 +127,17 @@ def to_gemini_schema(openapi_schema: Optional[Dict[str, Any]] = None) -> Schema:
         # Format: properties[expiration].format: only 'enum' and 'date-time' are
         # supported for STRING type
         continue
-      if snake_case_key == "properties" and isinstance(value, dict):
+      elif snake_case_key == "type":
+        schema_type, nullable = normalize_json_schema_type(
+            openapi_schema.get("type", None)
+        )
+        # Adding this to force adding a type to an empty dict
+        # This avoid "... one_of or any_of must specify a type" error
+        pydantic_schema_data["type"] = schema_type if schema_type else "object"
+        pydantic_schema_data["type"] = pydantic_schema_data["type"].upper()
+        if nullable:
+          pydantic_schema_data["nullable"] = True
+      elif snake_case_key == "properties" and isinstance(value, dict):
         pydantic_schema_data[snake_case_key] = {
             k: to_gemini_schema(v) for k, v in value.items()
         }

google/adk/version.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 
 # version: date+base_cl
-__version__ = "0.2.0"
+__version__ = "0.3.0"