feat(genai): Add thinking feature examples (#13341)

* feat(genai): Add example for thinking feature

- Created a new folder for thinking models
- Add new thinking_budget example
- Add new thinking include_thoughts example

* Update genai/thinking/thinking_with_txt.py

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* feat(genai): update model name

---------

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

Author: msampathkumar

genai/text_generation/thinking_textgen_with_txt.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 
+# TODO: To deprecate this sample. Moving thinking samples to `thinking` folder.
 def generate_content() -> str:
     # [START googlegenaisdk_thinking_textgen_with_txt]
     from google import genai

genai/thinking/noxfile_config.py

@@ -0,0 +1,42 @@
+# Copyright 2021 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.
+
+# Default TEST_CONFIG_OVERRIDE for python repos.
+
+# You can copy this file into your directory, then it will be imported from
+# the noxfile.py.
+
+# The source of truth:
+# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
+
+TEST_CONFIG_OVERRIDE = {
+    # You can opt out from the test for specific Python versions.
+    "ignored_versions": ["2.7", "3.7", "3.8", "3.10", "3.11", "3.12"],
+    # Old samples are opted out of enforcing Python type hints
+    # All new samples should feature them
+    "enforce_type_hints": True,
+    # An envvar key for determining the project id to use. Change it
+    # to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
+    # build specific Cloud project. You can also use your own string
+    # to use your own Cloud project.
+    "gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
+    # 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
+    # If you need to use a specific version of pip,
+    # change pip_version_override to the string representation
+    # of the version number, for example, "20.2.4"
+    "pip_version_override": None,
+    # A dictionary you want to inject into your test. Don't put any
+    # secrets here. These values will override predefined values.
+    "envs": {},
+}

genai/thinking/requirements-test.txt

@@ -0,0 +1,4 @@
+backoff==2.2.1
+google-api-core==2.19.0
+pytest==8.2.0
+pytest-asyncio==0.23.6

genai/thinking/requirements.txt

@@ -0,0 +1 @@
+google-genai==1.13.0

genai/thinking/test_thinking_examples.py

@@ -0,0 +1,35 @@
+# 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
+
+import thinking_budget_with_txt
+import thinking_includethoughts_with_txt
+import thinking_with_txt
+
+os.environ["GOOGLE_GENAI_USE_VERTEXAI"] = "True"
+os.environ["GOOGLE_CLOUD_LOCATION"] = "us-central1"
+# The project name is included in the CICD pipeline
+# os.environ['GOOGLE_CLOUD_PROJECT'] = "add-your-project-name"
+
+
+def test_thinking_budget_with_txt() -> None:
+    assert thinking_budget_with_txt.generate_content()
+
+
+def test_thinking_includethoughts_with_txt() -> None:
+    assert thinking_includethoughts_with_txt.generate_content()
+
+
+def test_thinking_with_txt() -> None:
+    assert thinking_with_txt.generate_content()

genai/thinking/thinking_budget_with_txt.py

@@ -0,0 +1,58 @@
+# 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
+#
+#    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.
+
+
+def generate_content() -> str:
+    # [START googlegenaisdk_thinking_budget_with_txt]
+    from google import genai
+    from google.genai.types import GenerateContentConfig, ThinkingConfig
+
+    client = genai.Client()
+
+    response = client.models.generate_content(
+        model="gemini-2.5-flash-preview-04-17",
+        contents="solve x^2 + 4x + 4 = 0",
+        config=GenerateContentConfig(
+            thinking_config=ThinkingConfig(
+                thinking_budget=1024,  # Use `0` to turn off thinking
+            )
+        ),
+    )
+
+    print(response.text)
+    # Example response:
+    #     To solve the equation $x^2 + 4x + 4 = 0$, you can use several methods:
+    #     **Method 1: Factoring**
+    #     1.  Look for two numbers that multiply to the constant term (4) and add up to the coefficient of the $x$ term (4).
+    #     2.  The numbers are 2 and 2 ($2 \times 2 = 4$ and $2 + 2 = 4$).
+    #     ...
+    #     ...
+    #     All three methods yield the same solution. This quadratic equation has exactly one distinct solution (a repeated root).
+    #     The solution is **x = -2**.
+
+    # Token count for `Thinking`
+    print(response.usage_metadata.thoughts_token_count)
+    # Example response:
+    #     886
+
+    # Total token count
+    print(response.usage_metadata.total_token_count)
+    # Example response:
+    #     1525
+    # [END googlegenaisdk_thinking_budget_with_txt]
+    return response.text
+
+
+if __name__ == "__main__":
+    generate_content()

genai/thinking/thinking_includethoughts_with_txt.py

@@ -0,0 +1,80 @@
+# 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
+#
+#    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.
+
+
+def generate_content() -> str:
+    # [START googlegenaisdk_thinking_includethoughts_with_txt]
+    from google import genai
+    from google.genai.types import GenerateContentConfig, ThinkingConfig
+
+    client = genai.Client()
+    response = client.models.generate_content(
+        model="gemini-2.5-pro-preview-05-06",
+        contents="solve x^2 + 4x + 4 = 0",
+        config=GenerateContentConfig(
+            thinking_config=ThinkingConfig(include_thoughts=True)
+        ),
+    )
+
+    print(response.text)
+    # Example Response:
+    #     Okay, let's solve the quadratic equation x² + 4x + 4 = 0.
+    #     ...
+    #     **Answer:**
+    #     The solution to the equation x² + 4x + 4 = 0 is x = -2. This is a repeated root (or a root with multiplicity 2).
+
+    for part in response.candidates[0].content.parts:
+        if part and part.thought:  # show thoughts
+            print(part.text)
+    # Example Response:
+    #     **My Thought Process for Solving the Quadratic Equation**
+    #
+    #     Alright, let's break down this quadratic, x² + 4x + 4 = 0. First things first:
+    #     it's a quadratic; the x² term gives it away, and we know the general form is
+    #     ax² + bx + c = 0.
+    #
+    #     So, let's identify the coefficients: a = 1, b = 4, and c = 4. Now, what's the
+    #     most efficient path to the solution? My gut tells me to try factoring; it's
+    #     often the fastest route if it works. If that fails, I'll default to the quadratic
+    #     formula, which is foolproof. Completing the square? It's good for deriving the
+    #     formula or when factoring is difficult, but not usually my first choice for
+    #     direct solving, but it can't hurt to keep it as an option.
+    #
+    #     Factoring, then. I need to find two numbers that multiply to 'c' (4) and add
+    #     up to 'b' (4). Let's see... 1 and 4 don't work (add up to 5). 2 and 2? Bingo!
+    #     They multiply to 4 and add up to 4. This means I can rewrite the equation as
+    #     (x + 2)(x + 2) = 0, or more concisely, (x + 2)² = 0. Solving for x is now
+    #     trivial: x + 2 = 0, thus x = -2.
+    #
+    #     Okay, just to be absolutely certain, I'll run the quadratic formula just to
+    #     double-check. x = [-b ± √(b² - 4ac)] / 2a. Plugging in the values, x = [-4 ±
+    #     √(4² - 4 * 1 * 4)] / (2 * 1). That simplifies to x = [-4 ± √0] / 2. So, x =
+    #     -2 again – a repeated root. Nice.
+    #
+    #     Now, let's check via completing the square. Starting from the same equation,
+    #     (x² + 4x) = -4. Take half of the b-value (4/2 = 2), square it (2² = 4), and
+    #     add it to both sides, so x² + 4x + 4 = -4 + 4. Which simplifies into (x + 2)²
+    #     = 0. The square root on both sides gives us x + 2 = 0, therefore x = -2, as
+    #      expected.
+    #
+    #     Always, *always* confirm! Let's substitute x = -2 back into the original
+    #     equation: (-2)² + 4(-2) + 4 = 0. That's 4 - 8 + 4 = 0. It checks out.
+    #
+    #     Conclusion: the solution is x = -2. Confirmed.
+    # [END googlegenaisdk_thinking_includethoughts_with_txt]
+    return response.text
+
+
+if __name__ == "__main__":
+    generate_content()

genai/thinking/thinking_with_txt.py

@@ -0,0 +1,77 @@
+# 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.
+
+
+def generate_content() -> str:
+    # [START googlegenaisdk_thinking_with_txt]
+    from google import genai
+
+    client = genai.Client()
+    response = client.models.generate_content(
+        model="gemini-2.5-pro-preview-05-06",
+        contents="solve x^2 + 4x + 4 = 0",
+    )
+    print(response.text)
+    # Example Response:
+    #     Okay, let's solve the quadratic equation x² + 4x + 4 = 0.
+    #
+    #     We can solve this equation by factoring, using the quadratic formula, or by recognizing it as a perfect square trinomial.
+    #
+    #     **Method 1: Factoring**
+    #
+    #     1.  We need two numbers that multiply to the constant term (4) and add up to the coefficient of the x term (4).
+    #     2.  The numbers 2 and 2 satisfy these conditions: 2 * 2 = 4 and 2 + 2 = 4.
+    #     3.  So, we can factor the quadratic as:
+    #         (x + 2)(x + 2) = 0
+    #         or
+    #         (x + 2)² = 0
+    #     4.  For the product to be zero, the factor must be zero:
+    #         x + 2 = 0
+    #     5.  Solve for x:
+    #         x = -2
+    #
+    #     **Method 2: Quadratic Formula**
+    #
+    #     The quadratic formula for an equation ax² + bx + c = 0 is:
+    #     x = [-b ± sqrt(b² - 4ac)] / (2a)
+    #
+    #     1.  In our equation x² + 4x + 4 = 0, we have a=1, b=4, and c=4.
+    #     2.  Substitute these values into the formula:
+    #         x = [-4 ± sqrt(4² - 4 * 1 * 4)] / (2 * 1)
+    #         x = [-4 ± sqrt(16 - 16)] / 2
+    #         x = [-4 ± sqrt(0)] / 2
+    #         x = [-4 ± 0] / 2
+    #         x = -4 / 2
+    #         x = -2
+    #
+    #     **Method 3: Perfect Square Trinomial**
+    #
+    #     1.  Notice that the expression x² + 4x + 4 fits the pattern of a perfect square trinomial: a² + 2ab + b², where a=x and b=2.
+    #     2.  We can rewrite the equation as:
+    #         (x + 2)² = 0
+    #     3.  Take the square root of both sides:
+    #         x + 2 = 0
+    #     4.  Solve for x:
+    #         x = -2
+    #
+    #     All methods lead to the same solution.
+    #
+    #     **Answer:**
+    #     The solution to the equation x² + 4x + 4 = 0 is x = -2. This is a repeated root (or a root with multiplicity 2).
+    # [END googlegenaisdk_thinking_with_txt]
+    return response.text
+
+
+if __name__ == "__main__":
+    generate_content()