Caching samples (#399)

* Add samples for caching

* Add samples for caching functions

* Update importing for json and embeddings

* Add updates to each sample file

* Resolve caching comments.

Change-Id: I4b7eac67b6e5999b0d256c47f05dd4c112eae45e

* format

Change-Id: I54437b359a2bd75972376423fd30361f39e799ce

---------

Co-authored-by: Mark Daoust <[email protected]>

Author: shilpakancharla

samples/cache.py

@@ -0,0 +1,101 @@
+# -*- coding: utf-8 -*-
+# Copyright 2023 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.
+from absl.testing import absltest
+
+import google.generativeai as genai
+
+import pathlib
+
+media = pathlib.Path(__file__).parents[1] / "third_party"
+
+
+class UnitTests(absltest.TestCase):
+    def test_cache_create(self):
+        # [START cache_create]
+        document = genai.upload_file(path=media / "a11.txt")
+        model_name = "gemini-1.5-flash-001"
+        cache = genai.caching.CachedContent.create(
+            model=model_name,
+            system_instruction="You are an expert analyzing transcripts.",
+            contents=[document],
+        )
+        print(cache)
+        # [END cache_create]
+        cache.delete()
+
+    def test_cache_delete(self):
+        # [START cache_delete]
+        document = genai.upload_file(path=media / "a11.txt")
+        model_name = "gemini-1.5-flash-001"
+        cache = genai.caching.CachedContent.create(
+            model=model_name,
+            system_instruction="You are an expert analyzing transcripts.",
+            contents=[document],
+        )
+        cache.delete()
+        # [END cache_delete]
+
+    def test_cache_get(self):
+        # [START cache_get]
+        document = genai.upload_file(path=media / "a11.txt")
+        model_name = "gemini-1.5-flash-001"
+        cache = genai.caching.CachedContent.create(
+            model=model_name,
+            system_instruction="You are an expert analyzing transcripts.",
+            contents=[document],
+        )
+        print(genai.caching.CachedContent.get(name=cache.name))
+        # [END cache_get]
+        cache.delete()
+
+    def test_cache_list(self):
+        # [START cache_list]
+        document = genai.upload_file(path=media / "a11.txt")
+        model_name = "gemini-1.5-flash-001"
+        cache = genai.caching.CachedContent.create(
+            model=model_name,
+            system_instruction="You are an expert analyzing transcripts.",
+            contents=[document],
+        )
+        print("My caches:")
+        for c in genai.caching.CachedContent.list():
+            print("    ", c.name)
+        # [END cache_list]
+        cache.delete()
+
+    def test_cache_update(self):
+        # [START cache_update]
+        import datetime
+
+        document = genai.upload_file(path=media / "a11.txt")
+        model_name = "gemini-1.5-flash-001"
+        cache = genai.caching.CachedContent.create(
+            model=model_name,
+            system_instruction="You are an expert analyzing transcripts.",
+            contents=[document],
+        )
+
+        # You can update the ttl
+        cache.update(ttl=datetime.timedelta(hours=2))
+        print(f"After update:\n {cache}")
+
+        # Or you can update the expire_time
+        cache.update(expire_time=datetime.now() + datetime.timedelta(minutes=15))
+        # [END cache_update]
+        cache.delete()
+
+
+if __name__ == "__main__":
+    absltest.main()

samples/embed.py

@@ -27,7 +27,6 @@ def test_embed_content(self):
             model="models/text-embedding-004", content=text, output_dimensionality=10
         )
         print(result["embedding"])
-        print()
         # [END embed_content]
 
     def batch_embed_content(self):
@@ -41,7 +40,6 @@ def batch_embed_content(self):
             model="models/text-embedding-004", content=texts, output_dimensionality=10
         )
         print(result)
-        print()
         # [END batch_embed_content]
 
 

samples/files.py

@@ -26,35 +26,31 @@ def test_files_create(self):
         # [START files_create]
         myfile = genai.upload_file(media / "poem.txt")
         print(f"{myfile=}")
-        print()
 
         model = genai.GenerativeModel("gemini-1.5-flash")
         result = model.generate_content(
             [myfile, "\n\n", "Can you add a few more lines to this poem?"]
         )
         print(f"{result.text=}")
-        print()
         # [END files_create]
 
     def test_files_create_video(self):
         # [START files_create_video]
         import time
 
-        # Video clip from https://peach.blender.org/download/
+        # Video clip (CC BY 3.0) from https://peach.blender.org/download/
         myfile = genai.upload_file(media / "Big_Buck_Bunny.mp4")
         print(f"{myfile=}")
-        print()
 
+        # Videos need to be processed before you can use them.
         while myfile.state.name == "PROCESSING":
             print("processing video...")
             time.sleep(5)
             myfile = genai.get_file(myfile.name)
 
         model = genai.GenerativeModel("gemini-1.5-flash")
         result = model.generate_content([myfile, "Describe this video clip"])
-        print()
         print(f"{result.text=}")
-        print()
         # [END files_create_video]
 
     def test_files_list(self):

samples/json_mode.py

@@ -13,12 +13,13 @@
 from absl.testing import absltest
 
 import google.generativeai as genai
-import typing_extensions as typing
 
 
 class UnitTests(absltest.TestCase):
     def test_controlled_generation(self):
         # [START controlled_generation]
+        import typing_extensions as typing
+
         class Recipe(typing.TypedDict):
             recipe_name: str
 
@@ -30,7 +31,6 @@ class Recipe(typing.TypedDict):
             ),
         )
         print(result)
-        print()
         # [END controlled_generation]
 
 

third_party/LICENSE.txt

@@ -1,6 +1,8 @@
-* poem.txt:
-  * This is the first paragraph from shakespear's spring, no copyright.
+* a11.txt
+  * This is an apollo 11 transcript.
+  * This file is in the public domain in the United States because it was solely created by NASA
 * Big_Buck_Bunny.mp4:
   * This is a clip from https://peach.blender.org/download/
   * License CC-BY 3.0 (Attribution)
-
+* poem.txt:
+  * This is the first paragraph from Shakespeare's "spring", public domain.