google-genai 1.1.0__py3-none-any.whl → 1.3.0__py3-none-any.whl

{google_genai-1.1.0.dist-info → google_genai-1.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: google-genai
-Version: 1.1.0
+Version: 1.3.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache-2.0
@@ -21,9 +21,11 @@ Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: google-auth<3.0.0dev,>=2.14.1
+Requires-Dist: httpx<1.0.0dev,>=0.28.1
 Requires-Dist: pydantic<3.0.0dev,>=2.0.0
 Requires-Dist: requests<3.0.0dev,>=2.28.1
 Requires-Dist: websockets<15.0dev,>=13.0
+Requires-Dist: typing-extensions<5.0.0dev,>=4.11.0
 
 # Google Gen AI SDK
 
@@ -66,21 +68,56 @@ client = genai.Client(
 )
 ```
 
+**(Optional) Using environment variables:**
+
+You can create a client by configuring the necessary environment variables.
+Configuration setup instructions depends on whether you're using the Gemini API
+on Vertex AI or the ML Dev Gemini API.
+
+**ML Dev Gemini API:** Set `GOOGLE_API_KEY` as shown below:
+
+```bash
+export GOOGLE_API_KEY='your-api-key'
+```
+
+**Vertex AI API:** Set `GOOGLE_GENAI_USE_VERTEXAI`, `GOOGLE_CLOUD_PROJECT`
+and `GOOGLE_CLOUD_LOCATION`, as shown below:
+
+```bash
+export GOOGLE_GENAI_USE_VERTEXAI=true
+export GOOGLE_CLOUD_PROJECT='your-project-id'
+export GOOGLE_CLOUD_LOCATION='us-central1'
+```
+
+```python
+client = genai.Client()
+```
+
+### API Selection
+
+By default, the SDK uses the beta API endpoints provided by Google to support
+preview features in the APIs. The stable API endpoints can be selected by
+setting the API version to `v1`.
+
 To set the API version use `http_options`. For example, to set the API version
 to `v1` for Vertex AI:
 
 ```python
 client = genai.Client(
-    vertexai=True, project='your-project-id', location='us-central1',
-    http_options={'api_version': 'v1'}
+    vertexai=True,
+    project='your-project-id',
+    location='us-central1',
+    http_options=types.HttpOptions(api_version='v1')
 )
 ```
 
-To set the API version to `v1alpha` for the Gemini API:
+To set the API version to `v1alpha` for the Gemini Developer API:
 
 ```python
-client = genai.Client(api_key='GEMINI_API_KEY',
-                      http_options={'api_version': 'v1alpha'})
+client = genai.Client(
+    api_key='GEMINI_API_KEY',
+    http_options=types.HttpOptions(api_version='v1alpha')
+)
 ```
 
 ## Types
@@ -99,7 +136,7 @@ The `client.models` modules exposes model inferencing and model getters.
 
 ```python
 response = client.models.generate_content(
-    model='gemini-2.0-flash-001', contents='why is the sky blue?'
+    model='gemini-2.0-flash-001', contents='Why is the sky blue?'
 )
 print(response.text)
 ```
@@ -107,14 +144,14 @@ print(response.text)
 #### with uploaded file (Gemini API only)
 download the file in console.
 
-```cmd
+```sh
 !wget -q https://storage.googleapis.com/generativeai-downloads/data/a11.txt
 ```
 
 python code.
 
 ```python
-file = client.files.upload(path='a11.txt')
+file = client.files.upload(file='a11.txt')
 response = client.models.generate_content(
     model='gemini-2.0-flash-001',
     contents=['Could you summarize this file?', file]
@@ -247,7 +284,7 @@ print(response.text)
 #### Automatic Python function Support
 
 You can pass a Python function directly and it will be automatically
-called and responded.
+called and responded by default.
 
 ```python
 def get_current_weather(location: str) -> str:
@@ -267,6 +304,30 @@ response = client.models.generate_content(
 
 print(response.text)
 ```
+#### Disabling automatic function calling
+If you pass in a python function as a tool directly, and do not want
+automatic function calling, you can disable automatic function calling
+as follows:
+
+```python
+response = client.models.generate_content(
+  model='gemini-2.0-flash-001',
+  contents='What is the weather like in Boston?',
+  config=types.GenerateContentConfig(
+    tools=[get_current_weather],
+    automatic_function_calling=types.AutomaticFunctionCallingConfig(
+      disable=True
+    ),
+  ),
+)
+```
+
+With automatic function calling disabled, you will get a list of function call
+parts in the response:
+
+```python
+function_calls: Optional[List[types.FunctionCall]] = response.function_calls
+```
 
 #### Manually declare and invoke a function for function calling
 
@@ -664,7 +725,6 @@ response1 = client.models.generate_images(
     model='imagen-3.0-generate-002',
     prompt='An umbrella in the foreground, and a rainy night sky in the background',
     config=types.GenerateImagesConfig(
-        negative_prompt='human',
         number_of_images=1,
         include_rai_reason=True,
         output_mime_type='image/jpeg',
@@ -722,7 +782,6 @@ response3 = client.models.edit_image(
     config=types.EditImageConfig(
         edit_mode='EDIT_MODE_INPAINT_INSERTION',
         number_of_images=1,
-        negative_prompt='human',
         include_rai_reason=True,
         output_mime_type='image/jpeg',
     ),
@@ -730,6 +789,34 @@ response3 = client.models.edit_image(
 response3.generated_images[0].image.show()
 ```
 
+### Veo
+
+#### Generate Videos
+
+Support for generate videos in Vertex and Gemini Developer API is behind an allowlist
+
+```python
+# Create operation
+operation = client.models.generate_videos(
+    model='veo-2.0-generate-001',
+    prompt='A neon hologram of a cat driving at top speed',
+    config=types.GenerateVideosConfig(
+        number_of_videos=1,
+        fps=24,
+        duration_seconds=5,
+        enhance_prompt=True,
+    ),
+)
+
+# Poll operation
+while not operation.done:
+    time.sleep(20)
+    operation = client.operations.get(operation)
+
+video = operation.result.generated_videos[0].video
+video.show()
+```
+
 ## Chats
 
 Create a chat session to start a multi-turn conversations with the model.
@@ -778,17 +865,24 @@ Files are only supported in Gemini Developer API.
 ### Upload
 
 ```python
-file1 = client.files.upload(path='2312.11805v3.pdf')
-file2 = client.files.upload(path='2403.05530.pdf')
+file1 = client.files.upload(file='2312.11805v3.pdf')
+file2 = client.files.upload(file='2403.05530.pdf')
 
 print(file1)
 print(file2)
 ```
 
+### Get
+
+```python
+file1 = client.files.upload(file='2312.11805v3.pdf')
+file_info = client.files.get(name=file1.name)
+```
+
 ### Delete
 
 ```python
-file3 = client.files.upload(path='2312.11805v3.pdf')
+file3 = client.files.upload(file='2312.11805v3.pdf')
 
 client.files.delete(name=file3.name)
 ```
@@ -1093,3 +1187,20 @@ delete_job = client.batches.delete(name=job.name)
 
 delete_job
 ```
+
+## Error Handling
+
+To handle errors raised by the model service, the SDK provides this [APIError](https://github.com/googleapis/python-genai/blob/main/google/genai/errors.py) class.
+
+```python
+from google.genai import errors
+
+try:
+  client.models.generate_content(
+      model="invalid-model-name",
+      contents="What is your name?",
+  )
+except errors.APIError as e:
+  print(e.code) # 404
+  print(e.message)
+```

google_genai-1.3.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+google/genai/__init__.py,sha256=IYw-PcsdgjSpS1mU_ZcYkTfPocsJ4aVmrDxP7vX7c6Y,709
+google/genai/_api_client.py,sha256=Y8Mv9QYdHnvzCy4DsPB6aQNKCfOIuwJ67gaew3zS2BA,26759
+google/genai/_api_module.py,sha256=ySPNIb2OC2vhDpU7VOYvP2-Av3ZlmwgEpIaqF4fIWWc,898
+google/genai/_automatic_function_calling_util.py,sha256=Hs7vvLRCRxL-YbNRnwx_qulY9sspwE6xP7A3-cjoIB8,10834
+google/genai/_common.py,sha256=GUaoMzkTPw7oS18gkDArOTPb5EKwt8JpND5-THIZ_-I,9961
+google/genai/_extra_utils.py,sha256=Ia3jUDwKLhgVXawBBA3l5Y0R12c4oWr69D0b6tfLTww,11729
+google/genai/_replay_api_client.py,sha256=pbpeeWL4hHAE_8S0YbrCfgGeQxCioBFhcUDTJtH4rjs,16152
+google/genai/_test_api_client.py,sha256=2PvDcW3h01U4UOSoj7TUo6TwdBHSEN_lO2tXjBoh5Fw,4765
+google/genai/_transformers.py,sha256=jBmQS1_KPndBR1mc41t3vKUKCM42duvnniQjLAKGVfQ,24612
+google/genai/batches.py,sha256=_ktwVQvHHUz7JkyXSUXpW_isyBIK_8BQkPD4OUjdJzg,38130
+google/genai/caches.py,sha256=IiNVYtCyadYBYIGV3aszdrw_HB0sOH5ps1bnEfnc7n0,53167
+google/genai/chats.py,sha256=6gKf81vtLqUAR2TeaI0kZfxrEPEHbfwxHB5hI9zSz9A,8552
+google/genai/client.py,sha256=vPVU_Edh1IMFoq9pVpq4bZOVo71FaKzSVpdUn2y4HPM,9773
+google/genai/errors.py,sha256=gALDvxSVHX163dtH_Uf0zsWcHy-p4U4zf7CTRigXjLE,4205
+google/genai/files.py,sha256=VfB02YaVAl5MWxqD5Zg5PYXtv4_VtfNMjxk5HbcCaI8,42169
+google/genai/live.py,sha256=DGNbhkOx5Dj_6uIOc1UsgRodv3NX3ztYbfS6VUjXJgc,24276
+google/genai/models.py,sha256=b2iymH-aaldS72xbbQiUFUWkpATCrVSh0Kxs6S1ngiw,194655
+google/genai/operations.py,sha256=C96700qYD9hlTahjlP0VPEcTsio-sXtfB7ml16G-IZQ,17954
+google/genai/pagers.py,sha256=hSHd-gLvEzYWwK85i8EcFNWUMKtszUs7Nw2r3L7d6_U,6686
+google/genai/tunings.py,sha256=5qtJO3atPxhHyReYoU3yavQ3cEoc5h7mZpSzxsE1Jmg,44745
+google/genai/types.py,sha256=qGZQ_IBCNKUPK_Ft5A4qbG1V3xbhisOQNvv2EZ8s4Lg,295881
+google/genai/version.py,sha256=6XlttB_dEVuHt3Ks7rw29lt6WqnD9MqEtyZ3jfjI3XQ,626
+google_genai-1.3.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+google_genai-1.3.0.dist-info/METADATA,sha256=TBFoFOTwCodhcG4v7sWYbSccYfh2UXZdyC5A2iS7rK8,28874
+google_genai-1.3.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+google_genai-1.3.0.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
+google_genai-1.3.0.dist-info/RECORD,,

google_genai-1.1.0.dist-info/RECORD

@@ -1,27 +0,0 @@
-google/genai/__init__.py,sha256=IYw-PcsdgjSpS1mU_ZcYkTfPocsJ4aVmrDxP7vX7c6Y,709
-google/genai/_api_client.py,sha256=wLDcPY7qZi3caUlN-uIzbir6gzKQZg-zP8cxBp9Yq5g,22534
-google/genai/_api_module.py,sha256=9bxmtcSTpT8Ht6VwJyw7fQqiR0jJXz7350dWGl-bC5E,780
-google/genai/_automatic_function_calling_util.py,sha256=Hs7vvLRCRxL-YbNRnwx_qulY9sspwE6xP7A3-cjoIB8,10834
-google/genai/_common.py,sha256=HrGkshBrfkt5bARjtJ8-dSLJSKEptM1JnqDG5AGm2Rw,9565
-google/genai/_extra_utils.py,sha256=vpZs7mrAwZ1mJrbsmSdqrDepLe4hyPgjNYENV56lv2Y,11508
-google/genai/_operations.py,sha256=KaDgwqG5g6Odd1P6ftvIUT9gF3ov08drm01jE1CjB_s,11490
-google/genai/_replay_api_client.py,sha256=f_znGdDKXUOEN8lkRBzVZ6LDSGwrWHzy9N-Sk6pUU4E,14963
-google/genai/_test_api_client.py,sha256=2PvDcW3h01U4UOSoj7TUo6TwdBHSEN_lO2tXjBoh5Fw,4765
-google/genai/_transformers.py,sha256=BfKU8xla1OmE5MmTxhYIMhBjZE3LJ2Rag1Fd6ojXX18,23891
-google/genai/batches.py,sha256=jv8pW_g_cZee6ol5ER5bQRUkXsj4IUcZC5cMo-YAnt0,38033
-google/genai/caches.py,sha256=jsiclHO71kIa2CNrds3O8PL2fCNr_dlhUSPjhiRsjNE,53152
-google/genai/chats.py,sha256=6gKf81vtLqUAR2TeaI0kZfxrEPEHbfwxHB5hI9zSz9A,8552
-google/genai/client.py,sha256=MTZ3DOXk1_xgljaHlvF16jr_SKVPRfU8lZ1eH_dfDeQ,9334
-google/genai/errors.py,sha256=dea3cQecyGFMoV5oIvUfKeMY904HzlcT4oiPWQzDCZo,3746
-google/genai/files.py,sha256=U3qaa31AX7dKcZh6RkZSAkrDO7FVitukMW67wxL70kQ,42074
-google/genai/live.py,sha256=xDu1wV8iQ5lI2i4_AmtOQOuiiPXBt6WykV_rXfjb0Sc,23467
-google/genai/models.py,sha256=GEmUx8hLdfEenZNeUDjbKkpHHXsFiaxmAI5JN9OQHXA,178456
-google/genai/pagers.py,sha256=hSHd-gLvEzYWwK85i8EcFNWUMKtszUs7Nw2r3L7d6_U,6686
-google/genai/tunings.py,sha256=sZYVy8gJmvMLxYGLVDhASVPNP58ngNVIQb3CWJVTs48,44678
-google/genai/types.py,sha256=2Ysd4tt4a2_FK8L-idyH6a9UvoXKOr0eg_xluGl_34M,281256
-google/genai/version.py,sha256=xY649pcj-oW-ztwg6bMebnF3eIBvVGp4g6eFatbMDGQ,626
-google_genai-1.1.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-google_genai-1.1.0.dist-info/METADATA,sha256=xywOX430bytBvC7mthMlXcpVJPUF7ugZocPm2UvG9wY,26094
-google_genai-1.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-google_genai-1.1.0.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
-google_genai-1.1.0.dist-info/RECORD,,