gemini/function-calling/forced_function_calling.ipynb

{
  "cells": [
    {
      "cell_type": "code",
      "execution_count": 1,
      "metadata": {
        "id": "ur8xi4C7S06n"
      },
      "outputs": [],
      "source": [
        "# Copyright 2024 Google LLC\n",
        "#\n",
        "# Licensed under the Apache License, Version 2.0 (the \"License\");\n",
        "# you may not use this file except in compliance with the License.\n",
        "# You may obtain a copy of the License at\n",
        "#\n",
        "#     https://www.apache.org/licenses/LICENSE-2.0\n",
        "#\n",
        "# Unless required by applicable law or agreed to in writing, software\n",
        "# distributed under the License is distributed on an \"AS IS\" BASIS,\n",
        "# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n",
        "# See the License for the specific language governing permissions and\n",
        "# limitations under the License."
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "JAPoU8Sm5E6e"
      },
      "source": [
        "# Forced Function Calling with Tool Configurations in Gemini\n",
        "\n",
        "<table align=\"left\">\n",
        "  <td style=\"text-align: center\">\n",
        "    <a href=\"https://colab.research.google.com/github/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\">\n",
        "      <img src=\"https://cloud.google.com/ml-engine/images/colab-logo-32px.png\" alt=\"Google Colaboratory logo\"><br> Open in Colab\n",
        "    </a>\n",
        "  </td>\n",
        "  <td style=\"text-align: center\">\n",
        "    <a href=\"https://console.cloud.google.com/vertex-ai/colab/import/https:%2F%2Fraw.githubusercontent.com%2FGoogleCloudPlatform%2Fgenerative-ai%2Fmain%2Fgemini%2Ffunction-calling%2Fforced_function_calling.ipynb\">\n",
        "      <img width=\"32px\" src=\"https://lh3.googleusercontent.com/JmcxdQi-qOpctIvWKgPtrzZdJJK-J3sWE1RsfjZNwshCFgE_9fULcNpuXYTilIR2hjwN\" alt=\"Google Cloud Colab Enterprise logo\"><br> Open in Colab Enterprise\n",
        "    </a>\n",
        "  </td>    \n",
        "  <td style=\"text-align: center\">\n",
        "    <a href=\"https://console.cloud.google.com/vertex-ai/workbench/deploy-notebook?download_url=https://raw.githubusercontent.com/GoogleCloudPlatform/generative-ai/main/gemini/function-calling/forced_function_calling.ipynb\">\n",
        "      <img src=\"https://lh3.googleusercontent.com/UiNooY4LUgW_oTvpsNhPpQzsstV5W8F7rYgxgGBD85cWJoLmrOzhVs_ksK_vgx40SHs7jCqkTkCk=e14-rj-sc0xffffff-h130-w32\" alt=\"Vertex AI logo\"><br> Open in Workbench\n",
        "    </a>\n",
        "  </td>\n",
        "  <td style=\"text-align: center\">\n",
        "    <a href=\"https://github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\">\n",
        "      <img src=\"https://cloud.google.com/ml-engine/images/github-logo-32px.png\" alt=\"GitHub logo\"><br> View on GitHub\n",
        "    </a>\n",
        "  </td>\n",
        "</table>\n",
        "\n",
        "<div style=\"clear: both;\"></div>\n",
        "\n",
        "<b>Share to:</b>\n",
        "\n",
        "<a href=\"https://www.linkedin.com/sharing/share-offsite/?url=https%3A//github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\" target=\"_blank\">\n",
        "  <img width=\"20px\" src=\"https://upload.wikimedia.org/wikipedia/commons/8/81/LinkedIn_icon.svg\" alt=\"LinkedIn logo\">\n",
        "</a>\n",
        "\n",
        "<a href=\"https://bsky.app/intent/compose?text=https%3A//github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\" target=\"_blank\">\n",
        "  <img width=\"20px\" src=\"https://upload.wikimedia.org/wikipedia/commons/7/7a/Bluesky_Logo.svg\" alt=\"Bluesky logo\">\n",
        "</a>\n",
        "\n",
        "<a href=\"https://twitter.com/intent/tweet?url=https%3A//github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\" target=\"_blank\">\n",
        "  <img width=\"20px\" src=\"https://upload.wikimedia.org/wikipedia/commons/5/53/X_logo_2023_original.svg\" alt=\"X logo\">\n",
        "</a>\n",
        "\n",
        "<a href=\"https://reddit.com/submit?url=https%3A//github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\" target=\"_blank\">\n",
        "  <img width=\"20px\" src=\"https://redditinc.com/hubfs/Reddit%20Inc/Brand/Reddit_Logo.png\" alt=\"Reddit logo\">\n",
        "</a>\n",
        "\n",
        "<a href=\"https://www.facebook.com/sharer/sharer.php?u=https%3A//github.com/GoogleCloudPlatform/generative-ai/blob/main/gemini/function-calling/forced_function_calling.ipynb\" target=\"_blank\">\n",
        "  <img width=\"20px\" src=\"https://upload.wikimedia.org/wikipedia/commons/5/51/Facebook_f_logo_%282019%29.svg\" alt=\"Facebook logo\">\n",
        "</a>            "
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "84f0f73a0f76"
      },
      "source": [
        "| | |\n",
        "|-|-|\n",
        "| Author(s) | [Kristopher Overholt](https://github.com/koverholt) |"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "tvgnzT1CKxrO"
      },
      "source": [
        "## Overview\n",
        "\n",
        "This notebook demonstrates the use of forced Function Calling in the Gemini model.\n",
        "\n",
        "### Gemini\n",
        "\n",
        "Gemini is a family of generative AI models developed by Google DeepMind that is designed for multimodal use cases.\n",
        "\n",
        "### Function Calling in Gemini\n",
        "\n",
        "[Function Calling in Gemini](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling) lets developers create a description of a function in their code, then pass that description to a language model in a request. The response from the model includes the name of a function that matches the description and the arguments to call it with.\n",
        "\n",
        "### Forced Function Calling\n",
        "\n",
        "[Forced Function Calling in Gemini](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling#tool-config) allows you to place constraints on how the model should use the function declarations that you provide it with. Using tool configurations, you can force the Gemini model to only predict function calls. You can also choose to provide the model with a full set of function declarations, but restrict its responses to a subset of these functions.\n",
        "\n",
        "## Objectives\n",
        "\n",
        "In this tutorial, you will learn how to use the Vertex AI SDK for Python to use different function calling modes, including forced function calling, via the Gemini model.\n",
        "\n",
        "You will complete the following tasks:\n",
        "\n",
        "- Read through an overview of forced function calling and when to use it\n",
        "- Use the default function calling behavior in `AUTO` mode\n",
        "- Enable forced function calling using the `ANY` mode\n",
        "- Disable function calling using the `NONE` mode"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "61RBz8LLbxCR"
      },
      "source": [
        "## Getting Started"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "No17Cw5hgx12"
      },
      "source": [
        "### Install Vertex AI SDK and other required packages"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 2,
      "metadata": {
        "id": "tFy3H3aPgx12"
      },
      "outputs": [],
      "source": [
        "%pip install --upgrade --user --quiet google-cloud-aiplatform arxiv"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "R5Xep4W9lq-Z"
      },
      "source": [
        "### Restart runtime\n",
        "\n",
        "To use the newly installed packages in this Jupyter runtime, you must restart the runtime. You can do this by running the cell below, which restarts the current kernel.\n",
        "\n",
        "The restart might take a minute or longer. After it's restarted, continue to the next step."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 3,
      "metadata": {
        "id": "XRvKdaPDTznN"
      },
      "outputs": [],
      "source": [
        "import IPython\n",
        "\n",
        "app = IPython.Application.instance()\n",
        "app.kernel.do_shutdown(True)"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "SbmM4z7FOBpM"
      },
      "source": [
        "<div class=\"alert alert-block alert-warning\">\n",
        "<b>⚠️ The kernel is going to restart. Please wait until it is finished before continuing to the next step. ⚠️</b>\n",
        "</div>"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "dmWOrTJ3gx13"
      },
      "source": [
        "### Authenticate your notebook environment (Colab only)\n",
        "\n",
        "If you are running this notebook on Google Colab, run the cell below to authenticate your environment."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 4,
      "metadata": {
        "id": "NyKGtVQjgx13"
      },
      "outputs": [],
      "source": [
        "import sys\n",
        "\n",
        "if \"google.colab\" in sys.modules:\n",
        "    from google.colab import auth\n",
        "\n",
        "    auth.authenticate_user()"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "DF4l8DTdWgPY"
      },
      "source": [
        "### Set Google Cloud project information and initialize Vertex AI SDK\n",
        "\n",
        "To get started using Vertex AI, you must have an existing Google Cloud project and [enable the Vertex AI API](https://console.cloud.google.com/flows/enableapi?apiid=aiplatform.googleapis.com).\n",
        "\n",
        "Learn more about [setting up a project and a development environment](https://cloud.google.com/vertex-ai/docs/start/cloud-environment)."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 5,
      "metadata": {
        "id": "Nqwi-5ufWp_B"
      },
      "outputs": [],
      "source": [
        "PROJECT_ID = \"[your-project-id]\"  # @param {type:\"string\"}\n",
        "LOCATION = \"us-central1\"  # @param {type:\"string\"}\n",
        "\n",
        "import vertexai\n",
        "\n",
        "vertexai.init(project=PROJECT_ID, location=LOCATION)"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "23a24049e443"
      },
      "source": [
        "## Import libraries"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 6,
      "metadata": {
        "id": "cc6278ff6e55"
      },
      "outputs": [],
      "source": [
        "from IPython.display import Markdown, display\n",
        "import arxiv\n",
        "from vertexai.generative_models import (\n",
        "    Content,\n",
        "    FunctionDeclaration,\n",
        "    GenerationConfig,\n",
        "    GenerativeModel,\n",
        "    Part,\n",
        "    Tool,\n",
        ")\n",
        "from vertexai.preview.generative_models import ToolConfig"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "b1b86cbda668"
      },
      "source": [
        "## Initialize model"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "d091edc81048"
      },
      "source": [
        "Initialize the Gemini model. Refer to the [Gemini Function Calling documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling) for more information on which models and model versions support forced function calling and tool configurations."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 7,
      "metadata": {
        "id": "c8922eacdb2d"
      },
      "outputs": [],
      "source": [
        "model = GenerativeModel(\n",
        "    \"gemini-1.5-pro\",\n",
        "    generation_config=GenerationConfig(temperature=0),\n",
        ")"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "0505b45fa754"
      },
      "source": [
        "## Define a function to search for scientific papers in arXiv"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "b0d0383ad6bb"
      },
      "source": [
        "Since this notebook focuses on using different tool configurations and modes in Gemini Function Calling, you'll define a function declaration to use throughout the examples. The purpose of this function is to extract a parameter to send as a query to search for relevant papers in [arXiv](https://arxiv.org/). arXiv is an open-access repository of electronic preprints and postprints that consists of scientific papers in various fields."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 8,
      "metadata": {
        "id": "72440503b923"
      },
      "outputs": [],
      "source": [
        "search_arxiv = FunctionDeclaration(\n",
        "    name=\"search_arxiv\",\n",
        "    description=\"Search for articles and publications in arXiv\",\n",
        "    parameters={\n",
        "        \"type\": \"object\",\n",
        "        \"properties\": {\n",
        "            \"query\": {\"type\": \"string\", \"description\": \"Query to search for in arXiv\"}\n",
        "        },\n",
        "    },\n",
        ")"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "17f31eb30c46"
      },
      "source": [
        "Define a tool that wraps the above function:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 9,
      "metadata": {
        "id": "e4d7150e5b03"
      },
      "outputs": [],
      "source": [
        "search_tool = Tool(\n",
        "    function_declarations=[\n",
        "        search_arxiv,\n",
        "    ],\n",
        ")"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "6a12e1e637c7"
      },
      "source": [
        "You'll use this function declaration and tool throughout the next few sections of the notebook."
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "3a043e118735"
      },
      "source": [
        "## Overview of Forced Function Calling in Gemini"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "0d17a45fcea5"
      },
      "source": [
        "The default behavior for Function Calling allows the Gemini model to decide whether to predict a function call or a natural language response. This is because the default Function Calling mode in Gemini is set to `AUTO`.\n",
        "\n",
        "In most cases this is the desired behavior when you want the Gemini model to use information from the prompt to determine if it should call a function, and which function it should call. However, you might have specific use cases where you want to **force** the Gemini model to call a function (or a set of functions) in a given model generation request.\n",
        "\n",
        "Tool configurations in the Gemini API allow you to specify different Function Calling modes in Gemini. Refer to the [Gemini Function Calling documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/function-calling) for more information on forced function calling and tool configurations.\n",
        "\n",
        "The following code example for `tool_config` shows various modes that you can set and pass to the Gemini model either globally when you initialize the model or for a given model generation request:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 10,
      "metadata": {
        "id": "87ed22a37890"
      },
      "outputs": [],
      "source": [
        "# tool_config = ToolConfig(\n",
        "#     function_calling_config =\n",
        "#         ToolConfig.FunctionCallingConfig(\n",
        "#             mode=ToolConfig.FunctionCallingConfig.Mode.AUTO,  # The default model behavior. The model decides whether to predict a function call or a natural language response.\n",
        "#             mode=ToolConfig.FunctionCallingConfig.Mode.ANY,  # ANY mode forces the model to predict a function call from a subset of function names.\n",
        "#             mode=ToolConfig.FunctionCallingConfig.Mode.NONE,  # NONE mode instructs the model to not predict function calls. Equivalent to a model request without any function declarations.\n",
        "#             allowed_function_names = [\"function_to_call\"]  # Allowed functions to call when mode is ANY, if empty any one of the provided functions will be called.\n",
        "#         )\n",
        "# )"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "9d7b8f90625d"
      },
      "source": [
        "Using these Function Calling modes, you can configure the model to behave in one of the following ways:\n",
        "\n",
        "- Allow the model to choose whether to predict a function call or natural language response (`AUTO` mode)\n",
        "- Force the model to predict a function call on one function or a set of functions (`ANY` mode)\n",
        "- Disable function calling and return a natural language response as if no functions or tools were defined (`NONE` mode)\n",
        "\n",
        "In the following sections, you'll walk through examples and sample code for each Function Calling mode."
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "5ab06d57a134"
      },
      "source": [
        "## Example: Default Function Calling mode (`AUTO`)"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "3a3b8124f0fc"
      },
      "source": [
        "In this example, you'll specify the function calling mode as `AUTO`. Note that `AUTO` mode is the default model behavior, therefore the Gemini model will also use this mode when there is no `tool_config` specified:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 11,
      "metadata": {
        "id": "50b1009e342b"
      },
      "outputs": [],
      "source": [
        "tool_config = ToolConfig(\n",
        "    function_calling_config=ToolConfig.FunctionCallingConfig(\n",
        "        mode=ToolConfig.FunctionCallingConfig.Mode.AUTO,  # The default model behavior. The model decides whether to predict a function call or a natural language response.\n",
        "    )\n",
        ")"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "a1c7e020ee38"
      },
      "source": [
        "Ask a question about a topic related to publications in arXiv and include the `tool_config` kwarg. Note that you can also set the `tool_config` kwarg globally in the model rather than with every request to generate content:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 12,
      "metadata": {
        "id": "0c22b8e9a99a"
      },
      "outputs": [
        {
          "data": {
            "text/markdown": [
              "The Schrödinger equation is a fundamental equation in quantum mechanics that describes how the quantum state of a physical system changes over time. It is a linear partial differential equation that governs the wave function of a quantum-mechanical system. The equation is named after Erwin Schrödinger, who derived it in 1925 and published it in 1926.\n",
              "\n"
            ],
            "text/plain": [
              "<IPython.core.display.Markdown object>"
            ]
          },
          "metadata": {},
          "output_type": "display_data"
        }
      ],
      "source": [
        "prompt = \"Explain the Schrodinger equation in a few sentences and give me papers from arXiv to learn more\"\n",
        "response = model.generate_content(prompt, tools=[search_tool], tool_config=tool_config)\n",
        "\n",
        "display(Markdown(response.candidates[0].content.parts[0].text))"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "63ee50104549"
      },
      "source": [
        "The response includes a natural language summary to the prompt. However, you were probably hoping to make a function call along the way to search for actual papers in arXiv and return them to the end user!\n",
        "\n",
        "We'll make that happen in the next section by using the forced function calling mode."
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "ec647eed5130"
      },
      "source": [
        "## Example: Using Forced Function Calling mode (`ANY`)"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "f76d1bb4b4c9"
      },
      "source": [
        "In this example, you'll set the tool configuration to `ANY`, and (optionally) specify one or more `allowed_function_names` that will force Gemini to make a function call against a function or subset of functions:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 13,
      "metadata": {
        "id": "992c70f9a9b8"
      },
      "outputs": [],
      "source": [
        "tool_config = ToolConfig(\n",
        "    function_calling_config=ToolConfig.FunctionCallingConfig(\n",
        "        mode=ToolConfig.FunctionCallingConfig.Mode.ANY,  # ANY mode forces the model to predict a function call from a subset of function names.\n",
        "        allowed_function_names=[\n",
        "            \"search_arxiv\"\n",
        "        ],  # Allowed functions to call when mode is ANY, if empty any one of the provided functions will be called.\n",
        "    )\n",
        ")"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "60a33d7fff56"
      },
      "source": [
        "Now you can ask the same question publications in arXiv with our newly defined `tool_config` that is set to `ANY` function calling mode, which will force the Gemini model to call our search function."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 14,
      "metadata": {
        "id": "753d7d208f77"
      },
      "outputs": [
        {
          "data": {
            "text/plain": [
              "name: \"search_arxiv\"\n",
              "args {\n",
              "  fields {\n",
              "    key: \"query\"\n",
              "    value {\n",
              "      string_value: \"Schrödinger equation\"\n",
              "    }\n",
              "  }\n",
              "}"
            ]
          },
          "execution_count": 14,
          "metadata": {},
          "output_type": "execute_result"
        }
      ],
      "source": [
        "prompt = \"Explain the Schrodinger equation in a few sentences and give me papers from arXiv to learn more\"\n",
        "response = model.generate_content(prompt, tools=[search_tool], tool_config=tool_config)\n",
        "\n",
        "response_function_call_content = response.candidates[0].content\n",
        "response.candidates[0].content.parts[0].function_call"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "4f4715146eca"
      },
      "source": [
        "You can extract the parameters from the model response so that we can use them to make an API call to search papers in arXiv:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 15,
      "metadata": {
        "id": "a1ff96ee0db8"
      },
      "outputs": [
        {
          "data": {
            "text/plain": [
              "{'query': 'Schrödinger equation'}"
            ]
          },
          "execution_count": 15,
          "metadata": {},
          "output_type": "execute_result"
        }
      ],
      "source": [
        "params = {}\n",
        "for key, value in response.candidates[0].content.parts[0].function_call.args.items():\n",
        "    params[key] = value\n",
        "params"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 16,
      "metadata": {
        "id": "10754b0a94ba"
      },
      "outputs": [],
      "source": [
        "if response.candidates[0].content.parts[0].function_call.name == \"search_arxiv\":\n",
        "    client = arxiv.Client()\n",
        "\n",
        "    search = arxiv.Search(\n",
        "        query=params[\"query\"], max_results=10, sort_by=arxiv.SortCriterion.SubmittedDate\n",
        "    )\n",
        "\n",
        "    results = client.results(search)\n",
        "    results = str([r for r in results])"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "1f4e8482dcc2"
      },
      "source": [
        "Print a sample of the API response from arXiv:"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 17,
      "metadata": {
        "id": "d9ef5bebc0eb"
      },
      "outputs": [
        {
          "data": {
            "text/plain": [
              "'[arxiv.Result(entry_id=\\'http://arxiv.org/abs/2404.15250v1\\', updated=datetime.datetime(2024, 4, 23, 17, 36, 59, tzinfo=datetime.timezone.utc), published=datetime.datetime(2024, 4, 23, 17, 36, 59, tzinfo=datetime.timezone.utc), title=\\'Unifying the Temperature Dependent Dynamics of Glasses\\', authors=[arxiv.Result.Author(\\'Joseph B. Schlenoff\\'), arxiv.Result.Author(\\'Khalil Akkaoui\\')], summary=\\'Strong changes in bulk properties, such as modulus and viscosity, are\\\\nobserved near the glass transition temperature, T_{g}, of amorphous materials.\\\\nFor more than a century, intense efforts have been made to define a microscopic\\\\norigin for these macroscopic changes in properties. Using transition state\\\\ntheory, we delve into the atomic/molecular level picture of how microscopic\\\\nlocalized relaxations, or \"cage rattles,\" translate to macroscopic structural\\\\nrelaxations above T_{g}. Unit motion is broken down into two populations: (1)\\\\nsimultaneous rearrangement occurs among a critical number of unit'"
            ]
          },
          "execution_count": 17,
          "metadata": {},
          "output_type": "execute_result"
        }
      ],
      "source": [
        "results[:1000]"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 18,
      "metadata": {
        "id": "fae1aaee9fe3"
      },
      "outputs": [
        {
          "data": {
            "text/markdown": [
              "The Schrödinger equation is a fundamental equation in quantum mechanics that describes how the quantum state of a physical system changes over time. It is a partial differential equation that involves the wavefunction of the system, which contains all the information about the system's state. The equation is named after Erwin Schrödinger, who first proposed it in 1926.\n",
              "\n",
              "Here are a few papers from arXiv that you can read to learn more about the Schrödinger equation:\n",
              "\n",
              "*   **\"Unifying the Temperature Dependent Dynamics of Glasses\"** (arXiv:2404.15250v1) This paper discusses the use of transition state theory to understand the atomic/molecular level picture of how microscopic localized relaxations translate to macroscopic structural relaxations above the glass transition temperature.\n",
              "*   **\"A GPU-accelerated Cartesian grid method for PDEs on irregular domain\"** (arXiv:2404.15249v1) This paper presents a GPU-accelerated Cartesian grid method for solving partial differential equations (PDEs) on irregular domains. \n",
              "*   **\"A Hybrid Kernel-Free Boundary Integral Method with Operator Learning for Solving Parametric Partial Differential Equations In Complex Domains\"** (arXiv:2404.15242v1) This paper proposes a hybrid kernel-free boundary integral method that integrates the foundational principles of the KFBI method with the capabilities of deep learning. \n"
            ],
            "text/plain": [
              "<IPython.core.display.Markdown object>"
            ]
          },
          "metadata": {},
          "output_type": "display_data"
        }
      ],
      "source": [
        "response = model.generate_content(\n",
        "    [\n",
        "        Content(\n",
        "            role=\"user\",\n",
        "            parts=[\n",
        "                Part.from_text(prompt),\n",
        "            ],\n",
        "        ),\n",
        "        response_function_call_content,  # Function call response\n",
        "        Content(\n",
        "            parts=[\n",
        "                Part.from_function_response(\n",
        "                    name=\"search_arxiv\",\n",
        "                    response={\n",
        "                        \"content\": results,  # Return the API response to the Gemini model\n",
        "                    },\n",
        "                )\n",
        "            ],\n",
        "        ),\n",
        "    ],\n",
        "    tools=[search_tool],\n",
        ")\n",
        "\n",
        "display(Markdown(response.text))"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "a97b13c2a45b"
      },
      "source": [
        "In this case, the natural language response contains information about relevant papers based on our function call to the arXiv API."
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "a64301e40297"
      },
      "source": [
        "## Example: Disabling Function Calling (`NONE`)\n",
        "\n",
        "In this example, you'll set the tool configuration to `NONE`, which will instruct the Gemini model to behave as if no tools or functions were defined."
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 19,
      "metadata": {
        "id": "cc0c43b9a696"
      },
      "outputs": [],
      "source": [
        "tool_config = ToolConfig(\n",
        "    function_calling_config=ToolConfig.FunctionCallingConfig(\n",
        "        mode=ToolConfig.FunctionCallingConfig.Mode.NONE,  # NONE mode instructs the model to not predict function calls. Equivalent to a model request without any function declarations.\n",
        "    )\n",
        ")"
      ]
    },
    {
      "cell_type": "code",
      "execution_count": 20,
      "metadata": {
        "id": "7678f426d195"
      },
      "outputs": [
        {
          "data": {
            "text/markdown": [
              "## The Schrödinger Equation Explained\n",
              "\n",
              "The Schrödinger equation is a fundamental equation in quantum mechanics that describes how the quantum state of a physical system changes over time. It is a linear partial differential equation that relates the wavefunction of a system to its energy and potential. The wavefunction, typically denoted by the Greek letter psi (ψ), contains all the information about a system, and its evolution in time governed by the Schrödinger equation determines the system's behavior. \n",
              "\n",
              "Essentially, the Schrödinger equation acts as the quantum counterpart to Newton's second law in classical mechanics, dictating how quantum systems evolve.\n",
              "\n",
              "### Delving Deeper: arXiv Papers\n",
              "\n",
              "arXiv is a fantastic resource for exploring scientific papers, including those related to the Schrödinger equation. Here are a few papers you might find helpful:\n",
              "\n",
              "*   **\"Derivation of the Schrödinger equation from classical stochastic dynamics\" (arXiv:1011.0674)**: This paper explores the connection between classical stochastic dynamics and the Schrödinger equation, offering a unique perspective on its foundations.\n",
              "*   **\"The Schrödinger equation as a diffusion equation\" (arXiv:quant-ph/0608221)**: This paper presents an interpretation of the Schrödinger equation as a diffusion equation, providing insights into the probabilistic nature of quantum mechanics.\n",
              "*   **\"Numerical solution of the time-dependent Schrödinger equation for a multielectron atom\" (arXiv:physics/0607082)**: This paper delves into the computational aspects of solving the Schrödinger equation for complex systems like multi-electron atoms.\n",
              "\n",
              "**Exploring arXiv with Keywords:**\n",
              "\n",
              "To discover more relevant papers, you can use keywords like \"Schrödinger equation,\" \"quantum mechanics,\" \"wavefunction,\" and \"quantum dynamics\" on the arXiv website. You can also filter your search by specific categories like \"quant-ph\" (quantum physics) or \"math-ph\" (mathematical physics).\n"
            ],
            "text/plain": [
              "<IPython.core.display.Markdown object>"
            ]
          },
          "metadata": {},
          "output_type": "display_data"
        }
      ],
      "source": [
        "prompt = \"Explain the Schrodinger equation in a few sentences and give me papers from arXiv to learn more\"\n",
        "response = model.generate_content(\n",
        "    prompt,\n",
        "    tool_config=tool_config,\n",
        ")\n",
        "\n",
        "display(Markdown(response.candidates[0].content.parts[0].text))"
      ]
    },
    {
      "cell_type": "markdown",
      "metadata": {
        "id": "7dc4ee73d814"
      },
      "source": [
        "Note that the natural language response only contains content that was generated by the Gemini model and within the scope of its training data rather than real-time information from the arXiv API."
      ]
    }
  ],
  "metadata": {
    "colab": {
      "name": "forced_function_calling.ipynb",
      "toc_visible": true
    },
    "kernelspec": {
      "display_name": "Python 3",
      "name": "python3"
    }
  },
  "nbformat": 4,
  "nbformat_minor": 0
}