google-genai 1.6.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

google/genai/_api_client.py

@@ -188,9 +188,11 @@ class HttpResponse:
         if chunk:
           # In streaming mode, the chunk of JSON is prefixed with "data:" which
           # we must strip before parsing.
-          if chunk.startswith(b'data: '):
-            chunk = chunk[len(b'data: ') :]
-          yield json.loads(str(chunk, 'utf-8'))
+          if not isinstance(chunk, str):
+            chunk = chunk.decode('utf-8')
+          if chunk.startswith('data: '):
+            chunk = chunk[len('data: ') :]
+          yield json.loads(chunk)
 
   async def async_segments(self) -> AsyncIterator[Any]:
     if isinstance(self.response_stream, list):
@@ -206,8 +208,10 @@ class HttpResponse:
         async for chunk in self.response_stream.aiter_lines():
           # This is httpx.Response.
           if chunk:
-            # In async streaming mode, the chunk of JSON is prefixed with "data:"
-            # which we must strip before parsing.
+            # In async streaming mode, the chunk of JSON is prefixed with
+            # "data:" which we must strip before parsing.
+            if not isinstance(chunk, str):
+              chunk = chunk.decode('utf-8')
             if chunk.startswith('data: '):
               chunk = chunk[len('data: ') :]
             yield json.loads(chunk)
@@ -234,6 +238,41 @@ class HttpResponse:
       response_payload[attribute] = copy.deepcopy(getattr(self, attribute))
 
 
+class SyncHttpxClient(httpx.Client):
+  """Sync httpx client."""
+
+  def __init__(self, **kwargs: Any) -> None:
+    """Initializes the httpx client."""
+    kwargs.setdefault('follow_redirects', True)
+    super().__init__(**kwargs)
+
+  def __del__(self) -> None:
+    """Closes the httpx client."""
+    if self.is_closed:
+      return
+    try:
+      self.close()
+    except Exception:
+      pass
+
+
+class AsyncHttpxClient(httpx.AsyncClient):
+  """Async httpx client."""
+
+  def __init__(self, **kwargs: Any) -> None:
+    """Initializes the httpx client."""
+    kwargs.setdefault('follow_redirects', True)
+    super().__init__(**kwargs)
+
+  def __del__(self) -> None:
+    if self.is_closed:
+      return
+    try:
+      asyncio.get_running_loop().create_task(self.aclose())
+    except Exception:
+      pass
+
+
 class BaseApiClient:
   """Client for calling HTTP APIs sending and receiving JSON."""
 
@@ -365,6 +404,9 @@ class BaseApiClient:
       )
     else:
       _append_library_version_headers(self._http_options['headers'])
+    # Initialize the httpx client.
+    self._httpx_client = SyncHttpxClient()
+    self._async_httpx_client = AsyncHttpxClient()
 
   def _websocket_base_url(self):
     url_parts = urlparse(self._http_options['base_url'])
@@ -495,41 +537,39 @@ class BaseApiClient:
         http_request.headers['x-goog-user-project'] = (
             self._credentials.quota_project_id
         )
-      data = json.dumps(http_request.data)
+      data = json.dumps(http_request.data) if http_request.data else None
     else:
       if http_request.data:
         if not isinstance(http_request.data, bytes):
-          data = json.dumps(http_request.data)
+          data = json.dumps(http_request.data) if http_request.data else None
         else:
           data = http_request.data
 
     if stream:
