Add samples for Files API (#395)

* Add samples for Files API

Change-Id: Ied2df1633e132bda8c144e59107ae11e02b36b2f

* Move sample media to third_party/ directory.

Change-Id: Iee3a0e3d30b7754907c48c11822eac6cadd1082b

* Format.

Change-Id: Ie62a1314ca44074fa1f8904a1d5e3ada2c52fcba

Author: MarkDaoust

google/generativeai/types/file_types.py

@@ -15,14 +15,16 @@
 from __future__ import annotations
 
 import datetime
-from typing import Union
+from typing import Any, Union
 from typing_extensions import TypedDict
 
 from google.rpc.status_pb2 import Status
 from google.generativeai.client import get_default_file_client
 
 from google.generativeai import protos
 
+import pprint
+
 
 class File:
     def __init__(self, proto: protos.File | File | dict):
@@ -33,6 +35,27 @@ def __init__(self, proto: protos.File | File | dict):
     def to_proto(self) -> protos.File:
         return self._proto
 
+    def to_dict(self) -> dict[str, Any]:
+        return type(self._proto).to_dict(self._proto, use_integers_for_enums=False)
+
+    def __str__(self):
+        def sort_key(pair):
+            name, value = pair
+            if name == "name":
+                return ""
+            elif "time" in name:
+                return "zz_" + name
+            else:
+                return name
+
+        dict_format = dict(sorted(self.to_dict().items(), key=sort_key))
+        dict_format = pprint.pformat(dict_format, sort_dicts=False)
+        dict_format = "{\n " + dict_format[1:]
+        dict_format = "\n   ".join(dict_format.splitlines())
+        return dict_format.join(["genai.File(", ")"])
+
+    __repr__ = __str__
+
     @property
     def name(self) -> str:
         return self._proto.name

samples/files.py

@@ -0,0 +1,93 @@
+# -*- 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
+import google.generativeai as genai
+import pathlib
+
+media = pathlib.Path(__file__).parents[1] / "third_party"
+
+
+class UnitTests(absltest.TestCase):
+    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/
+        myfile = genai.upload_file(media / "Big_Buck_Bunny.mp4")
+        print(f"{myfile=}")
+        print()
+
+        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):
+        # [START files_list]
+        print("My files:")
+        for f in genai.list_files():
+            print("  ", f.name)
+        # [END files_list]
+
+    def test_files_delete(self):
+        # [START files_delete]
+        myfile = genai.upload_file(media / "poem.txt")
+
+        myfile.delete()
+
+        try:
+            # Error.
+            model = genai.GenerativeModel("gemini-1.5-flash")
+            result = model.generate_content([myfile, "Describe this file."])
+        except google.api_core.exceptions.PermissionDenied:
+            pass
+        # [END files_delete]
+
+    def test_files_get(self):
+        # [START files_get]
+        myfile = genai.upload_file(media / "poem.txt")
+        file_name = myfile.name
+        print(file_name)  # "files/*"
+
+        myfile = genai.get_file(file_name)
+        print(myfile)
+        # [END files_get]
+
+
+if __name__ == "__main__":
+    absltest.main()

third_party/Big_Buck_Bunny.mp4

@@ -0,0 +1,6 @@
+* poem.txt:
+  * This is the first paragraph from shakespear's spring, no copyright.
+* Big_Buck_Bunny.mp4:
+  * This is a clip from https://peach.blender.org/download/
+  * License CC-BY 3.0 (Attribution)
+

third_party/LICENSE.txt

@@ -0,0 +1,4 @@
+When daisies pied, and violets blue,
+And lady-smocks all silver-white,
+And cuckoo-buds of yellow hue
+Do paint the meadows with delight