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

google/genai/_api_client.py

@@ -85,7 +85,11 @@ def _patch_http_options(
 
 def _join_url_path(base_url: str, path: str) -> str:
   parsed_base = urlparse(base_url)
-  base_path = parsed_base.path[:-1] if parsed_base.path.endswith('/') else parsed_base.path
+  base_path = (
+      parsed_base.path[:-1]
+      if parsed_base.path.endswith('/')
+      else parsed_base.path
+  )
   path = path[1:] if path.startswith('/') else path
   return urlunparse(parsed_base._replace(path=base_path + '/' + path))
 
@@ -201,12 +205,14 @@ class ApiClient:
     if (project or location) and api_key:
       # API cannot consume both project/location and api_key.
       raise ValueError(
-          'Project/location and API key are mutually exclusive in the client initializer.'
+          'Project/location and API key are mutually exclusive in the client'
+          ' initializer.'
       )
     elif credentials and api_key:
       # API cannot consume both credentials and api_key.
       raise ValueError(
-          'Credentials and API key are mutually exclusive in the client initializer.'
+          'Credentials and API key are mutually exclusive in the client'
+          ' initializer.'
       )
 
     # Validate http_options if a dict is provided.
@@ -215,7 +221,7 @@ class ApiClient:
         HttpOptions.model_validate(http_options)
       except ValidationError as e:
         raise ValueError(f'Invalid http_options: {e}')
-    elif(isinstance(http_options, HttpOptions)):
+    elif isinstance(http_options, HttpOptions):
       http_options = http_options.model_dump()
 
     # Retrieve implicitly set values from the environment.
@@ -269,17 +275,19 @@ class ApiClient:
             'AI API.'
         )
       if self.api_key or self.location == 'global':
-        self._http_options['base_url'] = (
-            f'https://aiplatform.googleapis.com/'
-        )
+        self._http_options['base_url'] = f'https://aiplatform.googleapis.com/'
       else:
         self._http_options['base_url'] = (
             f'https://{self.location}-aiplatform.googleapis.com/'
         )
       self._http_options['api_version'] = 'v1beta1'
-    else:  # ML Dev API
+    else:  # Implicit initialization or missing arguments.
       if not self.api_key:
-        raise ValueError('API key must be set when using the Google AI API.')
+        raise ValueError(
+            'Missing key inputs argument! To use the Google AI API,'
+            'provide (`api_key`) arguments. To use the Google Cloud API,'
+            ' provide (`vertexai`, `project` & `location`) arguments.'
+        )
       self._http_options['base_url'] = (
           'https://generativelanguage.googleapis.com/'
       )
@@ -363,7 +371,7 @@ class ApiClient:
     if self.vertexai and not self.api_key:
       if not self._credentials:
         self._credentials, _ = google.auth.default(
-            scopes=["https://www.googleapis.com/auth/cloud-platform"],
+            scopes=['https://www.googleapis.com/auth/cloud-platform'],
         )
       authed_session = AuthorizedSession(self._credentials)
       authed_session.stream = stream
@@ -371,9 +379,7 @@ class ApiClient:
           http_request.method.upper(),
           http_request.url,
           headers=http_request.headers,
-          data=json.dumps(http_request.data)
-          if http_request.data
-          else None,
+          data=json.dumps(http_request.data) if http_request.data else None,
           timeout=http_request.timeout,
       )
       errors.APIError.raise_for_response(response)
