feat: (Gen AI): Add sample for Gemini parallel function calling example (GoogleCloudPlatform#12637)

Valeriy-Burlaka · web-flow · commit bfcf3554a617 · 2024-10-03T18:47:43.000+02:00
* Add Python sample for Gemini parallel function calling

* Update model version

* rename test file to follow standard naming practice

* move function_calling tests into a single file

* give up to the pylint import-order unconfigured check

* refresh CI checks

* update region name to follow up the standard schema

* update region tag name after a discussion
diff --git a/generative_ai/function_calling/examples_function_calling_test.py b/generative_ai/function_calling/examples_function_calling_test.py
diff --git a/generative_ai/function_calling/parallel_function_calling_example.py b/generative_ai/function_calling/parallel_function_calling_example.py
@@ -0,0 +1,107 @@
+# Copyright 2024 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
+#
+#    https://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
+
+from vertexai.generative_models import ChatSession
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def parallel_function_calling_example() -> ChatSession:
+    # [START generativeaionvertexai_function_calling_generate_parallel_calls]
+    import vertexai
+    from vertexai.generative_models import (
+        FunctionDeclaration,
+        GenerativeModel,
+        Part,
+        Tool,
+    )
+
+    # TODO(developer): Update & uncomment below line
+    # PROJECT_ID = "your-project-id"
+
+    # Initialize Vertex AI
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Specify a function declaration and parameters for an API request
+    function_name = "get_current_weather"
+    get_current_weather_func = FunctionDeclaration(
+        name=function_name,
+        description="Get the current weather in a given location",
+        parameters={
+            "type": "object",
+            "properties": {
+                "location": {
+                    "type": "string",
+                    "description": "The location to whih to get the weather. Can be a city name, a city name and state, or a zip code. Examples: 'San Francisco', 'San Francisco, CA', '95616', etc."
+                },
+            },
+        },
+    )
+
+    # In this example, we'll use synthetic data to simulate a response payload from an external API
+    def mock_weather_api_service(location: str) -> str:
+        temperature = 25 if location == "San Francisco" else 35
+        return f"""{{ "location": "{location}", "temperature": {temperature}, "unit": "C" }}"""
+
+    # Define a tool that includes the above function
+    tools = Tool(
+        function_declarations=[get_current_weather_func],
+    )
+
+    # Initialize Gemini model
+    model = GenerativeModel(
+        model_name="gemini-1.5-pro-002",
+        tools=[tools],
+    )
+
+    # Start a chat session
+    chat = model.start_chat()
+    response = chat.send_message("Get weather details in New Delhi and San Francisco?")
+
+    function_calls = response.candidates[0].function_calls
+    print("Suggested finction calls:\n", function_calls)
+
+    if function_calls:
+        api_responses = []
+        for func in function_calls:
+            if func.name == function_name:
+                api_responses.append({
+                    "content": mock_weather_api_service(location=func.args["location"])
+                })
+
+        # Return the API response to Gemini
+        response = chat.send_message(
+          [
+            Part.from_function_response(
+                name="get_current_weather",
+                response=api_responses[0],
+            ),
+            Part.from_function_response(
+                name="get_current_weather",
+                response=api_responses[1],
+            ),
+          ],
+        )
+
+        print(response.text)
+        # Example response:
+        # The current weather in New Delhi is 35°C. The current weather in San Francisco is 25°C.
+
+        # [END generativeaionvertexai_function_calling_generate_parallel_calls]
+        return response
+
+
+if __name__ == "__main__":
+    parallel_function_calling_example()
diff --git a/generative_ai/function_calling/test_function_calling.py b/generative_ai/function_calling/test_function_calling.py
@@ -11,23 +11,46 @@
 # 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 backoff
+import advanced_example
 
+import backoff
 
+import basic_example
 import chat_example
-
 import chat_function_calling_basic
 import chat_function_calling_config
 
 from google.api_core.exceptions import ResourceExhausted
 
-summaries_expected = [
-    "Pixel 8 Pro",
-    "stock",
-    "store",
-    "2000 N Shoreline Blvd",
-    "Mountain View",
-]
+import parallel_function_calling_example
+
+
+@backoff.on_exception(backoff.expo, ResourceExhausted, max_time=10)
+def test_function_calling() -> None:
+    response = basic_example.generate_function_call()
+
+    expected_summary = [
+        "Boston",
+    ]
+    expected_responses = [
+        "candidates",
+        "content",
+        "role",
+        "model",
+        "parts",
+        "Boston",
+    ]
+    assert all(x in str(response.text) for x in expected_summary)
+    assert all(x in str(response) for x in expected_responses)
+
+
+@backoff.on_exception(backoff.expo, ResourceExhausted, max_time=10)
+def test_function_calling_advanced_function_selection() -> None:
+    response = advanced_example.generate_function_call_advanced()
+    assert (
+        "Pixel 8 Pro 128GB"
+        in response.candidates[0].function_calls[0].args["product_name"]
+    )
 
 
 @backoff.on_exception(backoff.expo, ResourceExhausted, max_time=10)
@@ -48,4 +71,18 @@ def test_function_calling_chat() -> None:
 
     assert chat
     assert chat.history
-    assert any(x in str(chat.history) for x in summaries_expected)
+
+    expected_summaries = [
+        "Pixel 8 Pro",
+        "stock",
+        "store",
+        "2000 N Shoreline Blvd",
+        "Mountain View",
+    ]
+    assert any(x in str(chat.history) for x in expected_summaries)
+
+
+@backoff.on_exception(backoff.expo, ResourceExhausted, max_time=10)
+def test_parallel_function_calling() -> None:
+    response = parallel_function_calling_example.parallel_function_calling_example()
+    assert response is not None
