Skip to content

Commit c924f19

Browse files
committed
docs(gen_ai): Add Vertex AI Express Mode Sample for Google Gen AI SDK
1 parent b32cde7 commit c924f19

File tree

5 files changed

+124
-0
lines changed

5 files changed

+124
-0
lines changed
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
16+
def generate_content() -> str:
17+
# [START genai_vertexai_express_mode]
18+
from google import genai
19+
20+
# TODO(developer): Update below line
21+
API_KEY = "YOUR_API_KEY"
22+
23+
client = genai.Client(vertexai=True, api_key=API_KEY)
24+
25+
response = client.models.generate_content(
26+
model="gemini-2.0-flash-exp",
27+
contents="""Explain bubble sort to me.""",
28+
)
29+
30+
print(response.text)
31+
# Example response:
32+
# Bubble Sort is a simple sorting algorithm that repeatedly steps through the list
33+
# [END genai_vertexai_express_mode]
34+
return response.text
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# https://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
from unittest.mock import MagicMock, patch
16+
17+
from google.genai import types
18+
import api_key_example
19+
20+
21+
@patch("google.genai.Client")
22+
def test_api_key_example(mock_genai_client: MagicMock) -> None:
23+
# Mock the API response
24+
mock_response = types.GenerateContentResponse._from_response( # pylint: disable=protected-access
25+
response={
26+
"candidates": [
27+
{
28+
"content": {
29+
"parts": [{"text": "This is a mocked bubble sort explanation."}]
30+
}
31+
}
32+
]
33+
},
34+
kwargs={},
35+
)
36+
mock_genai_client.return_value.models.generate_content.return_value = mock_response
37+
38+
response = api_key_example.generate_content()
39+
40+
mock_genai_client.assert_called_once_with(vertexai=True, api_key="YOUR_API_KEY")
41+
mock_genai_client.return_value.models.generate_content.assert_called_once_with(
42+
model="gemini-2.0-flash-exp",
43+
contents="Explain bubble sort to me.",
44+
)
45+
assert response == "This is a mocked bubble sort explanation."
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Copyright 2021 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
# Default TEST_CONFIG_OVERRIDE for python repos.
16+
17+
# You can copy this file into your directory, then it will be imported from
18+
# the noxfile.py.
19+
20+
# The source of truth:
21+
# https://github.com/GoogleCloudPlatform/python-docs-samples/blob/main/noxfile_config.py
22+
23+
TEST_CONFIG_OVERRIDE = {
24+
# You can opt out from the test for specific Python versions.
25+
"ignored_versions": ["2.7", "3.7", "3.8", "3.10", "3.11", "3.13"],
26+
# Old samples are opted out of enforcing Python type hints
27+
# All new samples should feature them
28+
"enforce_type_hints": True,
29+
# An envvar key for determining the project id to use. Change it
30+
# to 'BUILD_SPECIFIC_GCLOUD_PROJECT' if you want to opt in using a
31+
# build specific Cloud project. You can also use your own string
32+
# to use your own Cloud project.
33+
"gcloud_project_env": "GOOGLE_CLOUD_PROJECT",
34+
# 'gcloud_project_env': 'BUILD_SPECIFIC_GCLOUD_PROJECT',
35+
# If you need to use a specific version of pip,
36+
# change pip_version_override to the string representation
37+
# of the version number, for example, "20.2.4"
38+
"pip_version_override": None,
39+
# A dictionary you want to inject into your test. Don't put any
40+
# secrets here. These values will override predefined values.
41+
"envs": {},
42+
}
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
google-api-core==2.24.0
2+
pytest==8.2.0
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
google-genai==0.6.0

0 commit comments

Comments
 (0)