-      client = httpx.Client()
-      httpx_request = client.build_request(
+      httpx_request = self._httpx_client.build_request(
           method=http_request.method,
           url=http_request.url,
           content=data,
           headers=http_request.headers,
           timeout=http_request.timeout,
       )
-      response = client.send(httpx_request, stream=stream)
+      response = self._httpx_client.send(httpx_request, stream=stream)
       errors.APIError.raise_for_response(response)
       return HttpResponse(
           response.headers, response if stream else [response.text]
       )
     else:
-      with httpx.Client() as client:
-        response = client.request(
-            method=http_request.method,
-            url=http_request.url,
-            headers=http_request.headers,
-            content=data,
-            timeout=http_request.timeout,
-        )
-        errors.APIError.raise_for_response(response)
-        return HttpResponse(
-            response.headers, response if stream else [response.text]
-        )
+      response = self._httpx_client.request(
+          method=http_request.method,
+          url=http_request.url,
+          headers=http_request.headers,
+          content=data,
+          timeout=http_request.timeout,
+      )
+      errors.APIError.raise_for_response(response)
+      return HttpResponse(
+          response.headers, response if stream else [response.text]
+      )
 
   async def _async_request(
       self, http_request: HttpRequest, stream: bool = False
@@ -543,24 +583,23 @@ class BaseApiClient:
         http_request.headers['x-goog-user-project'] = (
             self._credentials.quota_project_id
         )
-      data = json.dumps(http_request.data)
+      data = json.dumps(http_request.data) if http_request.data else None
     else:
       if http_request.data:
         if not isinstance(http_request.data, bytes):
-          data = json.dumps(http_request.data)
+          data = json.dumps(http_request.data) if http_request.data else None
         else:
           data = http_request.data
 
     if stream:
-      aclient = httpx.AsyncClient()
-      httpx_request = aclient.build_request(
+      httpx_request = self._async_httpx_client.build_request(
           method=http_request.method,
           url=http_request.url,
           content=data,
           headers=http_request.headers,
           timeout=http_request.timeout,
       )
-      response = await aclient.send(
+      response = await self._async_httpx_client.send(
           httpx_request,
           stream=stream,
       )
@@ -569,18 +608,17 @@ class BaseApiClient:
           response.headers, response if stream else [response.text]
       )
     else:
-      async with httpx.AsyncClient() as aclient:
-        response = await aclient.request(
-            method=http_request.method,
-            url=http_request.url,
-            headers=http_request.headers,
-            content=data,
-            timeout=http_request.timeout,
-        )
-        errors.APIError.raise_for_response(response)
-        return HttpResponse(
-            response.headers, response if stream else [response.text]
-        )
+      response = await self._async_httpx_client.request(
+          method=http_request.method,
+          url=http_request.url,
+          headers=http_request.headers,
+          content=data,
+          timeout=http_request.timeout,
+      )
+      errors.APIError.raise_for_response(response)
+      return HttpResponse(
+          response.headers, response if stream else [response.text]
+      )
 
   def get_read_only_http_options(self) -> HttpOptionsDict:
     copied = HttpOptionsDict()
@@ -705,7 +743,7 @@ class BaseApiClient:
       # If last chunk, finalize the upload.
       if chunk_size + offset >= upload_size:
         upload_command += ', finalize'
-      request = HttpRequest(
+      response = self._httpx_client.request(
           method='POST',
           url=upload_url,
           headers={
@@ -713,25 +751,22 @@ class BaseApiClient:
               'X-Goog-Upload-Offset': str(offset),
               'Content-Length': str(chunk_size),
           },
-          data=file_chunk,
+          content=file_chunk,
       )
-
-      response = self._request(request, stream=False)
       offset += chunk_size
-      if response.headers['X-Goog-Upload-Status'] != 'active':
+      if response.headers['x-goog-upload-status'] != 'active':
         break  # upload is complete or it has been interrupted.
-
       if upload_size <= offset:  # Status is not finalized.
         raise ValueError(
             'All content has been uploaded, but the upload status is not'
             f' finalized.'
         )
 
-    if response.headers['X-Goog-Upload-Status'] != 'final':
+    if response.headers['x-goog-upload-status'] != 'final':
       raise ValueError(
           'Failed to upload file: Upload status is not finalized.'
       )
-    return response.json
+    return response.json()
 
   def download_file(self, path: str, http_options):
     """Downloads the file data.
@@ -746,12 +781,7 @@ class BaseApiClient:
     http_request = self._build_request(
         'get', path=path, request_dict={}, http_options=http_options
     )
-    return self._download_file_request(http_request).byte_stream[0]
 
-  def _download_file_request(
-      self,
-      http_request: HttpRequest,
-  ) -> HttpResponse:
     data: Optional[Union[str, bytes]] = None
     if http_request.data:
       if not isinstance(http_request.data, bytes):
@@ -759,17 +789,18 @@ class BaseApiClient:
       else:
         data = http_request.data
 
-    with httpx.Client(follow_redirects=True) as client:
-      response = client.request(
-          method=http_request.method,
-          url=http_request.url,
-          headers=http_request.headers,
-          content=data,
-          timeout=http_request.timeout,
-      )
+    response = self._httpx_client.request(
+        method=http_request.method,
+        url=http_request.url,
+        headers=http_request.headers,
+        content=data,
+        timeout=http_request.timeout,
+    )
 
-      errors.APIError.raise_for_response(response)
-      return HttpResponse(response.headers, byte_stream=[response.read()])
+    errors.APIError.raise_for_response(response)
+    return HttpResponse(
+        response.headers, byte_stream=[response.read()]
+    ).byte_stream[0]
 
   async def async_upload_file(
       self,
@@ -814,45 +845,44 @@ class BaseApiClient:
     returns:
           The response json object from the finalize request.
     """
-    async with httpx.AsyncClient() as aclient:
-      offset = 0
-      # Upload the file in chunks
-      while True:
-        if isinstance(file, io.IOBase):
-          file_chunk = file.read(CHUNK_SIZE)
-        else:
-          file_chunk = await file.read(CHUNK_SIZE)
-        chunk_size = 0
-        if file_chunk:
-          chunk_size = len(file_chunk)
-        upload_command = 'upload'
-        # If last chunk, finalize the upload.
-        if chunk_size + offset >= upload_size:
-          upload_command += ', finalize'
-        response = await aclient.request(
-            method='POST',
-            url=upload_url,
-            content=file_chunk,
-            headers={
-                'X-Goog-Upload-Command': upload_command,
-                'X-Goog-Upload-Offset': str(offset),
-                'Content-Length': str(chunk_size),
-            },
-        )
-        offset += chunk_size
-        if response.headers.get('x-goog-upload-status') != 'active':
-          break  # upload is complete or it has been interrupted.
-
-        if upload_size <= offset:  # Status is not finalized.
-          raise ValueError(
-              'All content has been uploaded, but the upload status is not'
-              f' finalized.'
-          )
-      if response.headers.get('x-goog-upload-status') != 'final':
+    offset = 0
+    # Upload the file in chunks
+    while True:
+      if isinstance(file, io.IOBase):
+        file_chunk = file.read(CHUNK_SIZE)
+      else:
+        file_chunk = await file.read(CHUNK_SIZE)
+      chunk_size = 0
+      if file_chunk:
+        chunk_size = len(file_chunk)
+      upload_command = 'upload'
+      # If last chunk, finalize the upload.
+      if chunk_size + offset >= upload_size:
+        upload_command += ', finalize'
+      response = await self._async_httpx_client.request(
+          method='POST',
+          url=upload_url,
+          content=file_chunk,
+          headers={
+              'X-Goog-Upload-Command': upload_command,
+              'X-Goog-Upload-Offset': str(offset),
+              'Content-Length': str(chunk_size),
+          },
+      )
+      offset += chunk_size
+      if response.headers.get('x-goog-upload-status') != 'active':
+        break  # upload is complete or it has been interrupted.
+
+      if upload_size <= offset:  # Status is not finalized.
         raise ValueError(
-            'Failed to upload file: Upload status is not finalized.'
+            'All content has been uploaded, but the upload status is not'
+            f' finalized.'
         )
-      return response.json()
+    if response.headers.get('x-goog-upload-status') != 'final':
+      raise ValueError(
+          'Failed to upload file: Upload status is not finalized.'
+      )
+    return response.json()
 
   async def async_download_file(self, path: str, http_options):
     """Downloads the file data.
@@ -875,19 +905,18 @@ class BaseApiClient:
       else:
         data = http_request.data
 
-    async with httpx.AsyncClient(follow_redirects=True) as aclient:
-      response = await aclient.request(
-          method=http_request.method,
-          url=http_request.url,
-          headers=http_request.headers,
-          content=data,
-          timeout=http_request.timeout,
-      )
-      errors.APIError.raise_for_response(response)
+    response = await self._async_httpx_client.request(
+        method=http_request.method,
+        url=http_request.url,
+        headers=http_request.headers,
+        content=data,
+        timeout=http_request.timeout,
+    )
+    errors.APIError.raise_for_response(response)
 
-      return HttpResponse(
-          response.headers, byte_stream=[response.read()]
-      ).byte_stream[0]
+    return HttpResponse(
+        response.headers, byte_stream=[response.read()]
+    ).byte_stream[0]
 
   # This method does nothing in the real api client. It is used in the
   # replay_api_client to verify the response from the SDK method matches the

google/genai/_common.py

@@ -20,7 +20,7 @@ import datetime
 import enum
 import functools
 import typing
-from typing import Union
+from typing import Any, Union
 import uuid
 import warnings
 
@@ -93,7 +93,7 @@ def set_value_by_path(data, keys, value):
     data[keys[-1]] = value
 
 
-def get_value_by_path(data: object, keys: list[str]):
+def get_value_by_path(data: Any, keys: list[str]):
   """Examples:
 
   get_value_by_path({'a': {'b': v}}, ['a', 'b'])
@@ -128,7 +128,7 @@ def get_value_by_path(data: object, keys: list[str]):
   return data
 
 
-def convert_to_dict(obj: dict[str, object]) -> dict[str, object]:
+def convert_to_dict(obj: object) -> Any:
   """Recursively converts a given object to a dictionary.
 
   If the object is a Pydantic model, it uses the model's `model_dump()` method.
@@ -137,7 +137,9 @@ def convert_to_dict(obj: dict[str, object]) -> dict[str, object]:
     obj: The object to convert.
 
   Returns:
-    A dictionary representation of the object.
+    A dictionary representation of the object, a list of objects if a list is
+    passed, or the object itself if it is not a dictionary, list, or Pydantic
+    model.
   """
   if isinstance(obj, pydantic.BaseModel):
     return obj.model_dump(exclude_none=True)
@@ -150,7 +152,7 @@ def convert_to_dict(obj: dict[str, object]) -> dict[str, object]:
 
 
 def _remove_extra_fields(
-    model: pydantic.BaseModel, response: dict[str, object]
+    model: Any, response: dict[str, object]
 ) -> None:
   """Removes extra fields from the response that are not in the model.
 

google/genai/_replay_api_client.py

@@ -520,11 +520,14 @@ class ReplayApiClient(BaseApiClient):
     else:
       return self._build_response_from_replay(request).json
 
-  def _download_file_request(self, request):
+  def download_file(self, path: str, http_options: HttpOptions):
     self._initialize_replay_session_if_not_loaded()
+    request = self._build_request(
+        'get', path=path, request_dict={}, http_options=http_options
+    )
     if self._should_call_api():
       try:
-        result = super()._download_file_request(request)
+        result = super().download_file(path, http_options)
       except HTTPError as e:
         result = HttpResponse(
             e.response.headers, [json.dumps({'reason': e.response.reason})]
@@ -534,7 +537,7 @@ class ReplayApiClient(BaseApiClient):
       self._record_interaction(request, result)
       return result
     else:
-      return self._build_response_from_replay(request)
+      return self._build_response_from_replay(request).byte_stream[0]
 
   async def async_download_file(self, path: str, http_options):
     self._initialize_replay_session_if_not_loaded()

google/genai/chats.py

@@ -13,12 +13,19 @@
 # limitations under the License.
 #
 
-from typing import AsyncIterator, Awaitable, Optional
-from typing import Union
+import sys
+from typing import AsyncIterator, Awaitable, Optional, Union, get_args
 
 from . import _transformers as t
+from . import types
 from .models import AsyncModels, Models
-from .types import Content, ContentDict, GenerateContentConfigOrDict, GenerateContentResponse, Part, PartUnionDict
+from .types import Content, GenerateContentConfigOrDict, GenerateContentResponse, Part, PartUnionDict
+
+
+if sys.version_info >= (3, 10):
+  from typing import TypeGuard
+else:
+  from typing_extensions import TypeGuard
 
 
 def _validate_content(content: Content) -> bool:
@@ -81,8 +88,7 @@ def _extract_curated_history(
   while i < length:
     if comprehensive_history[i].role not in ["user", "model"]:
       raise ValueError(
-          "Role must be user or model, but got"
-          f" {comprehensive_history[i].role}"
+          f"Role must be user or model, but got {comprehensive_history[i].role}"
       )
 
     if comprehensive_history[i].role == "user":
@@ -108,12 +114,10 @@ class _BaseChat:
   def __init__(
       self,
       *,
-      modules: Union[Models, AsyncModels],
       model: str,
       config: Optional[GenerateContentConfigOrDict] = None,
       history: list[Content],
   ):
-    self._modules = modules
     self._model = model
     self._config = config
     self._comprehensive_history = history
@@ -123,27 +127,32 @@ class _BaseChat:
     """Curated history is the set of valid turns that will be used in the subsequent send requests.
     """
 
-
-  def record_history(self, user_input: Content,
-                     model_output: list[Content],
-                     automatic_function_calling_history: list[Content],
-                     is_valid: bool):
+  def record_history(
+      self,
+      user_input: Content,
+      model_output: list[Content],
+      automatic_function_calling_history: list[Content],
+      is_valid: bool,
+  ):
     """Records the chat history.
 
     Maintaining both comprehensive and curated histories.
 
     Args:
       user_input: The user's input content.
-      model_output: A list of `Content` from the model's response.
-        This can be an empty list if the model produced no output.
-      automatic_function_calling_history: A list of `Content` representing
-        the history of automatic function calls, including the user input as
-        the first entry.
+      model_output: A list of `Content` from the model's response. This can be
+        an empty list if the model produced no output.
+      automatic_function_calling_history: A list of `Content` representing the
+        history of automatic function calls, including the user input as the
+        first entry.
       is_valid: A boolean flag indicating whether the current model output is
         considered valid.
     """
     input_contents = (
-        automatic_function_calling_history
+        # Because the AFC input contains the entire curated chat history in
+        # addition to the new user input, we need to truncate the AFC history
+        # to deduplicate the existing chat history.
+        automatic_function_calling_history[len(self._curated_history):]
         if automatic_function_calling_history
         else [user_input]
     )
@@ -158,14 +167,13 @@ class _BaseChat:
       self._curated_history.extend(input_contents)
       self._curated_history.extend(output_contents)
 
-
   def get_history(self, curated: bool = False) -> list[Content]:
     """Returns the chat history.
 
     Args:
-        curated: A boolean flag indicating whether to return the curated
-            (valid) history or the comprehensive (all turns) history.
-            Defaults to False (returns the comprehensive history).
+        curated: A boolean flag indicating whether to return the curated (valid)
+          history or the comprehensive (all turns) history. Defaults to False
+          (returns the comprehensive history).
 
     Returns:
         A list of `Content` objects representing the chat history.
@@ -176,9 +184,41 @@ class _BaseChat:
       return self._comprehensive_history
 
 
+def _is_part_type(
+    contents: Union[list[PartUnionDict], PartUnionDict],
+) -> TypeGuard[t.ContentType]:
+  if isinstance(contents, list):
+    return all(_is_part_type(part) for part in contents)
+  else:
+    allowed_part_types = get_args(types.PartUnion)
+    if type(contents) in allowed_part_types:
+      return True
+    else:
+      # Some images don't pass isinstance(item, PIL.Image.Image)
+      # For example <class 'PIL.JpegImagePlugin.JpegImageFile'>
+      if types.PIL_Image is not None and isinstance(contents, types.PIL_Image):
+        return True
+    return False
+
+
 class Chat(_BaseChat):
   """Chat session."""
 
+  def __init__(
+      self,
+      *,
+      modules: Models,
+      model: str,
+      config: Optional[GenerateContentConfigOrDict] = None,
+      history: list[Content],
+  ):
+    self._modules = modules
+    super().__init__(
+        model=model,
+        config=config,
+        history=history,
+    )
+
   def send_message(
       self,
       message: Union[list[PartUnionDict], PartUnionDict],
@@ -202,10 +242,15 @@ class Chat(_BaseChat):
       response = chat.send_message('tell me a story')
     """
 
+    if not _is_part_type(message):
+      raise ValueError(
+          f"Message must be a valid part type: {types.PartUnion} or"
+          f" {types.PartUnionDict}, got {type(message)}"
+      )
     input_content = t.t_content(self._modules._api_client, message)
     response = self._modules.generate_content(
         model=self._model,
-        contents=self._curated_history + [input_content],
+        contents=self._curated_history + [input_content],  # type: ignore[arg-type]
         config=config if config else self._config,
     )
     model_output = (
@@ -213,10 +258,15 @@ class Chat(_BaseChat):
         if response.candidates and response.candidates[0].content
         else []
     )
+    automatic_function_calling_history = (
+        response.automatic_function_calling_history
+        if response.automatic_function_calling_history
+        else []
+    )
     self.record_history(
         user_input=input_content,
         model_output=model_output,
-        automatic_function_calling_history=response.automatic_function_calling_history,
+        automatic_function_calling_history=automatic_function_calling_history,
         is_valid=_validate_response(response),
     )
     return response
@@ -245,29 +295,42 @@ class Chat(_BaseChat):
         print(chunk.text)
     """
 
+    if not _is_part_type(message):
+      raise ValueError(
+          f"Message must be a valid part type: {types.PartUnion} or"
+          f" {types.PartUnionDict}, got {type(message)}"
+      )
     input_content = t.t_content(self._modules._api_client, message)
     output_contents = []
     finish_reason = None
     is_valid = True
     chunk = None
-    for chunk in self._modules.generate_content_stream(
-        model=self._model,
-        contents=self._curated_history + [input_content],
-        config=config if config else self._config,
-    ):
-      if not _validate_response(chunk):
-        is_valid = False
-      if chunk.candidates and chunk.candidates[0].content:
-        output_contents.append(chunk.candidates[0].content)
-      if chunk.candidates and chunk.candidates[0].finish_reason:
-        finish_reason = chunk.candidates[0].finish_reason
-      yield chunk
-    self.record_history(
-        user_input=input_content,
-        model_output=output_contents,
-        automatic_function_calling_history=chunk.automatic_function_calling_history,
-        is_valid=is_valid and output_contents and finish_reason,
-    )
+    if isinstance(self._modules, Models):
+      for chunk in self._modules.generate_content_stream(
+          model=self._model,
+          contents=self._curated_history + [input_content],  # type: ignore[arg-type]
+          config=config if config else self._config,
+      ):
+        if not _validate_response(chunk):
+          is_valid = False
+        if chunk.candidates and chunk.candidates[0].content:
+          output_contents.append(chunk.candidates[0].content)
+        if chunk.candidates and chunk.candidates[0].finish_reason:
+          finish_reason = chunk.candidates[0].finish_reason
+        yield chunk
+      automatic_function_calling_history = (
+          chunk.automatic_function_calling_history
+          if chunk.automatic_function_calling_history
+          else []
+      )
+      self.record_history(
+          user_input=input_content,
+          model_output=output_contents,
+          automatic_function_calling_history=automatic_function_calling_history,
+          is_valid=is_valid
+          and output_contents is not None
+          and finish_reason is not None,
+      )
 
 
 class Chats:
@@ -304,6 +367,21 @@ class Chats:
 class AsyncChat(_BaseChat):
   """Async chat session."""
 
+  def __init__(
+      self,
+      *,
+      modules: AsyncModels,
+      model: str,
+      config: Optional[GenerateContentConfigOrDict] = None,
+      history: list[Content],
+  ):
+    self._modules = modules
+    super().__init__(
+        model=model,
+        config=config,
+        history=history,
+    )
+
   async def send_message(
       self,
       message: Union[list[PartUnionDict], PartUnionDict],
@@ -326,11 +404,15 @@ class AsyncChat(_BaseChat):
       chat = client.aio.chats.create(model='gemini-1.5-flash')
       response = await chat.send_message('tell me a story')
     """
-
+    if not _is_part_type(message):
+      raise ValueError(
+          f"Message must be a valid part type: {types.PartUnion} or"
+          f" {types.PartUnionDict}, got {type(message)}"
+      )
     input_content = t.t_content(self._modules._api_client, message)
     response = await self._modules.generate_content(
         model=self._model,
-        contents=self._curated_history + [input_content],
+        contents=self._curated_history + [input_content],  # type: ignore[arg-type]
         config=config if config else self._config,
     )
     model_output = (
@@ -338,10 +420,15 @@ class AsyncChat(_BaseChat):
         if response.candidates and response.candidates[0].content
         else []
     )
+    automatic_function_calling_history = (
+        response.automatic_function_calling_history
+        if response.automatic_function_calling_history
+        else []
+    )
     self.record_history(
         user_input=input_content,
         model_output=model_output,
-        automatic_function_calling_history=response.automatic_function_calling_history,
+        automatic_function_calling_history=automatic_function_calling_history,
         is_valid=_validate_response(response),
     )
     return response
@@ -369,6 +456,11 @@ class AsyncChat(_BaseChat):
         print(chunk.text)
     """
 
+    if not _is_part_type(message):
+      raise ValueError(
+          f"Message must be a valid part type: {types.PartUnion} or"
+          f" {types.PartUnionDict}, got {type(message)}"
+      )
     input_content = t.t_content(self._modules._api_client, message)
 
     async def async_generator():
@@ -394,7 +486,6 @@ class AsyncChat(_BaseChat):
           model_output=output_contents,
           automatic_function_calling_history=chunk.automatic_function_calling_history,
           is_valid=is_valid and output_contents and finish_reason,
-
       )
     return async_generator()
 

google/genai/files.py

@@ -888,13 +888,13 @@ class Files(_api_module.BaseModule):
 
     if (
         response.http_headers is None
-        or 'X-Goog-Upload-URL' not in response.http_headers
+        or 'x-goog-upload-url' not in response.http_headers
     ):
       raise KeyError(
           'Failed to create file. Upload URL did not returned from the create'
           ' file request.'
       )
-    upload_url = response.http_headers['X-Goog-Upload-URL']
+    upload_url = response.http_headers['x-goog-upload-url']
 
     if isinstance(file, io.IOBase):
       return_file = self._api_client.upload_file(

google/genai/models.py

@@ -4605,7 +4605,7 @@ class Models(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
-  def edit_image(
+  def _edit_image(
       self,
       *,
       model: str,
@@ -5558,6 +5558,62 @@ class Models(_api_module.BaseModule):
       automatic_function_calling_history.append(func_call_content)
       automatic_function_calling_history.append(func_response_content)
 
+  def edit_image(
+      self,
+      *,
+      model: str,
+      prompt: str,
+      reference_images: list[types._ReferenceImageAPIOrDict],
+      config: Optional[types.EditImageConfigOrDict] = None,
+  ) -> types.EditImageResponse:
+    """Edits an image based on a text description and configuration.
+
+    Args:
+      model (str): The model to use.
+      prompt (str): A text description of the edit to apply to the image.
+        reference_images (list[Union[RawReferenceImage, MaskReferenceImage,
+        ControlReferenceImage, StyleReferenceImage, SubjectReferenceImage]): The
+        reference images for editing.
+      config (EditImageConfig): Configuration for editing.
+
+    Usage:
+
+    .. code-block:: python
+
+      from google.genai.types import RawReferenceImage, MaskReferenceImage
+
+      raw_ref_image = RawReferenceImage(
+        reference_id=1,
+        reference_image=types.Image.from_file(IMAGE_FILE_PATH),
+      )
+
+      mask_ref_image = MaskReferenceImage(
+        reference_id=2,
+        config=types.MaskReferenceConfig(
+            mask_mode='MASK_MODE_FOREGROUND',
+            mask_dilation=0.06,
+        ),
+      )
+      response = client.models.edit_image(
+        model='imagen-3.0-capability-001',
+        prompt='man with dog',
+        reference_images=[raw_ref_image, mask_ref_image],
+        config=types.EditImageConfig(
+            edit_mode= "EDIT_MODE_INPAINT_INSERTION",
+            number_of_images= 1,
+            include_rai_reason= True,
+        )
+      )
+      response.generated_images[0].image.show()
+      # Shows a man with a dog instead of a cat.
+    """
+    return self._edit_image(
+        model=model,
+        prompt=prompt,
+        reference_images=reference_images,
+        config=config,
+    )
+
   def upscale_image(
       self,
       *,
@@ -5990,7 +6046,7 @@ class AsyncModels(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
-  async def edit_image(
+  async def _edit_image(
       self,
       *,
       model: str,
@@ -6923,6 +6979,62 @@ class AsyncModels(_api_module.BaseModule):
 
     return async_generator(model, contents, config)
 
+  async def edit_image(
+      self,
+      *,
+      model: str,
+      prompt: str,
+      reference_images: list[types._ReferenceImageAPIOrDict],
+      config: Optional[types.EditImageConfigOrDict] = None,
+  ) -> types.EditImageResponse:
+    """Edits an image based on a text description and configuration.
+
+    Args:
+      model (str): The model to use.
+      prompt (str): A text description of the edit to apply to the image.
+        reference_images (list[Union[RawReferenceImage, MaskReferenceImage,
+        ControlReferenceImage, StyleReferenceImage, SubjectReferenceImage]): The
+        reference images for editing.
+      config (EditImageConfig): Configuration for editing.
+
+    Usage:
+
+    .. code-block:: python
+
+      from google.genai.types import RawReferenceImage, MaskReferenceImage
+
+      raw_ref_image = RawReferenceImage(
+        reference_id=1,
+        reference_image=types.Image.from_file(IMAGE_FILE_PATH),
+      )
+
+      mask_ref_image = MaskReferenceImage(
+        reference_id=2,
+        config=types.MaskReferenceConfig(
+            mask_mode='MASK_MODE_FOREGROUND',
+            mask_dilation=0.06,
+        ),
+      )
+      response = await client.aio.models.edit_image(
+        model='imagen-3.0-capability-001',
+        prompt='man with dog',
+        reference_images=[raw_ref_image, mask_ref_image],
+        config=types.EditImageConfig(
+            edit_mode= "EDIT_MODE_INPAINT_INSERTION",
+            number_of_images= 1,
+            include_rai_reason= True,
+        )
+      )
+      response.generated_images[0].image.show()
+      # Shows a man with a dog instead of a cat.
+    """
+    return await self._edit_image(
+        model=model,
+        prompt=prompt,
+        reference_images=reference_images,
+        config=config,
+    )
+
   async def list(
       self,
       *,

google/genai/version.py

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

{google_genai-1.6.0.dist-info → google_genai-1.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: google-genai
-Version: 1.6.0
+Version: 1.7.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache-2.0
@@ -25,7 +25,7 @@ Requires-Dist: google-auth<3.0.0,>=2.14.1
 Requires-Dist: httpx<1.0.0,>=0.28.1
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: requests<3.0.0,>=2.28.1
-Requires-Dist: websockets<15.0.0,>=13.0.0
+Requires-Dist: websockets<15.1.0,>=13.0.0
 Requires-Dist: typing-extensions<5.0.0,>=4.11.0
 
 # Google Gen AI SDK
@@ -41,7 +41,7 @@ Google Gen AI Python SDK provides an interface for developers to integrate Googl
 
 ## Installation
 
-```cmd
+```sh
 pip install google-genai
 ```
 
@@ -72,16 +72,16 @@ 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.
+Configuration setup instructions depends on whether you're using the Gemini
+Developer API or the Gemini API in Vertex AI.
 
-**ML Dev Gemini API:** Set `GOOGLE_API_KEY` as shown below:
+**Gemini Developer 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`
+**Gemini API on Vertex AI:** Set `GOOGLE_GENAI_USE_VERTEXAI`, `GOOGLE_CLOUD_PROJECT`
 and `GOOGLE_CLOUD_LOCATION`, as shown below:
 
 ```bash
@@ -142,7 +142,7 @@ response = client.models.generate_content(
 print(response.text)
 ```
 
-#### with uploaded file (Gemini API only)
+#### with uploaded file (Gemini Developer API only)
 download the file in console.
 
 ```sh
@@ -347,6 +347,7 @@ The SDK will convert the list of parts into a content with a `user` role
 ```
 
 ##### Mix types in contents
+
 You can also provide a list of `types.ContentUnion`. The SDK leaves items of
 `types.Content` as is, it groups consecutive non function call parts into a
 single `types.UserContent`, and it groups consecutive function call parts into

{google_genai-1.6.0.dist-info → google_genai-1.7.0.dist-info}/RECORD

@@ -1,27 +1,27 @@
 google/genai/__init__.py,sha256=IYw-PcsdgjSpS1mU_ZcYkTfPocsJ4aVmrDxP7vX7c6Y,709
-google/genai/_api_client.py,sha256=xEme7KhIrp5lCDlde_HECGzH4TppepR8YraSDiGvhPc,30593
+google/genai/_api_client.py,sha256=X-ULRU6ZfI6WPsWFj3SG_6xncnjj6kK9DtUguReMzbE,31280
 google/genai/_api_module.py,sha256=66FsFq9N8PdTegDyx3am3NHpI0Bw7HBmifUMCrZsx_Q,902
 google/genai/_automatic_function_calling_util.py,sha256=xAH-96LIEmC-yefEIae8TrBPZZAI1UJrn0bAIZsISDE,10899
-google/genai/_common.py,sha256=u0qX3Uli_7qaYmoTZm9JnVzoMihD4ASPksmqmsjGSBs,10071
+google/genai/_common.py,sha256=PNwxVUKCD93ICHJlwCTAItGH3Wjva5xHC7_7mc-p8oA,10153
 google/genai/_extra_utils.py,sha256=l9U0uaq4TWdfY7fOpGR3LcsA6-TMEblfQlEXdC0IGPY,12462
-google/genai/_replay_api_client.py,sha256=OxZIAyyyI4D9uj0avNO0QGf4DPWJ4Pqf_MCbUs5pvYc,18459
+google/genai/_replay_api_client.py,sha256=_TH5E_hBu35hOJajjpUagsdhiBAbOTWWZDyP43bDjJE,18606
 google/genai/_test_api_client.py,sha256=XNOWq8AkYbqInv1aljNGlFXsv8slQIWTYy_hdcCetD0,4797
 google/genai/_transformers.py,sha256=9cVaRp1zLOG27D7iNJeW2rw2jbjlvuEUeVl5SUN6ljY,29863
 google/genai/batches.py,sha256=K6RgkNWkYBjknADWe4hrv6BtXxWTl1N8b91Pg9MUnAc,41545
 google/genai/caches.py,sha256=JymnKSaSZYGyTl201tR8PgbZF6fRKdXuCKe4BILKkTc,57551
-google/genai/chats.py,sha256=ds5iF4hqvyHbHE4OlP1b5s93SwD0hlMNpWxT7db2E48,13493
+google/genai/chats.py,sha256=uv75f2uWa2cjgkZINCS9SYEH120hM61aZU8Ylcawuec,16379
 google/genai/client.py,sha256=jN4oNT5qQtX0UILuGcZqxmIL66DOJ-T5P086ygnSnSg,9877
 google/genai/errors.py,sha256=p_JbOU_eDKIIvWT6NBYGpZcxww622ChAi6eX1FuKKY0,3874
-google/genai/files.py,sha256=N9TQYyuHRQm4Gb2agjyOlWFljwK-hdPUr-mP0vF0Bc8,45532
+google/genai/files.py,sha256=po136tfi5tRmMXG01S-NgxDwX-IpzPaXS9cJBWUwxUU,45532
 google/genai/live.py,sha256=Ftj_LxQ2zClK-2hbdRZNXkmnQQguduoNyVntIdPtTdM,32033
-google/genai/models.py,sha256=1ZlRfRqEl2OvaMvU1nIosGhX7g35A-hupUkrAYqwRpg,210141
+google/genai/models.py,sha256=3Y0r-0jRP0AN6iU_k7in05u9N9R2ieUtvzc4qfXbWBY,213651
 google/genai/operations.py,sha256=Tvlbk_AuQyXGL9b0wJbzgC8QGHGLSVjb1evbe-ZuZN0,20781
 google/genai/pagers.py,sha256=1jxDjre7M_Udt0ntgOr_79iR0-axjdr_Q6tZZzVRli8,6784
 google/genai/tunings.py,sha256=2tWvIkofDDnt6VPsfHAbcrfDIo7jAbIlpdwcx6-cUvM,48239
 google/genai/types.py,sha256=sVOdjxmviV_oA5JQEKKOlg4nwrlTQjbWGqtgqQACP6Y,299883
-google/genai/version.py,sha256=5_cjSe7IVSPjk4bpIyj-Lx9SCIXuPbulXr4yMMQgdT8,626
-google_genai-1.6.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-google_genai-1.6.0.dist-info/METADATA,sha256=_zLVCqlXM9ZDEOPgINpGTkytCEN8pFJ_7Gg4DyPKpJQ,32842
-google_genai-1.6.0.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-google_genai-1.6.0.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
-google_genai-1.6.0.dist-info/RECORD,,
+google/genai/version.py,sha256=gMEV9Q_hiFtL9MTW8j-xSs_8ZfrVk5l9IpAHot0qkCA,626
+google_genai-1.7.0.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+google_genai-1.7.0.dist-info/METADATA,sha256=DrE2OdIur-Cpp82AkcRds2mFxYbDEYjtWXXseRSM6wY,32868
+google_genai-1.7.0.dist-info/WHEEL,sha256=beeZ86-EfXScwlR_HKu4SllMC9wUEj_8Z_4FJ3egI2w,91
+google_genai-1.7.0.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
+google_genai-1.7.0.dist-info/RECORD,,

{google_genai-1.6.0.dist-info → google_genai-1.7.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (76.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any