feat(genai): Add new folder and samples for model optimizer (#13385)

msampathkumar · web-flow · commit 8ebc27d1cb41 · 2025-05-21T17:47:32.000+02:00
* feat(genai): add new folder for model optimizer

* chore(genai): sync nox test config files

* feat(genai): update README.md

* feat(genai): Update caching to use `v1` version
diff --git a/genai/README.md b/genai/README.md
@@ -53,11 +53,23 @@ Demonstrates how to use Express Mode for simpler and faster interactions with Ge
 This mode is ideal for quick prototyping and experimentation. See the [Express Mode documentation](https://cloud.google.com/vertex-ai/generative-ai/docs/start/express-mode/overview)
 for details.
 
+### [Image Generation](https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/genai/image_generation/)
+
+Demonstrates how to generate image and edit images using Generative AI models. Check [Image Generation with Gemini Flash](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal/image-generation)
+and [Imagen on Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/image/overview) for details.
+
+
 ### [Live API](https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/genai/live_api/)
 
 Provides examples of using the Generative AI [Live API](https://cloud.google.com/vertex-ai/generative-ai/docs/multimodal-live-api).
 This allows for real-time interactions and dynamic content generation.
 
+### [Model Optimizer](https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/genai/model_optimizer/)
+
+Provides examples of using the Generative AI [Model Optimizer](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/vertex-ai-model-optimizer).
+Vertex AI Model Optimizer is a dynamic endpoint designed to simplify model selection by automatically applying the 
+Gemini model which best meets your needs.
+
 ### [Provisioned Throughput](https://github.com/GoogleCloudPlatform/python-docs-samples/tree/main/genai/live_api/)
 
 Provides examples demonstrating how to use Provisioned Throughput with Generative AI models. This feature provides a
diff --git a/genai/bounding_box/noxfile_config.py b/genai/bounding_box/noxfile_config.py
@@ -22,7 +22,7 @@
 
 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.13"],
+    "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,
diff --git a/genai/content_cache/contentcache_create_with_txt_gcs_pdf.py b/genai/content_cache/contentcache_create_with_txt_gcs_pdf.py
@@ -18,7 +18,7 @@ def create_content_cache() -> str:
     from google import genai
     from google.genai.types import Content, CreateCachedContentConfig, HttpOptions, Part
 
-    client = genai.Client(http_options=HttpOptions(api_version="v1beta1"))
+    client = genai.Client(http_options=HttpOptions(api_version="v1"))
 
     system_instruction = """
     You are an expert researcher. You always stick to the facts in the sources provided, and never make up new facts.
diff --git a/genai/content_cache/contentcache_delete.py b/genai/content_cache/contentcache_delete.py
@@ -16,10 +16,8 @@
 def delete_context_caches(cache_name: str) -> str:
     # [START googlegenaisdk_contentcache_delete]
     from google import genai
-    from google.genai.types import HttpOptions
-
-    client = genai.Client(http_options=HttpOptions(api_version="v1beta1"))
 
+    client = genai.Client()
     # Delete content cache using name
     # E.g cache_name = 'projects/111111111111/locations/us-central1/cachedContents/1111111111111111111'
     client.caches.delete(name=cache_name)
diff --git a/genai/content_cache/contentcache_list.py b/genai/content_cache/contentcache_list.py
@@ -18,7 +18,7 @@ def list_context_caches() -> str:
     from google import genai
     from google.genai.types import HttpOptions
 
-    client = genai.Client(http_options=HttpOptions(api_version="v1beta1"))
+    client = genai.Client(http_options=HttpOptions(api_version="v1"))
 
     content_cache_list = client.caches.list()
 
diff --git a/genai/content_cache/contentcache_update.py b/genai/content_cache/contentcache_update.py
@@ -22,7 +22,7 @@ def update_content_cache(cache_name: str) -> str:
     from google import genai
     from google.genai.types import HttpOptions, UpdateCachedContentConfig
 
-    client = genai.Client(http_options=HttpOptions(api_version="v1beta1"))
+    client = genai.Client(http_options=HttpOptions(api_version="v1"))
 
     # Get content cache by name
     # cache_name = "projects/111111111111/locations/us-central1/cachedContents/1111111111111111111"
diff --git a/genai/content_cache/contentcache_use_with_txt.py b/genai/content_cache/contentcache_use_with_txt.py
@@ -18,8 +18,7 @@ def generate_content(cache_name: str) -> str:
     from google import genai
     from google.genai.types import GenerateContentConfig, HttpOptions
 
-    client = genai.Client(http_options=HttpOptions(api_version="v1beta1"))
-
+    client = genai.Client(http_options=HttpOptions(api_version="v1"))
     # Use content cache to generate text response
     # E.g cache_name = 'projects/111111111111/locations/us-central1/cachedContents/1111111111111111111'
     response = client.models.generate_content(
diff --git a/genai/embeddings/noxfile_config.py b/genai/embeddings/noxfile_config.py
@@ -22,7 +22,7 @@
 
 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.13"],
+    "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,
diff --git a/genai/express_mode/noxfile_config.py b/genai/express_mode/noxfile_config.py
@@ -22,7 +22,7 @@
 
 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.13"],
+    "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,
diff --git a/genai/image_generation/noxfile_config.py b/genai/image_generation/noxfile_config.py
@@ -22,7 +22,7 @@
 
 TEST_CONFIG_OVERRIDE = {
     # You can opt out from the test for specific Python versions.
-    "ignored_versions": ["2.7", "3.7", "3.8", "3.9", "3.10", "3.11", "3.13"],
+    "ignored_versions": ["2.7", "3.7", "3.8", "3.9", "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,
diff --git a/genai/model_optimizer/modeloptimizer_with_txt.py b/genai/model_optimizer/modeloptimizer_with_txt.py
@@ -0,0 +1,47 @@
+# 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_modeloptimizer_with_txt]
+    from google import genai
+    from google.genai.types import (
+        FeatureSelectionPreference,
+        GenerateContentConfig,
+        HttpOptions,
+        ModelSelectionConfig
+    )
+
+    client = genai.Client(http_options=HttpOptions(api_version="v1beta1"))
+    response = client.models.generate_content(
+        model="model-optimizer-exp-04-09",
+        contents="How does AI work?",
+        config=GenerateContentConfig(
+            model_selection_config=ModelSelectionConfig(
+                feature_selection_preference=FeatureSelectionPreference.BALANCED  # Options: PRIORITIZE_QUALITY, BALANCED, PRIORITIZE_COST
+            ),
+        ),
+    )
+    print(response.text)
+    # Example response:
+    # Okay, let's break down how AI works. It's a broad field, so I'll focus on the ...
+    #
+    # Here's a simplified overview:
+    # ...
+    # [END googlegenaisdk_modeloptimizer_with_txt]
+    return response.text
+
+
+if __name__ == "__main__":
+    generate_content()
diff --git a/genai/model_optimizer/noxfile_config.py b/genai/model_optimizer/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": {},
+}
diff --git a/genai/model_optimizer/requirements-test.txt b/genai/model_optimizer/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
diff --git a/genai/model_optimizer/requirements.txt b/genai/model_optimizer/requirements.txt
@@ -0,0 +1 @@
+google-genai==1.16.1
diff --git a/genai/model_optimizer/test_modeloptimizer_examples.py b/genai/model_optimizer/test_modeloptimizer_examples.py
@@ -0,0 +1,25 @@
+# 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.
+import os
+
+import modeloptimizer_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_modeloptimizer_with_txt() -> None:
+    assert modeloptimizer_with_txt.generate_content()
diff --git a/genai/provisioned_throughput/noxfile_config.py b/genai/provisioned_throughput/noxfile_config.py
@@ -22,7 +22,7 @@
 
 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.13"],
+    "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,
diff --git a/genai/text_generation/model_optimizer_textgen_with_txt.py b/genai/text_generation/model_optimizer_textgen_with_txt.py
@@ -13,6 +13,8 @@
 # limitations under the License.
 
 
+# TODO: Migrate model_optimizer samples to /model_optimizer
+#       and deprecate following sample
 def generate_content() -> str:
     # [START googlegenaisdk_model_optimizer_textgen_with_txt]
     from google import genai
diff --git a/genai/text_generation/noxfile_config.py b/genai/text_generation/noxfile_config.py
@@ -22,7 +22,7 @@
 
 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.13"],
+    "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,
diff --git a/genai/video_generation/noxfile_config.py b/genai/video_generation/noxfile_config.py
@@ -22,7 +22,7 @@
 
 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.13"],
+    "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,
