google-genai 1.32.0__py3-none-any.whl → 1.34.0__py3-none-any.whl

google/genai/caches.py

@@ -84,6 +84,23 @@ def _FileData_to_mldev(
   return to_object
 
 
+def _FunctionCall_to_mldev(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['id']) is not None:
+    setv(to_object, ['id'], getv(from_object, ['id']))
+
+  if getv(from_object, ['args']) is not None:
+    setv(to_object, ['args'], getv(from_object, ['args']))
+
+  if getv(from_object, ['name']) is not None:
+    setv(to_object, ['name'], getv(from_object, ['name']))
+
+  return to_object
+
+
 def _Part_to_mldev(
     from_object: Union[dict[str, Any], object],
     parent_object: Optional[dict[str, Any]] = None,
@@ -122,6 +139,13 @@ def _Part_to_mldev(
         getv(from_object, ['thought_signature']),
     )
 
+  if getv(from_object, ['function_call']) is not None:
+    setv(
+        to_object,
+        ['functionCall'],
+        _FunctionCall_to_mldev(getv(from_object, ['function_call']), to_object),
+    )
+
   if getv(from_object, ['code_execution_result']) is not None:
     setv(
         to_object,
@@ -132,9 +156,6 @@ def _Part_to_mldev(
   if getv(from_object, ['executable_code']) is not None:
     setv(to_object, ['executableCode'], getv(from_object, ['executable_code']))
 
-  if getv(from_object, ['function_call']) is not None:
-    setv(to_object, ['functionCall'], getv(from_object, ['function_call']))
-
   if getv(from_object, ['function_response']) is not None:
     setv(
         to_object,
@@ -684,6 +705,23 @@ def _FileData_to_vertex(
   return to_object
 
 
+def _FunctionCall_to_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['id']) is not None:
+    raise ValueError('id parameter is not supported in Vertex AI.')
+
+  if getv(from_object, ['args']) is not None:
+    setv(to_object, ['args'], getv(from_object, ['args']))
+
+  if getv(from_object, ['name']) is not None:
+    setv(to_object, ['name'], getv(from_object, ['name']))
+
+  return to_object
+
+
 def _Part_to_vertex(
     from_object: Union[dict[str, Any], object],
     parent_object: Optional[dict[str, Any]] = None,
@@ -722,6 +760,15 @@ def _Part_to_vertex(
         getv(from_object, ['thought_signature']),
     )
 
+  if getv(from_object, ['function_call']) is not None:
+    setv(
+        to_object,
+        ['functionCall'],
+        _FunctionCall_to_vertex(
+            getv(from_object, ['function_call']), to_object
+        ),
+    )
+
   if getv(from_object, ['code_execution_result']) is not None:
     setv(
         to_object,
@@ -732,9 +779,6 @@ def _Part_to_vertex(
   if getv(from_object, ['executable_code']) is not None:
     setv(to_object, ['executableCode'], getv(from_object, ['executable_code']))
 
-  if getv(from_object, ['function_call']) is not None:
-    setv(to_object, ['functionCall'], getv(from_object, ['function_call']))
-
   if getv(from_object, ['function_response']) is not None:
     setv(
         to_object,

google/genai/files.py

@@ -434,6 +434,7 @@ class Files(_api_module.BaseModule):
         config, 'should_return_http_response', None
     ):
       return_value = types.CreateFileResponse(sdk_http_response=response)
+      self._api_client._verify_response(return_value)
       return return_value
 
     response_dict = '' if not response.body else json.loads(response.body)
@@ -916,6 +917,7 @@ class AsyncFiles(_api_module.BaseModule):
         config, 'should_return_http_response', None
     ):
       return_value = types.CreateFileResponse(sdk_http_response=response)
+      self._api_client._verify_response(return_value)
       return return_value
 
     response_dict = '' if not response.body else json.loads(response.body)

google/genai/local_tokenizer.py

@@ -303,9 +303,20 @@ class LocalTokenizer:
 
     Args:
       contents: The contents to tokenize.
+      config: The configuration for counting tokens.
 
     Returns:
       A `CountTokensResult` containing the total number of tokens.
+
+    Usage:
+
+    .. code-block:: python
+
+      from google import genai
+      tokenizer = genai.LocalTokenizer(model_name='gemini-2.0-flash-001')
+      result = tokenizer.count_tokens("What is your name?")
+      print(result)
+      # total_tokens=5
     """
     processed_contents = t.t_contents(contents)
     text_accumulator = _TextsAccumulator()
@@ -330,7 +341,24 @@ class LocalTokenizer:
       self,
       contents: Union[types.ContentListUnion, types.ContentListUnionDict],
   ) -> types.ComputeTokensResult:
-    """Computes the tokens ids and string pieces in the input."""
+    """Computes the tokens ids and string pieces in the input.
+
+    Args:
+      contents: The contents to tokenize.
+
+    Returns:
+      A `ComputeTokensResult` containing the token information.
+
+    Usage:
+
+    .. code-block:: python
+
+      from google import genai
+      tokenizer = genai.LocalTokenizer(model_name='gemini-2.0-flash-001')
+      result = tokenizer.compute_tokens("What is your name?")
+      print(result)
+      # tokens_info=[TokensInfo(token_ids=[279, 329, 1313, 2508, 13], tokens=[b' What', b' is', b' your', b' name', b'?'], role='user')]
+    """
     processed_contents = t.t_contents(contents)
     text_accumulator = _TextsAccumulator()
     for content in processed_contents:

google/genai/models.py

@@ -88,6 +88,23 @@ def _FileData_to_mldev(
   return to_object
 
 
+def _FunctionCall_to_mldev(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['id']) is not None:
+    setv(to_object, ['id'], getv(from_object, ['id']))
+
+  if getv(from_object, ['args']) is not None:
+    setv(to_object, ['args'], getv(from_object, ['args']))
+
+  if getv(from_object, ['name']) is not None:
+    setv(to_object, ['name'], getv(from_object, ['name']))
+
+  return to_object
+
+
 def _Part_to_mldev(
     from_object: Union[dict[str, Any], object],
     parent_object: Optional[dict[str, Any]] = None,
@@ -126,6 +143,13 @@ def _Part_to_mldev(
         getv(from_object, ['thought_signature']),
     )
 
+  if getv(from_object, ['function_call']) is not None:
+    setv(
+        to_object,
+        ['functionCall'],
+        _FunctionCall_to_mldev(getv(from_object, ['function_call']), to_object),
+    )
+
   if getv(from_object, ['code_execution_result']) is not None:
     setv(
         to_object,
@@ -136,9 +160,6 @@ def _Part_to_mldev(
   if getv(from_object, ['executable_code']) is not None:
     setv(to_object, ['executableCode'], getv(from_object, ['executable_code']))
 
-  if getv(from_object, ['function_call']) is not None:
-    setv(to_object, ['functionCall'], getv(from_object, ['function_call']))
-
   if getv(from_object, ['function_response']) is not None:
     setv(
         to_object,
@@ -1330,7 +1351,11 @@ def _GenerateVideosConfig_to_mldev(
     )
 
   if getv(from_object, ['resolution']) is not None:
-    raise ValueError('resolution parameter is not supported in Gemini API.')
+    setv(
+        parent_object,
+        ['parameters', 'resolution'],
+        getv(from_object, ['resolution']),
+    )
 
   if getv(from_object, ['person_generation']) is not None:
     setv(
@@ -1473,6 +1498,23 @@ def _FileData_to_vertex(
   return to_object
 
 
+def _FunctionCall_to_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['id']) is not None:
+    raise ValueError('id parameter is not supported in Vertex AI.')
+
+  if getv(from_object, ['args']) is not None:
+    setv(to_object, ['args'], getv(from_object, ['args']))
+
+  if getv(from_object, ['name']) is not None:
+    setv(to_object, ['name'], getv(from_object, ['name']))
+
+  return to_object
+
+
 def _Part_to_vertex(
     from_object: Union[dict[str, Any], object],
     parent_object: Optional[dict[str, Any]] = None,
@@ -1511,6 +1553,15 @@ def _Part_to_vertex(
         getv(from_object, ['thought_signature']),
     )
 
+  if getv(from_object, ['function_call']) is not None:
+    setv(
+        to_object,
+        ['functionCall'],
+        _FunctionCall_to_vertex(
+            getv(from_object, ['function_call']), to_object
+        ),
+    )
+
   if getv(from_object, ['code_execution_result']) is not None:
     setv(
         to_object,
@@ -1521,9 +1572,6 @@ def _Part_to_vertex(
   if getv(from_object, ['executable_code']) is not None:
     setv(to_object, ['executableCode'], getv(from_object, ['executable_code']))
 
-  if getv(from_object, ['function_call']) is not None:
-    setv(to_object, ['functionCall'], getv(from_object, ['function_call']))
-
   if getv(from_object, ['function_response']) is not None:
     setv(
         to_object,
@@ -3710,6 +3758,23 @@ def _FileData_from_mldev(
   return to_object
 
 
+def _FunctionCall_from_mldev(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['id']) is not None:
+    setv(to_object, ['id'], getv(from_object, ['id']))
+
+  if getv(from_object, ['args']) is not None:
+    setv(to_object, ['args'], getv(from_object, ['args']))
+
+  if getv(from_object, ['name']) is not None:
+    setv(to_object, ['name'], getv(from_object, ['name']))
+
+  return to_object
+
+
 def _Part_from_mldev(
     from_object: Union[dict[str, Any], object],
     parent_object: Optional[dict[str, Any]] = None,
@@ -3748,6 +3813,15 @@ def _Part_from_mldev(
         getv(from_object, ['thoughtSignature']),
     )
 
+  if getv(from_object, ['functionCall']) is not None:
+    setv(
+        to_object,
+        ['function_call'],
+        _FunctionCall_from_mldev(
+            getv(from_object, ['functionCall']), to_object
+        ),
+    )
+
   if getv(from_object, ['codeExecutionResult']) is not None:
     setv(
         to_object,
@@ -3758,9 +3832,6 @@ def _Part_from_mldev(
   if getv(from_object, ['executableCode']) is not None:
     setv(to_object, ['executable_code'], getv(from_object, ['executableCode']))
 
-  if getv(from_object, ['functionCall']) is not None:
-    setv(to_object, ['function_call'], getv(from_object, ['functionCall']))
-
   if getv(from_object, ['functionResponse']) is not None:
     setv(
         to_object,
@@ -4372,6 +4443,21 @@ def _FileData_from_vertex(
   return to_object
 
 
+def _FunctionCall_from_vertex(
+    from_object: Union[dict[str, Any], object],
+    parent_object: Optional[dict[str, Any]] = None,
+) -> dict[str, Any]:
+  to_object: dict[str, Any] = {}
+
+  if getv(from_object, ['args']) is not None:
+    setv(to_object, ['args'], getv(from_object, ['args']))
+
+  if getv(from_object, ['name']) is not None:
+    setv(to_object, ['name'], getv(from_object, ['name']))
+
+  return to_object
+
+
 def _Part_from_vertex(
     from_object: Union[dict[str, Any], object],
     parent_object: Optional[dict[str, Any]] = None,
@@ -4410,6 +4496,15 @@ def _Part_from_vertex(
         getv(from_object, ['thoughtSignature']),
     )
 
+  if getv(from_object, ['functionCall']) is not None:
+    setv(
+        to_object,
+        ['function_call'],
+        _FunctionCall_from_vertex(
+            getv(from_object, ['functionCall']), to_object
+        ),
+    )
+
   if getv(from_object, ['codeExecutionResult']) is not None:
     setv(
         to_object,
@@ -4420,9 +4515,6 @@ def _Part_from_vertex(
   if getv(from_object, ['executableCode']) is not None:
     setv(to_object, ['executable_code'], getv(from_object, ['executableCode']))
 
-  if getv(from_object, ['functionCall']) is not None:
-    setv(to_object, ['function_call'], getv(from_object, ['functionCall']))
-
   if getv(from_object, ['functionResponse']) is not None:
     setv(
         to_object,
@@ -5256,6 +5348,13 @@ class Models(_api_module.BaseModule):
         'post', path, request_dict, http_options
     )
 
+    if config is not None and getattr(
+        config, 'should_return_http_response', None
+    ):
+      return_value = types.GenerateContentResponse(sdk_http_response=response)
+      self._api_client._verify_response(return_value)
+      return return_value
+
     response_dict = '' if not response.body else json.loads(response.body)
 
     if self._api_client.vertexai:
@@ -5455,13 +5554,7 @@ class Models(_api_module.BaseModule):
       prompt: str,
       config: Optional[types.GenerateImagesConfigOrDict] = None,
   ) -> types.GenerateImagesResponse:
-    """Generates images based on a text description and configuration.
-
-    Args:
-      model (str): The model to use.
-      prompt (str): A text description of the images to generate.
-      config (GenerateImagesConfig): Configuration for generation.
-    """
+    """Private method for generating images."""
 
     parameter_model = types._GenerateImagesParameters(
         model=model,
@@ -5534,47 +5627,7 @@ class Models(_api_module.BaseModule):
       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.
-    """
+    """Private method for editing an image."""
 
     parameter_model = types._EditImageParameters(
         model=model,
@@ -5638,14 +5691,7 @@ class Models(_api_module.BaseModule):
       upscale_factor: str,
       config: Optional[types._UpscaleImageAPIConfigOrDict] = None,
   ) -> types.UpscaleImageResponse:
-    """Upscales an image.
-
-    Args:
-      model (str): The model to use.
-      image (Image): The input image for upscaling.
-      upscale_factor (str): The factor to upscale the image (x2 or x4).
-      config (_UpscaleImageAPIConfig): Configuration for upscaling.
-    """
+    """Private method for upscaling an image."""
 
     parameter_model = types._UpscaleImageAPIParameters(
         model=model,
@@ -6331,39 +6377,7 @@ class Models(_api_module.BaseModule):
       source: Optional[types.GenerateVideosSourceOrDict] = None,
       config: Optional[types.GenerateVideosConfigOrDict] = None,
   ) -> types.GenerateVideosOperation:
-    """Generates videos based on an input (text, image, or video) and configuration.
-
-    The following use cases are supported:
-    1. Text to video generation.
-    2a. Image to video generation (additional text prompt is optional).
-    2b. Image to video generation with frame interpolation (specify last_frame
-    in config).
-    3. Video extension (additional text prompt is optional)
-
-    Args:
-      model: The model to use.
-      prompt: The text prompt for generating the videos. Optional for image to
-        video and video extension use cases.
-      image: The input image for generating the videos. Optional if prompt is
-        provided.
-      video: The input video for video extension use cases. Optional if prompt
-        or image is provided.
-      config: Configuration for generation.
-
-    Usage:
-
-      ```
-      operation = client.models.generate_videos(
-          model="veo-2.0-generate-001",
-          prompt="A neon hologram of a cat driving at top speed",
-      )
-      while not operation.done:
-          time.sleep(10)
-          operation = client.operations.get(operation)
-
-      operation.result.generated_videos[0].video.uri
-      ```
-    """
+    """Private method for generating videos."""
 
     parameter_model = types._GenerateVideosParameters(
         model=model,
@@ -7081,6 +7095,13 @@ class AsyncModels(_api_module.BaseModule):
         'post', path, request_dict, http_options
     )
 
+    if config is not None and getattr(
+        config, 'should_return_http_response', None
+    ):
+      return_value = types.GenerateContentResponse(sdk_http_response=response)
+      self._api_client._verify_response(return_value)
+      return return_value
+
     response_dict = '' if not response.body else json.loads(response.body)
 
     if self._api_client.vertexai:
@@ -7285,13 +7306,7 @@ class AsyncModels(_api_module.BaseModule):
       prompt: str,
       config: Optional[types.GenerateImagesConfigOrDict] = None,
   ) -> types.GenerateImagesResponse:
-    """Generates images based on a text description and configuration.
-
-    Args:
-      model (str): The model to use.
-      prompt (str): A text description of the images to generate.
-      config (GenerateImagesConfig): Configuration for generation.
-    """
+    """Private method for generating images asynchronously."""
 
     parameter_model = types._GenerateImagesParameters(
         model=model,
@@ -7364,47 +7379,7 @@ class AsyncModels(_api_module.BaseModule):
       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.
-    """
+    """Private method for editing an image asynchronously."""
 
     parameter_model = types._EditImageParameters(
         model=model,
@@ -7468,14 +7443,7 @@ class AsyncModels(_api_module.BaseModule):
       upscale_factor: str,
       config: Optional[types._UpscaleImageAPIConfigOrDict] = None,
   ) -> types.UpscaleImageResponse:
-    """Upscales an image.
-
-    Args:
-      model (str): The model to use.
-      image (Image): The input image for upscaling.
-      upscale_factor (str): The factor to upscale the image (x2 or x4).
-      config (_UpscaleImageAPIConfig): Configuration for upscaling.
-    """
+    """Private method for upscaling an image asynchronously."""
 
     parameter_model = types._UpscaleImageAPIParameters(
         model=model,
@@ -8167,39 +8135,7 @@ class AsyncModels(_api_module.BaseModule):
       source: Optional[types.GenerateVideosSourceOrDict] = None,
       config: Optional[types.GenerateVideosConfigOrDict] = None,
   ) -> types.GenerateVideosOperation:
-    """Generates videos based on an input (text, image, or video) and configuration.
-
-    The following use cases are supported:
-    1. Text to video generation.
-    2a. Image to video generation (additional text prompt is optional).
-    2b. Image to video generation with frame interpolation (specify last_frame
-    in config).
-    3. Video extension (additional text prompt is optional)
-
-    Args:
-      model: The model to use.
-      prompt: The text prompt for generating the videos. Optional for image to
-        video and video extension use cases.
-      image: The input image for generating the videos. Optional if prompt is
-        provided.
-      video: The input video for video extension use cases. Optional if prompt
-        or image is provided.
-      config: Configuration for generation.
-
-    Usage:
-
-      ```
-      operation = client.models.generate_videos(
-          model="veo-2.0-generate-001",
-          prompt="A neon hologram of a cat driving at top speed",
-      )
-      while not operation.done:
-          time.sleep(10)
-          operation = client.operations.get(operation)
-
-      operation.result.generated_videos[0].video.uri
-      ```
-    """
+    """Private method for generating videos asynchronously."""
 
     parameter_model = types._GenerateVideosParameters(
         model=model,