refactor: (GenAI) Improved Context Cache Samples (Group A) (GoogleCloudPlatform#12571)

## Description I have modified the following files: - `create_context_cache.py` - `delete_context_cache.py` - `get_context_cache.py` - `update_context_cache.py` - `use_context_cache.py` ❓However, as a developer and user, I can not find a single file `list_context_cache.py` ❗I have begun developing this file, but I have encountered an issue: the method required for listing context caches is not yet implemented and cannot be used. I have detailed the problem in the attached [document](https://docs.google.com/document/d/1AvNZYbIhrxO414CmPFRbyL24f-3fpncZQOOaaGy-Kcg/edit?usp=sharing). Proposed region_tag: `generativeaionvertexai_gemini_list_context_cache` Could you please review the issue and prioritize the implementation of this method? Having this method available would greatly facilitate the development process. ## Checklist - [x] I have followed [Sample Guidelines from AUTHORING_GUIDE.MD](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md) - [ ] README is updated to include [all relevant information](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#readme-file) - [ ] **Tests** pass: `nox -s py-3.9` (see [Test Environment Setup](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#test-environment-setup)) - [ ] **Lint** pass: `nox -s lint` (see [Test Environment Setup](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/AUTHORING_GUIDE.md#test-environment-setup)) - [ ] These samples need a new **API enabled** in testing projects to pass (let us know which ones) - [ ] These samples need a new/updated **env vars** in testing projects set to pass (let us know which ones) - [ ] This sample adds a new sample directory, and I updated the [CODEOWNERS file](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/.github/CODEOWNERS) with the codeowners for this sample - [ ] This sample adds a new **Product API**, and I updated the [Blunderbuss issue/PR auto-assigner](https://togithub.com/GoogleCloudPlatform/python-docs-samples/blob/main/.github/blunderbuss.yml) with the codeowners for this sample - [ ] Please **merge** this PR for me once it is approved

Author: Thoughtseize1

generative_ai/classify_news_items.py

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# [START aiplatform_sdk_classify_news_items]
-
 
 def classify_news_items() -> str:
  """Text Classification Example with a Large Language Model"""
@@ -59,9 +57,12 @@ def classify_news_items() -> str:
  )
 
  print(response.text)
+ # Example response:
+ # business
  # [END generativeaionvertexai_classification]
 
  return response.text
 
 
-# [END aiplatform_sdk_classify_news_items]
+if __name__ == "__main__":
+ classify_news_items()

generative_ai/context_caching/context_caching_test.py

@@ -29,25 +29,25 @@
 
 @pytest.fixture(scope="module")
 def cache_id() -> Generator[str, None, None]:
- cached_content_name = create_context_cache.create_context_cache(PROJECT_ID)
+ cached_content_name = create_context_cache.create_context_cache()
  yield cached_content_name
- delete_context_cache.delete_context_cache(PROJECT_ID, cached_content_name)
+ delete_context_cache.delete_context_cache(cached_content_name)
 
 
 def test_create_context_cache(cache_id: str) -> None:
  assert cache_id
 
 
 def test_use_context_cache(cache_id: str) -> None:
- response = use_context_cache.use_context_cache(PROJECT_ID, cache_id)
+ response = use_context_cache.use_context_cache(cache_id)
  assert response
 
 
 def test_get_context_cache(cache_id: str) -> None:
- response = get_context_cache.get_context_cache(PROJECT_ID, cache_id)
+ response = get_context_cache.get_context_cache(cache_id)
  assert response
 
 
 def test_update_context_cache(cache_id: str) -> None:
- response = update_context_cache.update_context_cache(PROJECT_ID, cache_id)
+ response = update_context_cache.update_context_cache(cache_id)
  assert response

generative_ai/context_caching/create_context_cache.py

@@ -11,9 +11,12 @@
 # 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 create_context_cache(project_id: str) -> str:
+
+def create_context_cache() -> str:
  # [START generativeaionvertexai_gemini_create_context_cache]
  import vertexai
  import datetime
@@ -22,9 +25,9 @@ def create_context_cache(project_id: str) -> str:
  from vertexai.preview import caching
 
  # TODO(developer): Update and un-comment below line
- # project_id = "PROJECT_ID"
+ # PROJECT_ID = "your-project-id"
 