@@ -415,7 +421,7 @@ class ApiClient:
     if self.vertexai:
       if not self._credentials:
         self._credentials, _ = google.auth.default(
-            scopes=["https://www.googleapis.com/auth/cloud-platform"],
+            scopes=['https://www.googleapis.com/auth/cloud-platform'],
         )
       return await asyncio.to_thread(
           self._request,
@@ -503,6 +509,7 @@ class ApiClient:
     async def async_generator():
       async for chunk in response:
         yield chunk
+
     return async_generator()
 
   def upload_file(

google/genai/_transformers.py

@@ -21,10 +21,10 @@ from enum import Enum, EnumMeta
 import inspect
 import io
 import re
+import sys
 import time
 import typing
 from typing import Any, GenericAlias, Optional, Union
-import sys
 
 if typing.TYPE_CHECKING:
   import PIL.Image
@@ -205,12 +205,17 @@ def t_caches_model(api_client: _api_client.ApiClient, model: str):
 def pil_to_blob(img) -> types.Blob:
   try:
     import PIL.PngImagePlugin
+
     PngImagePlugin = PIL.PngImagePlugin
   except ImportError:
     PngImagePlugin = None
 
   bytesio = io.BytesIO()
-  if PngImagePlugin is not None and isinstance(img, PngImagePlugin.PngImageFile) or img.mode == 'RGBA':
+  if (
+      PngImagePlugin is not None
+      and isinstance(img, PngImagePlugin.PngImageFile)
+      or img.mode == 'RGBA'
+  ):
     img.save(bytesio, format='PNG')
     mime_type = 'image/png'
   else:
@@ -382,7 +387,10 @@ def handle_null_fields(schema: dict[str, Any]):
 def process_schema(
     schema: dict[str, Any],
     client: Optional[_api_client.ApiClient] = None,
-    defs: Optional[dict[str, Any]]=None):
+    defs: Optional[dict[str, Any]] = None,
+    *,
+    order_properties: bool = True,
+):
   """Updates the schema and each sub-schema inplace to be API-compatible.
 
   - Removes the `title` field from the schema if the client is not vertexai.
@@ -517,6 +525,16 @@ def process_schema(
         ref = defs[ref_key.split('defs/')[-1]]
         process_schema(ref, client, defs)
         properties[name] = ref
+    if (
+        len(properties.items()) > 1
+        and order_properties
+        and all(
+            ordering_key not in schema
+            for ordering_key in ['property_ordering', 'propertyOrdering']
+        )
+    ):
+      property_names = list(properties.keys())
+      schema['property_ordering'] = property_names
   elif schema_type == 'ARRAY':
     sub_schema = schema.get('items', None)
     if sub_schema is None:
@@ -539,6 +557,7 @@ def _process_enum(
           f'Enum member {member.name} value must be a string, got'
           f' {type(member.value)}'
       )
+
   class Placeholder(pydantic.BaseModel):
     placeholder: enum
 
@@ -554,7 +573,7 @@ def t_schema(
   if not origin:
     return None
   if isinstance(origin, dict):
-    process_schema(origin, client)
+    process_schema(origin, client, order_properties=False)
     return types.Schema.model_validate(origin)
   if isinstance(origin, EnumMeta):
     return _process_enum(origin, client)
@@ -563,15 +582,15 @@ def t_schema(
       # response_schema value was coerced to an empty Schema instance because it did not adhere to the Schema field annotation
       raise ValueError(f'Unsupported schema type.')
     schema = origin.model_dump(exclude_unset=True)
-    process_schema(schema, client)
+    process_schema(schema, client, order_properties=False)
     return types.Schema.model_validate(schema)
 
   if (
       # in Python 3.9 Generic alias list[int] counts as a type,
       # and breaks issubclass because it's not a class.
-      not isinstance(origin, GenericAlias) and
-      isinstance(origin, type) and
-      issubclass(origin, pydantic.BaseModel)
+      not isinstance(origin, GenericAlias)
+      and isinstance(origin, type)
+      and issubclass(origin, pydantic.BaseModel)
   ):
     schema = origin.model_json_schema()
     process_schema(schema, client)
@@ -582,6 +601,7 @@ def t_schema(
       or isinstance(origin, VersionedUnionType)
       or typing.get_origin(origin) in _UNION_TYPES
   ):
+
     class Placeholder(pydantic.BaseModel):
       placeholder: origin
 

google/genai/caches.py

@@ -172,8 +172,10 @@ def _Schema_to_mldev(
     raise ValueError('example parameter is not supported in Gemini API.')
 
   if getv(from_object, ['property_ordering']) is not None:
-    raise ValueError(
-        'property_ordering parameter is not supported in Gemini API.'
+    setv(
+        to_object,
+        ['propertyOrdering'],
+        getv(from_object, ['property_ordering']),
     )
 
   if getv(from_object, ['pattern']) is not None:

google/genai/client.py

@@ -94,6 +94,17 @@ class Client:
   Use this client to make a request to the Gemini Developer API or Vertex AI
   API and then wait for the response.
 
+  To initialize the client, provide the required arguments either directly
+  or by using environment variables. Gemini API users and Vertex AI users in
+  express mode can provide API key by providing input argument
+  `api_key="your-api-key"` or by defining `GOOGLE_API_KEY="your-api-key"` as an
+  environment variable
+
+  Vertex AI API users can provide inputs argument as `vertexai=false,
+  project="your-project-id", location="us-central1"` or by defining
+  `GOOGLE_GENAI_USE_VERTEXAI=false`, `GOOGLE_CLOUD_PROJECT` and
+  `GOOGLE_CLOUD_LOCATION` environment variables.
+
   Attributes:
     api_key: The `API key <https://ai.google.dev/gemini-api/docs/api-key>`_ to
       use for authentication. Applies to the Gemini Developer API only.
@@ -173,21 +184,11 @@ class Client:
        debug_config (DebugConfig): Config settings that control network behavior
          of the client. This is typically used when running test code.
        http_options (Union[HttpOptions, HttpOptionsDict]): Http options to use
-         for the client. The field deprecated_response_payload should not be set
-         in http_options.
+         for the client.
     """
 
     self._debug_config = debug_config or DebugConfig()
 
-    # Throw ValueError if deprecated_response_payload is set in http_options
-    # due to unpredictable behavior when running multiple coroutines through
-    # client.aio.
-    if http_options and 'deprecated_response_payload' in http_options:
-      raise ValueError(
-          'Setting deprecated_response_payload in http_options is not'
-          ' supported.'
-      )
-
     self._api_client = self._get_api_client(
         vertexai=vertexai,
         api_key=api_key,
@@ -272,4 +273,4 @@ class Client:
   @property
   def vertexai(self) -> bool:
     """Returns whether the client is using the Vertex AI API."""
-    return self._api_client.vertexai or False
+    return self._api_client.vertexai or False

google/genai/models.py

@@ -174,8 +174,10 @@ def _Schema_to_mldev(
     raise ValueError('example parameter is not supported in Gemini API.')
 
   if getv(from_object, ['property_ordering']) is not None:
-    raise ValueError(
-        'property_ordering parameter is not supported in Gemini API.'
+    setv(
+        to_object,
+        ['propertyOrdering'],
+        getv(from_object, ['property_ordering']),
     )
 
   if getv(from_object, ['pattern']) is not None:
@@ -924,8 +926,8 @@ def _GenerateContentConfig_to_mldev(
     )
 
   if getv(from_object, ['media_resolution']) is not None:
-    raise ValueError(
-        'media_resolution parameter is not supported in Gemini API.'
+    setv(
+        to_object, ['mediaResolution'], getv(from_object, ['media_resolution'])
     )
 
   if getv(from_object, ['speech_config']) is not None:
@@ -2787,16 +2789,6 @@ def _ComputeTokensParameters_to_vertex(
   return to_object
 
 
-def _MediaResolution_to_mldev_enum_validate(enum_value: Any):
-  if enum_value in set([
-      'MEDIA_RESOLUTION_UNSPECIFIED',
-      'MEDIA_RESOLUTION_LOW',
-      'MEDIA_RESOLUTION_MEDIUM',
-      'MEDIA_RESOLUTION_HIGH',
-  ]):
-    raise ValueError(f'{enum_value} enum value is not supported in Gemini API.')
-
-
 def _SafetyFilterLevel_to_mldev_enum_validate(enum_value: Any):
   if enum_value in set(['BLOCK_NONE']):
     raise ValueError(f'{enum_value} enum value is not supported in Gemini API.')
@@ -6030,8 +6022,8 @@ class AsyncModels(_api_module.BaseModule):
   ) -> AsyncPager[types.Model]:
     """Makes an API request to list the available models.
 
-    If `query_base` is set to True in the config, the API will return all
-    available base models. If set to False or not set (default), it will return
+    If `query_base` is set to True in the config or not set (default), the
+    API will return all available base models. If set to False, it will return
     all tuned models.
 
     Args:
@@ -6056,6 +6048,8 @@ class AsyncModels(_api_module.BaseModule):
         types._ListModelsParameters(config=config).config
         or types.ListModelsConfig()
     )
+    if config.query_base is None:
+      config.query_base = True
     if self._api_client.vertexai:
       config = config.copy()
       if not config.query_base:
@@ -6066,8 +6060,6 @@ class AsyncModels(_api_module.BaseModule):
             if filter_value
             else 'labels.tune-type:*'
         )
-    if not config.query_base:
-      config.query_base = False
     return AsyncPager(
         'models',
         self._list,

google/genai/types.py

@@ -22,9 +22,10 @@ import json
 import logging
 import sys
 import typing
-from typing import Any, Callable, GenericAlias, Literal, Optional, Type, TypedDict, Union
+from typing import Any, Callable, GenericAlias, Literal, Optional, Union
 import pydantic
 from pydantic import Field
+from typing_extensions import TypedDict
 from . import _common
 
 if sys.version_info >= (3, 10):
@@ -43,7 +44,7 @@ if typing.TYPE_CHECKING:
   PIL_Image = PIL.Image.Image
   _is_pillow_image_imported = True
 else:
-  PIL_Image: Type = Any
+  PIL_Image: typing.Type = Any
   try:
     import PIL.Image
 
@@ -1592,7 +1593,7 @@ class File(_common.BaseModel):
   )
   expiration_time: Optional[datetime.datetime] = Field(
       default=None,
-      description="""Optional. The human-readable display name for the `File`. The display name must be no more than 512 characters in length, including spaces. Example: 'Welcome Image'""",
+      description="""Output only. The timestamp of when the `File` will be deleted. Only set if the `File` is scheduled to expire.""",
   )
   update_time: Optional[datetime.datetime] = Field(
       default=None,
@@ -1643,7 +1644,7 @@ class FileDict(TypedDict, total=False):
   """Output only. The timestamp of when the `File` was created."""
 
   expiration_time: Optional[datetime.datetime]
-  """Optional. The human-readable display name for the `File`. The display name must be no more than 512 characters in length, including spaces. Example: 'Welcome Image'"""
+  """Output only. The timestamp of when the `File` will be deleted. Only set if the `File` is scheduled to expire."""
 
   update_time: Optional[datetime.datetime]
   """Output only. The timestamp of when the `File` was last updated."""

google/genai/version.py

@@ -13,4 +13,4 @@
 # limitations under the License.
 #
 
-__version__ = '1.1.0' # x-release-please-version
+__version__ = '1.2.0' # x-release-please-version

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: google-genai
-Version: 1.1.0
+Version: 1.2.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache-2.0
@@ -24,6 +24,7 @@ Requires-Dist: google-auth<3.0.0dev,>=2.14.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,6 +67,33 @@ 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=false
+export GOOGLE_CLOUD_PROJECT='your-project-id'
+export GOOGLE_CLOUD_LOCATION='us-central1'
+```
+
+```python
+client = genai.Client()
+```
+
+### API Selection
+
 To set the API version use `http_options`. For example, to set the API version
 to `v1` for Vertex AI:
 
@@ -114,7 +142,7 @@ download the file in console.
 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]
@@ -778,17 +806,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)
 ```

{google_genai-1.1.0.dist-info → google_genai-1.2.0.dist-info}/RECORD

@@ -1,5 +1,5 @@
 google/genai/__init__.py,sha256=IYw-PcsdgjSpS1mU_ZcYkTfPocsJ4aVmrDxP7vX7c6Y,709
-google/genai/_api_client.py,sha256=wLDcPY7qZi3caUlN-uIzbir6gzKQZg-zP8cxBp9Yq5g,22534
+google/genai/_api_client.py,sha256=uQ-nYVKD81mPvXj7_CAIfhAgv2_aJlFCXQ0llSNal8s,22747
 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
@@ -7,21 +7,21 @@ google/genai/_extra_utils.py,sha256=vpZs7mrAwZ1mJrbsmSdqrDepLe4hyPgjNYENV56lv2Y,
 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/_transformers.py,sha256=iZ1EFNEJE3Nh3ZnccUQmdRupWLDJonaEreilhvenK-w,24331
 google/genai/batches.py,sha256=jv8pW_g_cZee6ol5ER5bQRUkXsj4IUcZC5cMo-YAnt0,38033
-google/genai/caches.py,sha256=jsiclHO71kIa2CNrds3O8PL2fCNr_dlhUSPjhiRsjNE,53152
+google/genai/caches.py,sha256=lTlGSSeCLhh9kq6k4kzjVomHp0gqlON_LUOgnWbfNc0,53169
 google/genai/chats.py,sha256=6gKf81vtLqUAR2TeaI0kZfxrEPEHbfwxHB5hI9zSz9A,8552
-google/genai/client.py,sha256=MTZ3DOXk1_xgljaHlvF16jr_SKVPRfU8lZ1eH_dfDeQ,9334
+google/genai/client.py,sha256=YvOt-jPWynf4exAh5rfl2i-YxQCrw5Z9zWQNSwtE6xE,9451
 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/models.py,sha256=guW4WbKmfMT97TW3l4-kJHi7VyncpReceESL-Qi3gTI,178167
 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,,
+google/genai/types.py,sha256=8-gnTJ26SR_d2Gp_QkN2UrfKSCY-dS3LfK0TrCIf9WQ,281176
+google/genai/version.py,sha256=LyKJKSTJTPOw5Ja9WHJkQfQM6sTw2mTPv4HOr8RUwyk,626
+google_genai-1.2.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+google_genai-1.2.0.dist-info/METADATA,sha256=4y5cU1W6Xsq2fgBN7n-q1xqpJAyW3YSQR2bOT6sAYqk,26940
+google_genai-1.2.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+google_genai-1.2.0.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
+google_genai-1.2.0.dist-info/RECORD,,