Merge branch 'main' of https://github.com/dsdanielpark/Gemini-API

Author: dsdanielpark

README.md

@@ -6,10 +6,13 @@
 
 
 
-A *unofficial* Python wrapper, [python-gemini-api](https://pypi.org/project/python-gemini-api/), operates through reverse-engineering, utilizing cookie values to interact with [Google Gemini](https://gemini.google.com) for users struggling with frequent authentication problems or unable to authenticate via [Google Authentication](https://developers.google.com/identity/protocols/oauth2?hl=en).
+A *unofficial* Python wrapper, [python-gemini-api](https://pypi.org/project/python-gemini-api/), operates through reverse-engineering, utilizing cookie values to interact with [Google Gemini](https://gemini.google.com) for users struggling with frequent authentication problems or unable to authenticate via [Google Authentication](https://developers.google.com/identity/protocols/oauth2?hl=en). This repository is not expected to be updated frequently, and it will be modified for personal use. 
 
 Collaborated competently with [Antonio Cheong](https://github.com/acheong08).
 
+Please, check <img src="https://www.gstatic.com/lamda/images/favicon_v1_150160cddff7f294ce30.svg" width="15px" alt="Gemini Icon" />[HanaokaYuzu/Gemini-API](https://github.com/HanaokaYuzu/Gemini-API) first. 
+
+
 <br>
 
 ## What is [Gemini](https://deepmind.google/technologies/gemini/#introduction)?
@@ -102,7 +105,7 @@ GeminiClient = Gemini(cookies=cookies)
 
 <br>
 
-### # 02. Generate Content
+### # 02. Generate content
 To check regardless of the data type of the model output, return the response_dict argument. And use it appropriately.
 
 ```python
@@ -143,10 +146,9 @@ print(response.text)
 
 ### # 04. Image generation
 Returns images generated by Gemini.
-> [!NOTE]
-> Use GeminiImage for image processing. `web_images` works without cookies, but for images like `generated_image` from Gemini, pass cookies. Cookies are needed to download images from Google's storage. Check the response or use existing cookies variable.
 
-*Sync*
+
+*Sync downloader*
 ```python
 from gemini import Gemini, GeminiImage
 
@@ -176,7 +178,7 @@ GeminiImage.save_sync(generated_images, save_path="save_dir", cookies=cookies)
 </details>
 
 
-*Async*
+*Async downloader*
 
 ```python
 response = GeminiClient.generate_content("Create illustrations of Seoul, South Korea.")
@@ -188,22 +190,21 @@ await GeminiImage.save(generated_images, "save_dir", cookies=cookies)
 # await GeminiImage.save_images(image_data_dict, "save_dir")
 ```
 
-<details><summary>Async wrapper</summary>
+
+<details><summary>Async downloader wrapper</summary>
 
 ```
 import asyncio
 from gemini import Gemini, GeminiImage
 
-async def fetch_and_save_images_async(prompt: str, save_path: str="save_dir", cookies=cookies):
-    response = await GeminiClient.generate_content_async(prompt)
-
-    generated_images = response.generated_images  # Check response images [Dict]
-    await GeminiImage.save(generated_images, save_path=save_path, cookies=cookies)
+async def save_generated_imagse(generated_imagse, save_path="save_dir", cookies=cookies):
+    await GeminiImage.save(generated_imagse, save_path=save_path, cookies=cookies)
 
 # Run the async function
 if __name__ == "__main__":
-    user_prompt = input("Enter your prompt: ")
-    asyncio.run(fetch_and_save_images_async(user_prompt))
+    cookies = {"key" : "value"}
+    generated_imagse = response.generated_imagse  
+    asyncio.run(save_generated_imagse(generated_imagse, save_path="save_dir", cookies=cookies))
 ```
 
 `GeminiImage.save` method logic
@@ -212,28 +213,28 @@ if __name__ == "__main__":
 import asyncio
 from gemini import Gemini, GeminiImage
 
-async def fetch_and_save_images_async(prompt: str, save_path: str="save_dir", cookies):
-    response = await GeminiClient.generate_content_async(prompt)
-
-    generated_images = response.generated_images  # Check response images [Dict]
-    image_data_dict = await GeminiImage.fetch_images_dict(generated_images, cookies=cookies)  # Get bytes images dict asynchronously
-    await GeminiImage.save_images(image_data_dict, save_path=save_path)  # Save to path asynchronously
+async def save_generated_imagse(generated_imagse, save_path="save_dir", cookies=cookies):
+    image_data_dict = await GeminiImage.fetch_images_dict(generated_imagse, cookies=cookies)  # Get bytes images dict asynchronously
+    await GeminiImage.save_images(image_data_dict, save_path=save_path)  
 
 # Run the async function
 if __name__ == "__main__":
-    user_prompt = input("Enter your prompt: ")
-    asyncio.run(fetch_and_save_images_async(user_prompt))
+    cookies = {"key" : "value"}
+    generated_imagse = response.generated_imagse  # Check response images [Dict]
+    asyncio.run(save_generated_imagse(generated_imagse, save_path="save_dir", cookies=cookies))
 ```
 
 </details>
 
+> [!NOTE]
+> Use GeminiImage for image processing. `web_images` works without cookies, but for images like `generated_image` from Gemini, pass cookies. Cookies are needed to download images from Google's storage. Check the response or use existing cookies variable.
 
 <br>
 
 ### # 05. Retrieving Images from Gemini Responses
 Returns images in response of Gemini.
 
-*Sync*
+*Sync downloader*
 ```python
 from gemini import Gemini, GeminiImage
 
@@ -246,7 +247,7 @@ GeminiImage.save_sync(response_images, save_path="save_dir")
 # bytes_images_dict = GeminiImage.fetch_bytes_sync(response_images, cookies) # Get bytes images dict
 # GeminiImage.save_images_sync(bytes_images_dict, path="save_dir") # Save to path
 ```
-*Async*
+*Async downloader*
 ```python
 response = GeminiClient.generate_content("Create illustrations of Seoul, South Korea.")
 
@@ -257,22 +258,20 @@ await GeminiImage.save(response_images, "save_dir")
 # await GeminiImage.save_images(image_data_dict, "save_dir")
 ```
 
-<details><summary>Async wrapper</summary>
+<details><summary>Async downloader wrapper</summary>
 
 ```
 import asyncio
 from gemini import Gemini, GeminiImage
 
-async def fetch_and_save_images_async(prompt: str, save_path: str="save_dirs", cookies=cookies):
-    response = await GeminiClient.generate_content_async(prompt)
-
-    response_images = response.web_images  # Check response images [Dict]
+async def save_response_web_imagse(response_images, save_path="save_dir", cookies=cookies):
     await GeminiImage.save(response_images, save_path=save_path, cookies=cookies)
 
 # Run the async function
 if __name__ == "__main__":
-    user_prompt = input("Enter your prompt: ")
-    asyncio.run(fetch_and_save_images_async(user_prompt))
+    cookies = {"key" : "value"}
+    response_images = response.web_images  
+    asyncio.run(save_response_web_imagse(response_images, save_path="save_dir", cookies=cookies))
 ```
 
 `GeminiImage.save` method logic
@@ -281,23 +280,99 @@ if __name__ == "__main__":
 import asyncio
 from gemini import Gemini, GeminiImage
 
-async def fetch_and_save_images_async(prompt: str, save_path: str="save_dir", cookies=cookies):
-    response = await GeminiClient.generate_content_async(prompt)
-
-    response_images = response.web_images  # Check response images [Dict]
+async def save_response_web_imagse(response_images, save_path="save_dir", cookies=cookies):
     image_data_dict = await GeminiImage.fetch_images_dict(response_images, cookies=cookies)  # Get bytes images dict asynchronously
-    await GeminiImage.save_images(image_data_dict, save_path=save_path)  # Save to path asynchronously
+    await GeminiImage.save_images(image_data_dict, save_path=save_path)  
 
 # Run the async function
 if __name__ == "__main__":
-    user_prompt = input("Enter your prompt: ")
-    asyncio.run(fetch_and_save_images_async(user_prompt))
+    response_images = response.web_images  # Check response images [Dict]
+    asyncio.run(save_response_web_imagse(response_images, save_path="save_dir", cookies=cookies))
 ```
 
 </details>
 
 <br>
 
+### # 06. Generate content from images
+Takes an image as input and returns a response.
+
+```python
+image = 'folder/image.jpg'
+# image = open('folder/image.jpg', 'rb').read() # (jpeg, png, webp) are supported.
+
+response = GeminiClient.generate_content("What does the text in this image say?", image=image)
+response.response_dict
+```
+
+<br>
+
+### # 07. Generate content using Google Services
+To begin, you must link Google Workspace to activate this extension via the [Gemini web extension](https://gemini.google.com/extensions). Please refer to the [official notice](https://support.google.com/gemini/answer/13695044) and review the [privacy policies](https://support.google.com/gemini/answer/13594961?visit_id=638457301410420313-1578971242&p=privacy_help&rd=1) for more details.
+
+*extention flags*
+```
+@Gmail, @Google Drive, @Google Docs, @Google Maps, @Google Flights, @Google Hotels, @YouTube
+```
+```python
+response = GeminiClient.generate_content("@YouTube Search clips related with Google Gemini")
+response.response_dict
+```
+<details><summary>Extension description</summary>
+  
+### Google Workspace
+- **Services**: @Gmail, @Google Drive, @Google Docs 
+- **Description**: Summarize, search, and find desired information quickly in your content for efficient personal task management.
+- **Features**: Information retrieval, document summarization, information categorization
+
+### Google Maps
+- **Service**: @Google Maps
+- **Description**: Execute plans using location-based information. Note: Google Maps features may be limited in some regions.
+- **Features**: Route guidance, nearby search, navigation
+
+### Google Flights
+- **Service**: @Google Flights
+- **Description**: Search real-time flight information to plan tailored travel itineraries.
+- **Features**: Holiday preparation, price comparison, trip planning
+
+### Google Hotels
+- **Service**: @Google Hotels
+- **Description**: Search for hotels considering what matters most to you, like having a conversation with a friend.
+- **Features**: Packing for travel, sightseeing, special relaxation
+
+### YouTube
+- **Service**: @YouTube
+- **Description**: Explore YouTube videos and ask questions about what interests you.
+- **Features**: Problem-solving, generating ideas, search, exploring topics
+</details>
+
+<br>
+
+
+### # 08. Fix context setting rcid
+You can specify a particular response by setting its Response Choice ID (RCID).
+
+```python
+# Generate content for the prompt "Give me some information about the USA."
+response1 = GeminiClient.generate_content("Give me some information about the USA.")
+# After reviewing the responses, choose the one you prefer and copy its RCID.
+GeminiClient.rcid = "rc_xxxx"
+
+# Now, generate content for the next prompt "How long does it take from LA to New York?"
+response2 = GeminiClient.generate_content("How long does it take from LA to New York?")
+```
+
+<br>
+
+### # 09. Changing the Selected Response from 0 to n
+In Gemini, generate_content returns the first response. This may vary depending on length or sorting. Therefore, you can specify the index of the chosen response from 0 to n as follows. However, if there is only one response, revert it back to 0.
+```python
+from gemini import GeminiModelOutput
+GeminiModelOutput.chosen = 1 # default is 0
+response1 = GeminiClient.generate_content("Give me some information about the USA.")
+```
+
+
 ## Further
 
 ### Use rotating proxies
@@ -400,14 +475,15 @@ Contributors to the [Bard API](https://github.com/dsdanielpark/Bard-API/) and [G
 </details>
 
 ## Contacts
+
 Core maintainers:
 - [Antonio Cheong](https://github.com/acheong08) / [email protected] <br>
 - [Daniel Park](https://github.com/DSDanielPark) / [email protected]
 
 
 
 ## License
-[MIT](https://opensource.org/license/mit/) license, 2024, Minwoo(Daniel) Park. We hereby strongly disclaim any explicit or implicit legal liability related to our works. Users are required to use this package responsibly and at their own risk. This project is a personal initiative and is not affiliated with or endorsed by Google. It is recommended to use Google's official API.
+[MIT](https://opensource.org/license/mit/) license, 2024. We hereby strongly disclaim any explicit or implicit legal liability related to our works. Users are required to use this package responsibly and at their own risk. This project is a personal initiative and is not affiliated with or endorsed by Google. It is recommended to use Google's official API.
 
 
 ## References
@@ -423,4 +499,3 @@ Users bear all legal responsibilities when using the GeminiAPI package, which of
 <br>
 
 
-*Copyright (c) 2024 Minwoo(Daniel) Park, South Korea*<br>