feat: GenAI SDK client - Update client.prompts.create_version to create a prompt and prompt version for a prompt. Recommend create_version instead of create

PiperOrigin-RevId: 889955089

Author: sararob

tests/unit/vertexai/genai/replays/test_create_prompt.py

@@ -75,6 +75,7 @@
 )
 TEST_CREATE_PROMPT_CONFIG = types.CreatePromptConfig(
     prompt_display_name="my_prompt",
+    version_display_name="my_version",
 )
 
 TEST_CREATE_PROMPT_VERSION_CONFIG = types.CreatePromptVersionConfig(
@@ -147,8 +148,18 @@ def test_create(client):
     assert isinstance(prompt_resource.dataset, types.Dataset)
 
 
+def test_create_version(client):
+    prompt_resource = client.prompts.create_version(
+        prompt=TEST_PROMPT,
+        config=TEST_CREATE_PROMPT_CONFIG,
+    )
+    assert isinstance(prompt_resource, types.Prompt)
+    assert isinstance(prompt_resource.dataset, types.Dataset)
+    assert isinstance(prompt_resource.dataset_version, types.DatasetVersion)
+
+
 def test_create_e2e(client):
-    prompt_resource = client.prompts.create(
+    prompt_resource = client.prompts.create_version(
         prompt=TEST_PROMPT,
         config=TEST_CREATE_PROMPT_CONFIG,
     )
@@ -183,13 +194,13 @@ def test_create_e2e(client):
         == prompt_resource.prompt_data.generation_config
     )
 
-    # Test calling create_version on the same prompt dataset and change the prompt
+    # Test creating a new version on the same prompt dataset with update()
     new_prompt = TEST_PROMPT.model_copy(deep=True)
     new_prompt.prompt_data.contents[0].parts[0].text = "Is this Alice?"
-    prompt_resource_2 = client.prompts.create_version(
+    prompt_resource_2 = client.prompts.update(
         prompt_id=prompt_resource.prompt_id,
         prompt=new_prompt,
-        config=types.CreatePromptVersionConfig(
+        config=types.UpdatePromptConfig(
             version_display_name="my_version",
         ),
     )
@@ -199,37 +210,17 @@ def test_create_e2e(client):
     # Update the prompt contents again and verify version history is preserved
     prompt_v3 = TEST_PROMPT.model_copy(deep=True)
     prompt_v3.prompt_data.contents[0].parts[0].text = "Is this Bob?"
-    prompt_resource_3 = client.prompts.create_version(
+    prompt_resource_3 = client.prompts.update(
         prompt_id=prompt_resource.prompt_id,
         prompt=prompt_v3,
-        config=types.CreatePromptVersionConfig(
+        config=types.UpdatePromptConfig(
             version_display_name="my_version_2",
         ),
     )
     assert prompt_resource_3.dataset.name == prompt_resource.dataset.name
     assert prompt_resource_3.prompt_data.contents[0].parts[0].text == "Is this Bob?"
 
 
-def test_create_version(client):
-    updated_prompt = TEST_PROMPT.model_copy(deep=True)
-    new_prompt_text = "Is this {name}?"
-    updated_prompt.prompt_data.contents[0].parts[0].text = new_prompt_text
-    prompt_resource = client.prompts.create_version(
-        prompt_id=TEST_PROMPT_DATASET_ID,
-        prompt=updated_prompt,
-        config=TEST_CREATE_PROMPT_VERSION_CONFIG,
-    )
-    assert isinstance(prompt_resource, types.Prompt)
-    assert isinstance(prompt_resource.dataset, types.Dataset)
-    assert isinstance(prompt_resource.dataset_version, types.DatasetVersion)
-    assert prompt_resource.dataset.name.endswith(TEST_PROMPT_DATASET_ID)
-    assert (
-        prompt_resource.dataset_version.display_name
-        == TEST_CREATE_PROMPT_VERSION_CONFIG.version_display_name
-    )
-    assert prompt_resource.prompt_data.contents[0].parts[0].text == new_prompt_text
-
-
 def test_create_with_file_data(client):
     audio_file_part = genai_types.Part(
         file_data=genai_types.FileData(
@@ -291,32 +282,20 @@ def test_create_with_file_data(client):
 
 def test_create_with_encryption_spec(client):
     encryption_spec = genai_types.EncryptionSpec(
-        kms_key_name="projects/vertex-sdk-dev/locations/us-central1/keyRings/my-key-ring/cryptoKeys/my-key",
+        kms_key_name="projects/vertex-sdk-dev/locations/us-central1/keyRings/test-key-ring/cryptoKeys/my-key",
     )
-    config = types.CreatePromptConfig(
+    config = types.CreatePromptVersionConfig(
         prompt_display_name="my_prompt_with_encryption_spec",
+        version_display_name="my_version_with_encryption_spec",
         encryption_spec=encryption_spec,
     )
-    prompt_resource = client.prompts.create(
+    prompt_resource = client.prompts.create_version(
         prompt=TEST_PROMPT,
         config=config,
     )
     assert isinstance(prompt_resource, types.Prompt)
     assert isinstance(prompt_resource.dataset, types.Dataset)
-
-    # Create a version on a prompt with an encryption spec.
-    new_prompt = TEST_PROMPT.model_copy(deep=True)
-    new_prompt.prompt_data.contents[0].parts[0].text = "Is this Alice?"
-    prompt_version_resource = client.prompts.create_version(
-        prompt_id=prompt_resource.prompt_id,
-        prompt=new_prompt,
-        config=types.CreatePromptVersionConfig(
-            version_display_name="my_version_existing_dataset",
-        ),
-    )
-    assert isinstance(prompt_version_resource, types.Prompt)
-    assert isinstance(prompt_version_resource.dataset, types.Dataset)
-    assert isinstance(prompt_version_resource.dataset_version, types.DatasetVersion)
+    assert isinstance(prompt_resource.dataset_version, types.DatasetVersion)
 
 
 pytestmark = pytest_helper.setup(
@@ -340,24 +319,10 @@ async def test_create_async(client):
 
 @pytest.mark.asyncio
 async def test_create_version_async(client):
-    prompt_resource = await client.aio.prompts.create(
-        prompt=TEST_PROMPT.model_dump(),
-        config=TEST_CREATE_PROMPT_CONFIG.model_dump(),
-    )
-    new_prompt = TEST_PROMPT.model_copy(deep=True)
-    new_prompt.prompt_data.contents[0].parts[0].text = "Is this Alice?"
-    prompt_version_resource = await client.aio.prompts.create_version(
-        prompt_id=prompt_resource.prompt_id,
-        prompt=new_prompt,
-        config=types.CreatePromptVersionConfig(
-            version_display_name="my_version_existing_dataset",
-        ),
-    )
-    assert isinstance(prompt_version_resource, types.Prompt)
-    assert isinstance(prompt_version_resource.dataset, types.Dataset)
-    assert isinstance(prompt_version_resource.dataset_version, types.DatasetVersion)
-    assert prompt_version_resource.dataset.name.endswith(prompt_resource.prompt_id)
-    assert (
-        prompt_version_resource.prompt_data.contents[0].parts[0].text
-        == "Is this Alice?"
+    prompt_resource = await client.aio.prompts.create_version(
+        prompt=TEST_PROMPT,
+        config=TEST_CREATE_PROMPT_CONFIG,
     )
+    assert isinstance(prompt_resource, types.Prompt)
+    assert isinstance(prompt_resource.dataset, types.Dataset)
+    assert isinstance(prompt_resource.dataset_version, types.DatasetVersion)

tests/unit/vertexai/genai/replays/test_delete_prompt.py

@@ -70,7 +70,7 @@ async def test_delete_dataset_async(client, caplog):
 @pytest.mark.asyncio
 async def test_delete_version_async(client, caplog):
     caplog.set_level(logging.INFO)
-    prompt = client.prompts.create(
+    prompt_version = client.prompts.create_version(
         prompt=types.Prompt(
             prompt_data=types.PromptData(
                 model="gemini-2.5-flash",
@@ -83,18 +83,12 @@ async def test_delete_version_async(client, caplog):
         ),
         config=types.CreatePromptConfig(
             prompt_display_name="test_delete_prompt_dataset",
-        ),
-    )
-    prompt_version = client.prompts.create_version(
-        prompt_id=prompt.prompt_id,
-        prompt=prompt,
-        config=types.CreatePromptVersionConfig(
             version_display_name="test_delete_prompt_dataset_version",
         ),
     )
     version_id = prompt_version.dataset_version.name.split("/")[-1]
     await client.aio.prompts.delete_version(
-        prompt_id=prompt.prompt_id,
+        prompt_id=prompt_version.prompt_id,
         version_id=version_id,
     )
     assert "Deleted prompt version" in caplog.text

tests/unit/vertexai/genai/replays/test_restore_prompt_version.py

@@ -30,21 +30,21 @@
 
 
 def test_restore_version(client):
-    my_prompt = client.prompts.create(
-        prompt=test_create_prompt.TEST_PROMPT.model_dump(),
-        config=test_create_prompt.TEST_CREATE_PROMPT_CONFIG,
-    )
-
     # Create 2 versions on my_prompt
     prompt_v1 = client.prompts.create_version(
-        prompt_id=my_prompt.prompt_id,
         prompt=test_create_prompt.TEST_PROMPT.model_copy(deep=True),
-        config=types.CreatePromptVersionConfig(version_display_name="my_prompt_v1"),
+        config=types.CreatePromptVersionConfig(
+            prompt_display_name="my_prompt",
+            version_display_name="my_prompt_v1",
+        ),
     )
-    prompt_v2 = client.prompts.create_version(
-        prompt_id=my_prompt.prompt_id,
+    prompt_v2 = client.prompts.update(
+        prompt_id=prompt_v1.prompt_id,
         prompt=prompt_contents_2,
-        config=types.CreatePromptVersionConfig(version_display_name="my_prompt_v2"),
+        config=types.CreatePromptVersionConfig(
+            prompt_display_name="my_prompt",
+            version_display_name="my_prompt_v2",
+        ),
     )
     my_prompt_v1_id = prompt_v1.dataset_version.name.split("/")[-1]
     my_prompt_v2_id = prompt_v2.dataset_version.name.split("/")[-1]
@@ -58,7 +58,7 @@ def test_restore_version(client):
 
     # Restore version to my_prompt_v1_id
     restored_prompt = client.prompts.restore_version(
-        prompt_id=my_prompt.prompt_id,
+        prompt_id=prompt_v1.prompt_id,
         version_id=my_prompt_v1_id,
     )
     assert restored_prompt.dataset_version.name.split("/")[-1] == my_prompt_v1_id
@@ -80,29 +80,27 @@ def test_restore_version(client):
 
 @pytest.mark.asyncio
 async def test_restore_version_async(client):
-    my_prompt = await client.aio.prompts.create(
-        prompt=test_create_prompt.TEST_PROMPT.model_dump(),
-        config=test_create_prompt.TEST_CREATE_PROMPT_CONFIG,
-    )
-
     # Create 2 versions on my_prompt
     prompt_v1 = client.prompts.create_version(
-        prompt_id=my_prompt.prompt_id,
         prompt=test_create_prompt.TEST_PROMPT.model_copy(deep=True),
-        config=types.CreatePromptVersionConfig(version_display_name="my_prompt_v1"),
+        config=types.CreatePromptVersionConfig(
+            prompt_display_name="my_prompt", version_display_name="my_prompt_v1"
+        ),
     )
-    prompt_v2 = client.prompts.create_version(
-        prompt_id=my_prompt.prompt_id,
+    prompt_v2 = client.prompts.update(
+        prompt_id=prompt_v1.prompt_id,
         prompt=prompt_contents_2,
-        config=types.CreatePromptVersionConfig(version_display_name="my_prompt_v2"),
+        config=types.CreatePromptVersionConfig(
+            prompt_display_name="my_prompt", version_display_name="my_prompt_v2"
+        ),
     )
     my_prompt_v1_id = prompt_v1.dataset_version.name.split("/")[-1]
     my_prompt_v2_id = prompt_v2.dataset_version.name.split("/")[-1]
     assert my_prompt_v2_id != my_prompt_v1_id
 
     # Restore version to my_prompt_v1_id
     restored_prompt = await client.aio.prompts.restore_version(
-        prompt_id=my_prompt.prompt_id,
+        prompt_id=prompt_v1.prompt_id,
         version_id=my_prompt_v1_id,
     )
     assert restored_prompt.dataset_version.name.split("/")[-1] == my_prompt_v1_id

tests/unit/vertexai/genai/replays/test_update_prompt.py

@@ -0,0 +1,126 @@
+# 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
+#
+#     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.
+#
+# pylint: disable=protected-access,bad-continuation,missing-function-docstring
+
+from tests.unit.vertexai.genai.replays import pytest_helper
+from vertexai._genai import types
+from google.genai import types as genai_types
+import pytest
+
+
+TEST_PROMPT_DATASET_ID = "8005484238453342208"
+TEST_VARIABLES = [
+    {"name": genai_types.Part(text="Alice")},
+    {"name": genai_types.Part(text="Bob")},
+]
+TEST_RESPONSE_SCHEMA = {
+    "type": "object",
+    "properties": {"response": {"type": "string"}},
+}
+TEST_PROMPT = types.Prompt(
+    prompt_data=types.PromptData(
+        contents=[
+            genai_types.Content(
+                role="user",
+                parts=[genai_types.Part(text="Hello, {name}! How are you?")],
+            )
+        ],
+        safety_settings=[
+            genai_types.SafetySetting(
+                category="HARM_CATEGORY_DANGEROUS_CONTENT",
+                threshold="BLOCK_MEDIUM_AND_ABOVE",
+                method="SEVERITY",
+            ),
+        ],
+        generation_config=genai_types.GenerationConfig(
+            temperature=0.1,
+            candidate_count=1,
+            top_p=0.95,
+            top_k=40,
+            response_modalities=["TEXT"],
+            response_schema=TEST_RESPONSE_SCHEMA,
+        ),
+        system_instruction=genai_types.Content(
+            parts=[genai_types.Part(text="Please answer in a short sentence.")]
+        ),
+        tools=[
+            genai_types.Tool(
+                google_search_retrieval=genai_types.GoogleSearchRetrieval(
+                    dynamic_retrieval_config=genai_types.DynamicRetrievalConfig(
+                        mode="MODE_DYNAMIC"
+                    )
+                )
+            ),
+        ],
+        tool_config=genai_types.ToolConfig(
+            retrieval_config=genai_types.RetrievalConfig(
+                lat_lng=genai_types.LatLng(latitude=37.7749, longitude=-122.4194)
+            )
+        ),
+        model="gemini-2.0-flash-001",
+        variables=TEST_VARIABLES,
+    ),
+)
+TEST_CREATE_PROMPT_CONFIG = types.CreatePromptConfig(
+    prompt_display_name="my_prompt",
+)
+
+TEST_CREATE_PROMPT_VERSION_CONFIG = types.CreatePromptVersionConfig(
+    version_display_name="my_version",
+)
+
+
+def test_update_creates_new_version(client):
+    updated_prompt = TEST_PROMPT.model_copy(deep=True)
+    updated_prompt.prompt_data.contents[0].parts[0].text = "Is this Alice?"
+
+    prompt_resource = client.prompts.update(
+        prompt_id=TEST_PROMPT_DATASET_ID,
+        prompt=updated_prompt,
+        config=types.UpdatePromptConfig(
+            version_display_name="my_version",
+        ),
+    )
+    assert isinstance(prompt_resource, types.Prompt)
+    assert isinstance(prompt_resource.dataset, types.Dataset)
+    assert isinstance(prompt_resource.dataset_version, types.DatasetVersion)
+    assert prompt_resource.prompt_data.contents[0].parts[0].text == "Is this Alice?"
+
+
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method="prompts.update",
+)
+
+pytest_plugins = ("pytest_asyncio",)
+
+
+@pytest.mark.asyncio
+async def test_update_async(client):
+    updated_prompt = TEST_PROMPT.model_copy(deep=True)
+    updated_prompt.prompt_data.contents[0].parts[0].text = "Is this Alice?"
+
+    prompt_resource = await client.aio.prompts.update(
+        prompt_id=TEST_PROMPT_DATASET_ID,
+        prompt=updated_prompt,
+        config=types.UpdatePromptConfig(
+            version_display_name="my_updated_version",
+        ),
+    )
+    assert isinstance(prompt_resource, types.Prompt)
+    assert isinstance(prompt_resource.dataset, types.Dataset)
+    assert isinstance(prompt_resource.dataset_version, types.DatasetVersion)
+    assert prompt_resource.prompt_data.contents[0].parts[0].text == "Is this Alice?"