- vertexai.init(project=project_id, location="us-central1")
+ vertexai.init(project=PROJECT_ID, location="us-central1")
 
  system_instruction = """
  You are an expert researcher. You always stick to the facts in the sources provided, and never make up new facts.
@@ -51,6 +54,12 @@ def create_context_cache(project_id: str) -> str:
  )
 
  print(cached_content.name)
+ # Example response:
+ # 1234567890
  # [END generativeaionvertexai_gemini_create_context_cache]
 
  return cached_content.name
+
+
+if __name__ == "__main__":
+ create_context_cache()

generative_ai/context_caching/delete_context_cache.py

@@ -11,20 +11,27 @@
 # 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_context_cache(project_id: str, cache_id: str) -> None:
+
+def delete_context_cache(cache_id: str) -> None:
  # [START generativeaionvertexai_gemini_delete_context_cache]
  import vertexai
 
  from vertexai.preview import caching
 
  # TODO(developer): Update and un-comment below lines
- # project_id = "PROJECT_ID"
- # cache_id = "CACHE_ID"
+ # PROJECT_ID = "your-project-id"
+ # cache_id = "your-cache-id"
 
- vertexai.init(project=project_id, location="us-central1")
+ vertexai.init(project=PROJECT_ID, location="us-central1")
 
  cached_content = caching.CachedContent(cached_content_name=cache_id)
  cached_content.delete()
  # [END generativeaionvertexai_gemini_delete_context_cache]
+
+
+if __name__ == "__main__":
+ delete_context_cache("1234567890")

generative_ai/context_caching/get_context_cache.py

@@ -11,23 +11,31 @@
 # 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 get_context_cache(project_id: str, cache_id: str) -> str:
+
+def get_context_cache(cache_id: str) -> str:
  # [START generativeaionvertexai_gemini_get_context_cache]
  import vertexai
 
  from vertexai.preview import caching
 
  # TODO(developer): Update and un-comment below lines
- # project_id = "PROJECT_ID"
- # cache_id = "CACHE_ID"
+ # PROJECT_ID = "your-project-id"
+ # cache_id = "your-cache-id"
 
- vertexai.init(project=project_id, location="us-central1")
+ vertexai.init(project=PROJECT_ID, location="us-central1")
 
  cached_content = caching.CachedContent(cached_content_name=cache_id)
 
- print(cached_content.name)
+ print(cached_content.resource_name)
+ # Example response:
+ # projects/[PROJECT_ID]/locations/us-central1/cachedContents/1234567890
  # [END generativeaionvertexai_gemini_get_context_cache]
+ return cached_content.resource_name
+
 
- return cached_content.name
+if __name__ == "__main__":
+ get_context_cache("1234567890")

generative_ai/context_caching/update_context_cache.py

@@ -11,32 +11,36 @@
 # 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 update_context_cache(project_id: str, cache_id: str) -> str:
+def update_context_cache(cache_id: str) -> str:
  # [START generativeaionvertexai_gemini_update_context_cache]
  import vertexai
  import datetime
 
  from vertexai.preview import caching
 
  # TODO(developer): Update and un-comment below lines
- # project_id = "PROJECT_ID"
- # cache_id = "CACHE_ID"
+ # PROJECT_ID = "your-project-id"
+ # cache_id = "your-cache-id"
 
  vertexai.init(project=PROJECT_ID, location="us-central1")
 
  cached_content = caching.CachedContent(cached_content_name=cache_id)
 
- # Update the expiration time by 2 hour
- cached_content.update(ttl=datetime.timedelta(hours=2))
-
+ # Update the expiration time by 1 hour
+ cached_content.update(ttl=datetime.timedelta(hours=1))
  cached_content.refresh()
+
  print(cached_content.expire_time)
+ # Example response:
+ # 2024-09-11 17:16:45.864520+00:00
  # [END generativeaionvertexai_gemini_update_context_cache]
-
  return cached_content.expire_time
+
+
+if __name__ == "__main__":
+ update_context_cache("1234567890")

generative_ai/context_caching/use_context_cache.py

@@ -11,20 +11,23 @@
 # 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 use_context_cache(project_id: str, cache_id: str) -> str:
+
+def use_context_cache(cache_id: str) -> str:
  # [START generativeaionvertexai_gemini_use_context_cache]
  import vertexai
 
  from vertexai.preview.generative_models import GenerativeModel
  from vertexai.preview import caching
 
  # TODO(developer): Update and un-comment below lines
- # project_id = "PROJECT_ID"
- # cache_id = "CACHE_ID"
+ # PROJECT_ID = "your-project-id"
+ # cache_id = "your-cache-id"
 
- vertexai.init(project=project_id, location="us-central1")
+ vertexai.init(project=PROJECT_ID, location="us-central1")
 
  cached_content = caching.CachedContent(cached_content_name=cache_id)
 
@@ -33,6 +36,13 @@ def use_context_cache(project_id: str, cache_id: str) -> str:
  response = model.generate_content("What are the papers about?")
 
  print(response.text)
+ # Example response:
+ # The provided text is about a new family of multimodal models called Gemini, developed by Google.
+ # ...
  # [END generativeaionvertexai_gemini_use_context_cache]
 
  return response.text
+
+
+if __name__ == "__main__":
+ use_context_cache("1234567890")