feat(genai):add new samples for prompt templating (#13007)

* feat(genai):add new samples for prompt templating

* feat(genai):update testing file for prompt templating

* feat(genai):update requirements file / add sample for list prompts

* feat(genai):update testing file / load or retreive sample

* feat(genai):update testing file / adding samples

* feat(genai):update testing file / renaming samples and truncating function names

* feat(genai):update testing file / adding prompt creation for dependencies

* feat(genai):update region tag

* feat(genai):updating noxfile

* feat(genai):updating list_version.py

* feat(genai):update testing file / renaming files / changing function names

* feat(genai):update hint and return

* feat(genai):update hint add export statement

* Triggering a change due to pipeline 500 error on last run

Author: CadillacBurgess1

generative_ai/prompts/prompt_create.py

@@ -0,0 +1,70 @@
+# 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
+
+from vertexai.preview.prompts import Prompt
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def prompt_create() -> Prompt:
+    """Create a local prompt, generates content and saves prompt"""
+
+    # [START generativeaionvertexai_prompt_template_create_generate_save]
+    import vertexai
+    from vertexai.preview import prompts
+    from vertexai.preview.prompts import Prompt
+
+    # from vertexai.generative_models import GenerationConfig, SafetySetting # Optional
+
+    # Initialize vertexai
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Create local Prompt
+    local_prompt = Prompt(
+        prompt_name="movie-critic",
+        prompt_data="Compare the movies {movie1} and {movie2}.",
+        variables=[
+            {"movie1": "The Lion King", "movie2": "Frozen"},
+            {"movie1": "Inception", "movie2": "Interstellar"},
+        ],
+        model_name="gemini-1.5-pro-002",
+        system_instruction="You are a movie critic. Answer in a short sentence.",
+        # generation_config=GenerationConfig, # Optional,
+        # safety_settings=SafetySetting, # Optional,
+    )
+
+    # Generate content using the assembled prompt for each variable set.
+    for i in range(len(local_prompt.variables)):
+        response = local_prompt.generate_content(
+            contents=local_prompt.assemble_contents(**local_prompt.variables[i])
+        )
+        print(response)
+
+    # Save a version
+    prompt1 = prompts.create_version(prompt=local_prompt)
+
+    print(prompt1)
+
+    # Example response
+    # Assembled prompt replacing: 1 instances of variable movie1, 1 instances of variable movie2
+    # Assembled prompt replacing: 1 instances of variable movie1, 1 instances of variable movie2
+    # Created prompt resource with id 12345678910.....
+
+    # [END generativeaionvertexai_prompt_template_create_generate_save]
+    return prompt1
+
+
+if __name__ == "__main__":
+    prompt_create()

generative_ai/prompts/prompt_delete.py

@@ -0,0 +1,56 @@
+# 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
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def delete_prompt() -> None:
+    """Deletes specified prompt."""
+
+    # [START generativeaionvertexai_prompt_delete]
+    import vertexai
+    from vertexai.preview.prompts import Prompt
+    from vertexai.preview import prompts
+
+    # Initialize vertexai
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Create local Prompt
+    prompt = Prompt(
+        prompt_name="movie-critic",
+        prompt_data="Compare the movies {movie1} and {movie2}.",
+        variables=[
+            {"movie1": "The Lion King", "movie2": "Frozen"},
+            {"movie1": "Inception", "movie2": "Interstellar"},
+        ],
+        model_name="gemini-1.5-pro-002",
+        system_instruction="You are a movie critic. Answer in a short sentence.",
+
+    )
+    # Save a version
+    prompt1 = prompts.create_version(prompt=prompt)
+    prompt_id = prompt1.prompt_id
+
+    # Delete prompt
+    prompts.delete(prompt_id=prompt_id)
+    print(f"Deleted prompt with ID: {prompt_id}")
+
+    # Example response:
+    # Deleted prompt resource with id 12345678910
+    # [END generativeaionvertexai_prompt_delete]
+
+
+if __name__ == "__main__":
+    delete_prompt()

generative_ai/prompts/prompt_get.py

@@ -0,0 +1,56 @@
+# 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
+
+from vertexai.preview.prompts import Prompt
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def get_prompt() -> Prompt:
+    """Retrieves a prompt that has been saved to the online resource"""
+
+    # [START generativeaionvertexai_prompt_template_load_or_retrieve_prompt]
+    import vertexai
+    from vertexai.preview.prompts import Prompt
+    from vertexai.preview import prompts
+
+    # Initialize vertexai
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Create local Prompt
+    prompt = Prompt(
+        prompt_name="meteorologist",
+        prompt_data="How should I dress for weather in August?",
+        model_name="gemini-1.5-pro-002",
+        system_instruction="You are a meteorologist. Answer in a short sentence.",
+
+    )
+    # Save Prompt to online resource.
+    prompt1 = prompts.create_version(prompt=prompt)
+    prompt_id = prompt1.prompt_id
+
+    # Get prompt
+    get_prompt = prompts.get(prompt_id=prompt_id)
+
+    print(get_prompt)
+
+    # Example response
+    # How should I dress for weather in August?
+    # [END generativeaionvertexai_prompt_template_load_or_retrieve_prompt]
+    return get_prompt
+
+
+if __name__ == "__main__":
+    get_prompt()

generative_ai/prompts/prompt_list_prompts.py

@@ -0,0 +1,41 @@
+# 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
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def list_prompt() -> list:
+    """Lists the all prompts saved in the current Google Cloud Project"""
+
+    # [START generativeaionvertexai_prompt_template_list_prompt]
+    import vertexai
+    from vertexai.preview import prompts
+
+    # Initialize vertexai
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Get prompt a prompt from list
+    list_prompts_metadata = prompts.list()
+
+    print(list_prompts_metadata)
+
+    # Example Response:
+    # [PromptMetadata(display_name='movie-critic', prompt_id='12345678910'), PromptMetadata(display_name='movie-critic-2', prompt_id='12345678910'
+    # [END generativeaionvertexai_prompt_template_list_prompt]
+    return list_prompts_metadata
+
+
+if __name__ == "__main__":
+    list_prompt()

generative_ai/prompts/prompt_list_version.py

@@ -0,0 +1,59 @@
+# 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
+
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def list_prompt_version() -> list:
+    """Displays a specific prompt version from the versions metadata list."""
+
+    # [START generativeaionvertexai_prompt_list_prompt_version]
+    import vertexai
+    from vertexai.preview.prompts import Prompt
+    from vertexai.preview import prompts
+
+    # Initialize vertexai
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Create local Prompt
+    prompt = Prompt(
+        prompt_name="zoologist",
+        prompt_data="Which animal is the fastest on earth?",
+        model_name="gemini-1.5-pro-002",
+        system_instruction="You are a zoologist. Answer in a short sentence.",
+    )
+    # Save Prompt to online resource.
+    prompt1 = prompts.create_version(prompt=prompt)
+    prompt_id = prompt1.prompt_id
+
+    # Get prompt a prompt from list
+    prompt_versions_metadata = prompts.list_versions(prompt_id=prompt_id)
+
+    # Get a specific prompt version from the versions metadata list
+    prompt1 = prompts.get(
+        prompt_id=prompt_versions_metadata[0].prompt_id,
+        version_id=prompt_versions_metadata[0].version_id,
+    )
+
+    print(prompt1)
+    # Example response:
+    # Which animal is the fastest on earth?
+    # [END generativeaionvertexai_prompt_list_prompt_version]
+    return prompt_versions_metadata
+
+
+if __name__ == "__main__":
+    list_prompt_version()

generative_ai/prompts/prompt_restore_version.py

@@ -0,0 +1,55 @@
+# 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
+
+from vertexai.preview.prompts import Prompt
+
+PROJECT_ID = os.getenv("GOOGLE_CLOUD_PROJECT")
+
+
+def restore_prompt_version() -> Prompt:
+    """Restores specified version for specified prompt."""
+
+    # [START generativeaionvertexai_prompt_restore_version]
+    import vertexai
+    from vertexai.preview import prompts
+
+    # Initialize vertexai
+    vertexai.init(project=PROJECT_ID, location="us-central1")
+
+    # Create local Prompt
+    prompt = Prompt(
+        prompt_name="zoologist",
+        prompt_data="Which animal is the fastest on earth?",
+        model_name="gemini-1.5-pro-002",
+        system_instruction="You are a zoologist. Answer in a short sentence.",
+    )
+    # Save Prompt to online resource.
+    prompt1 = prompts.create_version(prompt=prompt)
+    prompt_id = prompt1.prompt_id
+
+    # Restore to prompt version id 1 (original)
+    prompt_version_metadata = prompts.restore_version(prompt_id=prompt_id, version_id="1")
+
+    # Fetch the newly restored latest version of the prompt
+    prompt1 = prompts.get(prompt_id=prompt_version_metadata.prompt_id)
+
+    # Example response:
+    # Restored prompt version 1 under prompt id 12345678910 as version number 2
+    # [END generativeaionvertexai_prompt_restore_version]
+    return prompt1
+
+
+if __name__ == "__main__":
+    restore_prompt_version()

generative_ai/prompts/requirements.txt

@@ -3,7 +3,7 @@ pandas==2.0.3; python_version == '3.8'
 pandas==2.1.4; python_version > '3.8'
 pillow==10.3.0; python_version < '3.8'
 pillow==10.3.0; python_version >= '3.8'
-google-cloud-aiplatform[all]==1.69.0
+google-cloud-aiplatform[all]==1.74.0
 sentencepiece==0.2.0
 google-auth==2.29.0
 anthropic[vertex]==0.28.0

generative_ai/prompts/test_prompt_template.py

@@ -12,9 +12,45 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import prompt_create
+import prompt_delete
+import prompt_get
+import prompt_list_prompts
+import prompt_list_version
+import prompt_restore_version
 import prompt_template
 
 
 def test_prompt_template() -> None:
     text = prompt_template.prompt_template_example()
     assert len(text) > 2
+
+
+def test_prompt_create() -> None:
+    response = prompt_create.prompt_create()
+    assert response
+
+
+def test_prompt_list_prompts() -> None:
+    list_prompts = prompt_list_prompts.list_prompt()
+    assert list_prompts
+
+
+def test_prompt_get() -> None:
+    get_prompt = prompt_get.get_prompt()
+    assert get_prompt
+
+
+def test_prompt_list_version() -> None:
+    list_versions = prompt_list_version.list_prompt_version()
+    assert list_versions
+
+
+def test_prompt_delete() -> None:
+    delete_prompt = prompt_delete.delete_prompt()
+    assert delete_prompt is None
+
+
+def test_prompt_restore_version() -> None:
+    prompt1 = prompt_restore_version.restore_prompt_version()
+    assert prompt1