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

google/genai/types.py

@@ -19,7 +19,6 @@ from abc import ABC, abstractmethod
 import datetime
 from enum import Enum, EnumMeta
 import inspect
-import io
 import json
 import logging
 import sys
@@ -576,7 +575,7 @@ class SubjectReferenceType(_common.CaseInSensitiveEnum):
 
 
 class EditMode(_common.CaseInSensitiveEnum):
-  """Enum representing the Imagen 3 Edit mode."""
+  """Enum representing the editing mode."""
 
   EDIT_MODE_DEFAULT = 'EDIT_MODE_DEFAULT'
   EDIT_MODE_INPAINT_REMOVAL = 'EDIT_MODE_INPAINT_REMOVAL'
@@ -824,20 +823,18 @@ class Blob(_common.BaseModel):
       description="""Required. The IANA standard MIME type of the source data.""",
   )
 
-  def as_image(self) -> Optional['PIL_Image']:
-    """Returns the Blob as a PIL Image, or None if the Blob is not an image."""
+  def as_image(self) -> Optional['Image']:
+    """Returns the Blob as a Image, or None if the Blob is not an image."""
     if (
         not self.data
         or not self.mime_type
         or not self.mime_type.startswith('image/')
     ):
       return None
-    if not _is_pillow_image_imported:
-      raise ImportError(
-          'The PIL module is not available. Please install the Pillow'
-          ' package. `pip install pillow`'
-      )
-    return PIL.Image.open(io.BytesIO(self.data))
+    return Image(
+        image_bytes=self.data,
+        mime_type=self.mime_type,
+    )
 
 
 class BlobDict(TypedDict, total=False):
@@ -888,6 +885,41 @@ class FileDataDict(TypedDict, total=False):
 FileDataOrDict = Union[FileData, FileDataDict]
 
 
+class FunctionCall(_common.BaseModel):
+  """A function call."""
+
+  id: Optional[str] = Field(
+      default=None,
+      description="""The unique id of the function call. If populated, the client to execute the
+   `function_call` and return the response with the matching `id`.""",
+  )
+  args: Optional[dict[str, Any]] = Field(
+      default=None,
+      description="""Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.""",
+  )
+  name: Optional[str] = Field(
+      default=None,
+      description="""Required. The name of the function to call. Matches [FunctionDeclaration.name].""",
+  )
+
+
+class FunctionCallDict(TypedDict, total=False):
+  """A function call."""
+
+  id: Optional[str]
+  """The unique id of the function call. If populated, the client to execute the
+   `function_call` and return the response with the matching `id`."""
+
+  args: Optional[dict[str, Any]]
+  """Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details."""
+
+  name: Optional[str]
+  """Required. The name of the function to call. Matches [FunctionDeclaration.name]."""
+
+
+FunctionCallOrDict = Union[FunctionCall, FunctionCallDict]
+
+
 class CodeExecutionResult(_common.BaseModel):
   """Result of executing the [ExecutableCode].
 
@@ -956,41 +988,6 @@ class ExecutableCodeDict(TypedDict, total=False):
 ExecutableCodeOrDict = Union[ExecutableCode, ExecutableCodeDict]
 
 
-class FunctionCall(_common.BaseModel):
-  """A function call."""
-
-  id: Optional[str] = Field(
-      default=None,
-      description="""The unique id of the function call. If populated, the client to execute the
-   `function_call` and return the response with the matching `id`.""",
-  )
-  args: Optional[dict[str, Any]] = Field(
-      default=None,
-      description="""Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details.""",
-  )
-  name: Optional[str] = Field(
-      default=None,
-      description="""Required. The name of the function to call. Matches [FunctionDeclaration.name].""",
-  )
-
-
-class FunctionCallDict(TypedDict, total=False):
-  """A function call."""
-
-  id: Optional[str]
-  """The unique id of the function call. If populated, the client to execute the
-   `function_call` and return the response with the matching `id`."""
-
-  args: Optional[dict[str, Any]]
-  """Optional. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details."""
-
-  name: Optional[str]
-  """Required. The name of the function to call. Matches [FunctionDeclaration.name]."""
-
-
-FunctionCallOrDict = Union[FunctionCall, FunctionCallDict]
-
-
 class FunctionResponse(_common.BaseModel):
   """A function response."""
 
@@ -1078,6 +1075,12 @@ class Part(_common.BaseModel):
       default=None,
       description="""An opaque signature for the thought so it can be reused in subsequent requests.""",
   )
+  function_call: Optional[FunctionCall] = Field(
+      default=None,
+      description="""A predicted [FunctionCall] returned from the model that contains a string
+      representing the [FunctionDeclaration.name] and a structured JSON object
+      containing the parameters and their values.""",
+  )
   code_execution_result: Optional[CodeExecutionResult] = Field(
       default=None,
       description="""Optional. Result of executing the [ExecutableCode].""",
@@ -1086,10 +1089,6 @@ class Part(_common.BaseModel):
       default=None,
       description="""Optional. Code generated by the model that is meant to be executed.""",
   )
-  function_call: Optional[FunctionCall] = Field(
-      default=None,
-      description="""Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.""",
-  )
   function_response: Optional[FunctionResponse] = Field(
       default=None,
       description="""Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.""",
@@ -1098,7 +1097,7 @@ class Part(_common.BaseModel):
       default=None, description="""Optional. Text part (can be code)."""
   )
 
-  def as_image(self) -> Optional['PIL_Image']:
+  def as_image(self) -> Optional['Image']:
     """Returns the part as a PIL Image, or None if the part is not an image."""
     if not self.inline_data:
       return None
@@ -1184,15 +1183,17 @@ class PartDict(TypedDict, total=False):
   thought_signature: Optional[bytes]
   """An opaque signature for the thought so it can be reused in subsequent requests."""
 
+  function_call: Optional[FunctionCallDict]
+  """A predicted [FunctionCall] returned from the model that contains a string
+      representing the [FunctionDeclaration.name] and a structured JSON object
+      containing the parameters and their values."""
+
   code_execution_result: Optional[CodeExecutionResultDict]
   """Optional. Result of executing the [ExecutableCode]."""
 
   executable_code: Optional[ExecutableCodeDict]
   """Optional. Code generated by the model that is meant to be executed."""
 
-  function_call: Optional[FunctionCallDict]
-  """Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values."""
-
   function_response: Optional[FunctionResponseDict]
   """Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model."""
 
@@ -3901,6 +3902,10 @@ class GenerateContentConfig(_common.BaseModel):
   http_options: Optional[HttpOptions] = Field(
       default=None, description="""Used to override HTTP request options."""
   )
+  should_return_http_response: Optional[bool] = Field(
+      default=None,
+      description=""" If true, the raw HTTP response will be returned in the 'sdk_http_response' field.""",
+  )
   system_instruction: Optional[ContentUnion] = Field(
       default=None,
       description="""Instructions for the model to steer it toward better performance.
@@ -4115,6 +4120,9 @@ class GenerateContentConfigDict(TypedDict, total=False):
   http_options: Optional[HttpOptionsDict]
   """Used to override HTTP request options."""
 
+  should_return_http_response: Optional[bool]
+  """ If true, the raw HTTP response will be returned in the 'sdk_http_response' field."""
+
   system_instruction: Optional[ContentUnionDict]
   """Instructions for the model to steer it toward better performance.
       For example, "Answer as concisely as possible" or "Don't use technical
@@ -5972,91 +5980,69 @@ class GenerateImagesConfig(_common.BaseModel):
   )
   output_gcs_uri: Optional[str] = Field(
       default=None,
-      description="""Cloud Storage URI used to store the generated images.
-      """,
+      description="""Cloud Storage URI used to store the generated images.""",
   )
   negative_prompt: Optional[str] = Field(
       default=None,
-      description="""Description of what to discourage in the generated images.
-      """,
+      description="""Description of what to discourage in the generated images.""",
   )
   number_of_images: Optional[int] = Field(
-      default=None,
-      description="""Number of images to generate.
-      """,
+      default=None, description="""Number of images to generate."""
   )
   aspect_ratio: Optional[str] = Field(
       default=None,
       description="""Aspect ratio of the generated images. Supported values are
-      "1:1", "3:4", "4:3", "9:16", and "16:9".
-      """,
+      "1:1", "3:4", "4:3", "9:16", and "16:9".""",
   )
   guidance_scale: Optional[float] = Field(
       default=None,
       description="""Controls how much the model adheres to the text prompt. Large
       values increase output and prompt alignment, but may compromise image
-      quality.
-      """,
+      quality.""",
   )
   seed: Optional[int] = Field(
       default=None,
       description="""Random seed for image generation. This is not available when
-      ``add_watermark`` is set to true.
-      """,
+      ``add_watermark`` is set to true.""",
   )
   safety_filter_level: Optional[SafetyFilterLevel] = Field(
-      default=None,
-      description="""Filter level for safety filtering.
-      """,
+      default=None, description="""Filter level for safety filtering."""
   )
   person_generation: Optional[PersonGeneration] = Field(
-      default=None,
-      description="""Allows generation of people by the model.
-      """,
+      default=None, description="""Allows generation of people by the model."""
   )
   include_safety_attributes: Optional[bool] = Field(
       default=None,
       description="""Whether to report the safety scores of each generated image and
-      the positive prompt in the response.
-      """,
+      the positive prompt in the response.""",
   )
   include_rai_reason: Optional[bool] = Field(
       default=None,
       description="""Whether to include the Responsible AI filter reason if the image
-      is filtered out of the response.
-      """,
+      is filtered out of the response.""",
   )
   language: Optional[ImagePromptLanguage] = Field(
-      default=None,
-      description="""Language of the text in the prompt.
-      """,
+      default=None, description="""Language of the text in the prompt."""
   )
   output_mime_type: Optional[str] = Field(
-      default=None,
-      description="""MIME type of the generated image.
-      """,
+      default=None, description="""MIME type of the generated image."""
   )
   output_compression_quality: Optional[int] = Field(
       default=None,
       description="""Compression quality of the generated image (for ``image/jpeg``
-      only).
-      """,
+      only).""",
   )
   add_watermark: Optional[bool] = Field(
       default=None,
-      description="""Whether to add a watermark to the generated images.
-      """,
+      description="""Whether to add a watermark to the generated images.""",
   )
   image_size: Optional[str] = Field(
       default=None,
       description="""The size of the largest dimension of the generated image.
-      Supported sizes are 1K and 2K (not supported for Imagen 3 models).
-      """,
+      Supported sizes are 1K and 2K (not supported for Imagen 3 models).""",
   )
   enhance_prompt: Optional[bool] = Field(
-      default=None,
-      description="""Whether to use the prompt rewriting logic.
-      """,
+      default=None, description="""Whether to use the prompt rewriting logic."""
   )
 
 
@@ -6067,76 +6053,60 @@ class GenerateImagesConfigDict(TypedDict, total=False):
   """Used to override HTTP request options."""
 
   output_gcs_uri: Optional[str]
-  """Cloud Storage URI used to store the generated images.
-      """
+  """Cloud Storage URI used to store the generated images."""
 
   negative_prompt: Optional[str]
-  """Description of what to discourage in the generated images.
-      """
+  """Description of what to discourage in the generated images."""
 
   number_of_images: Optional[int]
-  """Number of images to generate.
-      """
+  """Number of images to generate."""
 
   aspect_ratio: Optional[str]
   """Aspect ratio of the generated images. Supported values are
-      "1:1", "3:4", "4:3", "9:16", and "16:9".
-      """
+      "1:1", "3:4", "4:3", "9:16", and "16:9"."""
 
   guidance_scale: Optional[float]
   """Controls how much the model adheres to the text prompt. Large
       values increase output and prompt alignment, but may compromise image
-      quality.
-      """
+      quality."""
 
   seed: Optional[int]
   """Random seed for image generation. This is not available when
-      ``add_watermark`` is set to true.
-      """
+      ``add_watermark`` is set to true."""
 
   safety_filter_level: Optional[SafetyFilterLevel]
-  """Filter level for safety filtering.
-      """
+  """Filter level for safety filtering."""
 
   person_generation: Optional[PersonGeneration]
-  """Allows generation of people by the model.
-      """
+  """Allows generation of people by the model."""
 
   include_safety_attributes: Optional[bool]
   """Whether to report the safety scores of each generated image and
-      the positive prompt in the response.
-      """
+      the positive prompt in the response."""
 
   include_rai_reason: Optional[bool]
   """Whether to include the Responsible AI filter reason if the image
-      is filtered out of the response.
-      """
+      is filtered out of the response."""
 
   language: Optional[ImagePromptLanguage]
-  """Language of the text in the prompt.
-      """
+  """Language of the text in the prompt."""
 
   output_mime_type: Optional[str]
-  """MIME type of the generated image.
-      """
+  """MIME type of the generated image."""
 
   output_compression_quality: Optional[int]
   """Compression quality of the generated image (for ``image/jpeg``
-      only).
-      """
+      only)."""
 
   add_watermark: Optional[bool]
-  """Whether to add a watermark to the generated images.
-      """
+  """Whether to add a watermark to the generated images."""
 
   image_size: Optional[str]
   """The size of the largest dimension of the generated image.
-      Supported sizes are 1K and 2K (not supported for Imagen 3 models).
-      """
+      Supported sizes are 1K and 2K (not supported for Imagen 3 models)."""
 
   enhance_prompt: Optional[bool]
-  """Whether to use the prompt rewriting logic.
-      """
+  """Whether to use the prompt rewriting logic."""
 
 
 GenerateImagesConfigOrDict = Union[
@@ -6191,14 +6161,12 @@ class Image(_common.BaseModel):
   gcs_uri: Optional[str] = Field(
       default=None,
       description="""The Cloud Storage URI of the image. ``Image`` can contain a value
-      for this field or the ``image_bytes`` field but not both.
-      """,
+      for this field or the ``image_bytes`` field but not both.""",
   )
   image_bytes: Optional[bytes] = Field(
       default=None,
       description="""The image bytes data. ``Image`` can contain a value for this field
-      or the ``gcs_uri`` field but not both.
-      """,
+      or the ``gcs_uri`` field but not both.""",
   )
   mime_type: Optional[str] = Field(
       default=None, description="""The MIME type of the image."""
@@ -6255,13 +6223,19 @@ class Image(_common.BaseModel):
 
     This method only works in a notebook environment.
     """
-    try:
-      from IPython import display as IPython_display
-    except ImportError:
-      IPython_display = None
+    in_notebook = 'ipykernel' in sys.modules
+    if in_notebook:
+      try:
+        from IPython import display as IPython_display
+      except ImportError:
+        IPython_display = None
 
-    if IPython_display:
-      IPython_display.display(self._pil_image)
+      if IPython_display:
+        IPython_display.display(self._pil_image)
+    else:
+      img = self._pil_image
+      if img is not None:
+        img.show()
 
   @property
   def _pil_image(self) -> Optional['PIL_Image']:
@@ -6327,13 +6301,11 @@ class ImageDict(TypedDict, total=False):
 
   gcs_uri: Optional[str]
   """The Cloud Storage URI of the image. ``Image`` can contain a value
-      for this field or the ``image_bytes`` field but not both.
-      """
+      for this field or the ``image_bytes`` field but not both."""
 
   image_bytes: Optional[bytes]
   """The image bytes data. ``Image`` can contain a value for this field
-      or the ``gcs_uri`` field but not both.
-      """
+      or the ``gcs_uri`` field but not both."""
 
   mime_type: Optional[str]
   """The MIME type of the image."""
@@ -6346,19 +6318,13 @@ class SafetyAttributes(_common.BaseModel):
   """Safety attributes of a GeneratedImage or the user-provided prompt."""
 
   categories: Optional[list[str]] = Field(
-      default=None,
-      description="""List of RAI categories.
-      """,
+      default=None, description="""List of RAI categories."""
   )
   scores: Optional[list[float]] = Field(
-      default=None,
-      description="""List of scores of each categories.
-      """,
+      default=None, description="""List of scores of each categories."""
   )
   content_type: Optional[str] = Field(
-      default=None,
-      description="""Internal use only.
-      """,
+      default=None, description="""Internal use only."""
   )
 
 
@@ -6366,16 +6332,13 @@ class SafetyAttributesDict(TypedDict, total=False):
   """Safety attributes of a GeneratedImage or the user-provided prompt."""
 
   categories: Optional[list[str]]
-  """List of RAI categories.
-      """
+  """List of RAI categories."""
 
   scores: Optional[list[float]]
-  """List of scores of each categories.
-      """
+  """List of scores of each categories."""
 
   content_type: Optional[str]
-  """Internal use only.
-      """
+  """Internal use only."""
 
 
 SafetyAttributesOrDict = Union[SafetyAttributes, SafetyAttributesDict]
@@ -6385,27 +6348,22 @@ class GeneratedImage(_common.BaseModel):
   """An output image."""
 
   image: Optional[Image] = Field(
-      default=None,
-      description="""The output image data.
-      """,
+      default=None, description="""The output image data."""
   )
   rai_filtered_reason: Optional[str] = Field(
       default=None,
       description="""Responsible AI filter reason if the image is filtered out of the
-      response.
-      """,
+      response.""",
   )
   safety_attributes: Optional[SafetyAttributes] = Field(
       default=None,
       description="""Safety attributes of the image. Lists of RAI categories and their
-      scores of each content.
-      """,
+      scores of each content.""",
   )
   enhanced_prompt: Optional[str] = Field(
       default=None,
       description="""The rewritten prompt used for the image generation if the prompt
-      enhancer is enabled.
-      """,
+      enhancer is enabled.""",
   )
 
 
@@ -6413,23 +6371,19 @@ class GeneratedImageDict(TypedDict, total=False):
   """An output image."""
 
   image: Optional[ImageDict]
-  """The output image data.
-      """
+  """The output image data."""
 
   rai_filtered_reason: Optional[str]
   """Responsible AI filter reason if the image is filtered out of the
-      response.
-      """
+      response."""
 
   safety_attributes: Optional[SafetyAttributesDict]
   """Safety attributes of the image. Lists of RAI categories and their
-      scores of each content.
-      """
+      scores of each content."""
 
   enhanced_prompt: Optional[str]
   """The rewritten prompt used for the image generation if the prompt
-      enhancer is enabled.
-      """
+      enhancer is enabled."""
 
 
 GeneratedImageOrDict = Union[GeneratedImage, GeneratedImageDict]
@@ -6442,15 +6396,12 @@ class GenerateImagesResponse(_common.BaseModel):
       default=None, description="""Used to retain the full HTTP response."""
   )
   generated_images: Optional[list[GeneratedImage]] = Field(
-      default=None,
-      description="""List of generated images.
-      """,
+      default=None, description="""List of generated images."""
   )
   positive_prompt_safety_attributes: Optional[SafetyAttributes] = Field(
       default=None,
       description="""Safety attributes of the positive prompt. Only populated if
-      ``include_safety_attributes`` is set to True.
-      """,
+      ``include_safety_attributes`` is set to True.""",
   )
 
   @property
@@ -6472,13 +6423,11 @@ class GenerateImagesResponseDict(TypedDict, total=False):
   """Used to retain the full HTTP response."""
 
   generated_images: Optional[list[GeneratedImageDict]]
-  """List of generated images.
-      """
+  """List of generated images."""
 
   positive_prompt_safety_attributes: Optional[SafetyAttributesDict]
   """Safety attributes of the positive prompt. Only populated if
-      ``include_safety_attributes`` is set to True.
-      """
+      ``include_safety_attributes`` is set to True."""
 
 
 GenerateImagesResponseOrDict = Union[
@@ -6673,80 +6622,61 @@ class EditImageConfig(_common.BaseModel):
   )
   output_gcs_uri: Optional[str] = Field(
       default=None,
-      description="""Cloud Storage URI used to store the generated images.
-      """,
+      description="""Cloud Storage URI used to store the generated images.""",
   )
   negative_prompt: Optional[str] = Field(
       default=None,
-      description="""Description of what to discourage in the generated images.
-      """,
+      description="""Description of what to discourage in the generated images.""",
   )
   number_of_images: Optional[int] = Field(
-      default=None,
-      description="""Number of images to generate.
-      """,
+      default=None, description="""Number of images to generate."""
   )
   aspect_ratio: Optional[str] = Field(
       default=None,
       description="""Aspect ratio of the generated images. Supported values are
-      "1:1", "3:4", "4:3", "9:16", and "16:9".
-      """,
+      "1:1", "3:4", "4:3", "9:16", and "16:9".""",
   )
   guidance_scale: Optional[float] = Field(
       default=None,
       description="""Controls how much the model adheres to the text prompt. Large
       values increase output and prompt alignment, but may compromise image
-      quality.
-      """,
+      quality.""",
   )
   seed: Optional[int] = Field(
       default=None,
       description="""Random seed for image generation. This is not available when
-      ``add_watermark`` is set to true.
-      """,
+      ``add_watermark`` is set to true.""",
   )
   safety_filter_level: Optional[SafetyFilterLevel] = Field(
-      default=None,
-      description="""Filter level for safety filtering.
-      """,
+      default=None, description="""Filter level for safety filtering."""
   )
   person_generation: Optional[PersonGeneration] = Field(
-      default=None,
-      description="""Allows generation of people by the model.
-      """,
+      default=None, description="""Allows generation of people by the model."""
   )
   include_safety_attributes: Optional[bool] = Field(
       default=None,
       description="""Whether to report the safety scores of each generated image and
-      the positive prompt in the response.
-      """,
+      the positive prompt in the response.""",
   )
   include_rai_reason: Optional[bool] = Field(
       default=None,
       description="""Whether to include the Responsible AI filter reason if the image
-      is filtered out of the response.
-      """,
+      is filtered out of the response.""",
   )
   language: Optional[ImagePromptLanguage] = Field(
-      default=None,
-      description="""Language of the text in the prompt.
-      """,
+      default=None, description="""Language of the text in the prompt."""
   )
   output_mime_type: Optional[str] = Field(
-      default=None,
-      description="""MIME type of the generated image.
-      """,
+      default=None, description="""MIME type of the generated image."""
   )
   output_compression_quality: Optional[int] = Field(
       default=None,
       description="""Compression quality of the generated image (for ``image/jpeg``
-      only).
-      """,
+      only).""",
   )
   add_watermark: Optional[bool] = Field(
       default=None,
-      description="""Whether to add a watermark to the generated images.
-      """,
+      description="""Whether to add a watermark to the generated images.""",
   )
   edit_mode: Optional[EditMode] = Field(
       default=None,
@@ -6766,67 +6696,53 @@ class EditImageConfigDict(TypedDict, total=False):
   """Used to override HTTP request options."""
 
   output_gcs_uri: Optional[str]
-  """Cloud Storage URI used to store the generated images.
-      """
+  """Cloud Storage URI used to store the generated images."""
 
   negative_prompt: Optional[str]
-  """Description of what to discourage in the generated images.
-      """
+  """Description of what to discourage in the generated images."""
 
   number_of_images: Optional[int]
-  """Number of images to generate.
-      """
+  """Number of images to generate."""
 
   aspect_ratio: Optional[str]
   """Aspect ratio of the generated images. Supported values are
-      "1:1", "3:4", "4:3", "9:16", and "16:9".
-      """
+      "1:1", "3:4", "4:3", "9:16", and "16:9"."""
 
   guidance_scale: Optional[float]
   """Controls how much the model adheres to the text prompt. Large
       values increase output and prompt alignment, but may compromise image
-      quality.
-      """
+      quality."""
 
   seed: Optional[int]
   """Random seed for image generation. This is not available when
-      ``add_watermark`` is set to true.
-      """
+      ``add_watermark`` is set to true."""
 
   safety_filter_level: Optional[SafetyFilterLevel]
-  """Filter level for safety filtering.
-      """
+  """Filter level for safety filtering."""
 
   person_generation: Optional[PersonGeneration]
-  """Allows generation of people by the model.
-      """
+  """Allows generation of people by the model."""
 
   include_safety_attributes: Optional[bool]
   """Whether to report the safety scores of each generated image and
-      the positive prompt in the response.
-      """
+      the positive prompt in the response."""
 
   include_rai_reason: Optional[bool]
   """Whether to include the Responsible AI filter reason if the image
-      is filtered out of the response.
-      """
+      is filtered out of the response."""
 
   language: Optional[ImagePromptLanguage]
-  """Language of the text in the prompt.
-      """
+  """Language of the text in the prompt."""
 
   output_mime_type: Optional[str]
-  """MIME type of the generated image.
-      """
+  """MIME type of the generated image."""
 
   output_compression_quality: Optional[int]
   """Compression quality of the generated image (for ``image/jpeg``
-      only).
-      """
+      only)."""
 
   add_watermark: Optional[bool]
-  """Whether to add a watermark to the generated images.
-      """
+  """Whether to add a watermark to the generated images."""
 
   edit_mode: Optional[EditMode]
   """Describes the editing mode for the request."""
@@ -6927,8 +6843,8 @@ class _UpscaleImageAPIConfig(_common.BaseModel):
   )
   output_compression_quality: Optional[int] = Field(
       default=None,
-      description="""The level of compression if the ``output_mime_type`` is
-      ``image/jpeg``.""",
+      description="""The level of compression. Only applicable if the
+      ``output_mime_type`` is ``image/jpeg``.""",
   )
   enhance_input_image: Optional[bool] = Field(
       default=None,
@@ -6968,8 +6884,8 @@ class _UpscaleImageAPIConfigDict(TypedDict, total=False):
   """The image format that the output should be saved as."""
 
   output_compression_quality: Optional[int]
-  """The level of compression if the ``output_mime_type`` is
-      ``image/jpeg``."""
+  """The level of compression. Only applicable if the
+      ``output_mime_type`` is ``image/jpeg``."""
 
   enhance_input_image: Optional[bool]
   """Whether to add an image enhancing step before upscaling.
@@ -8336,7 +8252,7 @@ class Video(_common.BaseModel):
       default=None, description="""Video bytes."""
   )
   mime_type: Optional[str] = Field(
-      default=None, description="""Video encoding, for example "video/mp4"."""
+      default=None, description="""Video encoding, for example ``video/mp4``."""
   )
 
   @classmethod
@@ -8423,7 +8339,7 @@ class VideoDict(TypedDict, total=False):
   """Video bytes."""
 
   mime_type: Optional[str]
-  """Video encoding, for example "video/mp4"."""
+  """Video encoding, for example ``video/mp4``."""
 
 
 VideoOrDict = Union[Video, VideoDict]
@@ -8440,12 +8356,12 @@ class GenerateVideosSource(_common.BaseModel):
   image: Optional[Image] = Field(
       default=None,
       description="""The input image for generating the videos.
-      Optional if prompt or video is provided.""",
+      Optional if prompt is provided. Not allowed if video is provided.""",
   )
   video: Optional[Video] = Field(
       default=None,
       description="""The input video for video extension use cases.
-      Optional if prompt or image is provided.""",
+      Optional if prompt is provided. Not allowed if image is provided.""",
   )
 
 
@@ -8458,11 +8374,11 @@ class GenerateVideosSourceDict(TypedDict, total=False):
 
   image: Optional[ImageDict]
   """The input image for generating the videos.
-      Optional if prompt or video is provided."""
+      Optional if prompt is provided. Not allowed if video is provided."""
 
   video: Optional[VideoDict]
   """The input video for video extension use cases.
-      Optional if prompt or image is provided."""
+      Optional if prompt is provided. Not allowed if image is provided."""
 
 
 GenerateVideosSourceOrDict = Union[
@@ -8474,9 +8390,7 @@ class VideoGenerationReferenceImage(_common.BaseModel):
   """A reference image for video generation."""
 
   image: Optional[Image] = Field(
-      default=None,
-      description="""The reference image.
-      """,
+      default=None, description="""The reference image."""
   )
   reference_type: Optional[VideoGenerationReferenceType] = Field(
       default=None,
@@ -8489,8 +8403,7 @@ class VideoGenerationReferenceImageDict(TypedDict, total=False):
   """A reference image for video generation."""
 
   image: Optional[ImageDict]
-  """The reference image.
-      """
+  """The reference image."""
 
   reference_type: Optional[VideoGenerationReferenceType]
   """The type of the reference image, which defines how the reference
@@ -8524,27 +8437,35 @@ class GenerateVideosConfig(_common.BaseModel):
   )
   seed: Optional[int] = Field(
       default=None,
-      description="""The RNG seed. If RNG seed is exactly same for each request with unchanged inputs, the prediction results will be consistent. Otherwise, a random RNG seed will be used each time to produce a different result.""",
+      description="""The RNG seed. If RNG seed is exactly same for each request with
+      unchanged inputs, the prediction results will be consistent. Otherwise,
+      a random RNG seed will be used each time to produce a different
+      result.""",
   )
   aspect_ratio: Optional[str] = Field(
       default=None,
-      description="""The aspect ratio for the generated video. 16:9 (landscape) and 9:16 (portrait) are supported.""",
+      description="""The aspect ratio for the generated video. 16:9 (landscape) and
+      9:16 (portrait) are supported.""",
   )
   resolution: Optional[str] = Field(
       default=None,
-      description="""The resolution for the generated video. 720p and 1080p are supported.""",
+      description="""The resolution for the generated video. 720p and 1080p are
+      supported.""",
   )
   person_generation: Optional[str] = Field(
       default=None,
-      description="""Whether allow to generate person videos, and restrict to specific ages. Supported values are: dont_allow, allow_adult.""",
+      description="""Whether allow to generate person videos, and restrict to specific
+      ages. Supported values are: dont_allow, allow_adult.""",
   )
   pubsub_topic: Optional[str] = Field(
       default=None,
-      description="""The pubsub topic where to publish the video generation progress.""",
+      description="""The pubsub topic where to publish the video generation
+      progress.""",
   )
   negative_prompt: Optional[str] = Field(
       default=None,
-      description="""Optional field in addition to the text content. Negative prompts can be explicitly stated here to help generate the video.""",
+      description="""Explicitly state what should not be included in the generated
+      videos.""",
   )
   enhance_prompt: Optional[bool] = Field(
       default=None, description="""Whether to use the prompt rewriting logic."""
@@ -8555,7 +8476,8 @@ class GenerateVideosConfig(_common.BaseModel):
   )
   last_frame: Optional[Image] = Field(
       default=None,
-      description="""Image to use as the last frame of generated videos. Only supported for image to video use cases.""",
+      description="""Image to use as the last frame of generated videos.
+      Only supported for image to video use cases.""",
   )
   reference_images: Optional[list[VideoGenerationReferenceImage]] = Field(
       default=None,
@@ -8590,22 +8512,30 @@ class GenerateVideosConfigDict(TypedDict, total=False):
   """Duration of the clip for video generation in seconds."""
 
   seed: Optional[int]
-  """The RNG seed. If RNG seed is exactly same for each request with unchanged inputs, the prediction results will be consistent. Otherwise, a random RNG seed will be used each time to produce a different result."""
+  """The RNG seed. If RNG seed is exactly same for each request with
+      unchanged inputs, the prediction results will be consistent. Otherwise,
+      a random RNG seed will be used each time to produce a different
+      result."""
 
   aspect_ratio: Optional[str]
-  """The aspect ratio for the generated video. 16:9 (landscape) and 9:16 (portrait) are supported."""
+  """The aspect ratio for the generated video. 16:9 (landscape) and
+      9:16 (portrait) are supported."""
 
   resolution: Optional[str]
-  """The resolution for the generated video. 720p and 1080p are supported."""
+  """The resolution for the generated video. 720p and 1080p are
+      supported."""
 
   person_generation: Optional[str]
-  """Whether allow to generate person videos, and restrict to specific ages. Supported values are: dont_allow, allow_adult."""
+  """Whether allow to generate person videos, and restrict to specific
+      ages. Supported values are: dont_allow, allow_adult."""
 
   pubsub_topic: Optional[str]
-  """The pubsub topic where to publish the video generation progress."""
+  """The pubsub topic where to publish the video generation
+      progress."""
 
   negative_prompt: Optional[str]
-  """Optional field in addition to the text content. Negative prompts can be explicitly stated here to help generate the video."""
+  """Explicitly state what should not be included in the generated
+      videos."""
 
   enhance_prompt: Optional[bool]
   """Whether to use the prompt rewriting logic."""
@@ -8614,7 +8544,8 @@ class GenerateVideosConfigDict(TypedDict, total=False):
   """Whether to generate audio along with the video."""
 
   last_frame: Optional[ImageDict]
-  """Image to use as the last frame of generated videos. Only supported for image to video use cases."""
+  """Image to use as the last frame of generated videos.
+      Only supported for image to video use cases."""
 
   reference_images: Optional[list[VideoGenerationReferenceImageDict]]
   """The images to use as the references to generate the videos.
@@ -8642,17 +8573,18 @@ class _GenerateVideosParameters(_common.BaseModel):
   )
   prompt: Optional[str] = Field(
       default=None,
-      description="""The text prompt for generating the videos. Optional for image to video use cases.""",
+      description="""The text prompt for generating the videos.
+      Optional if image or video is provided.""",
   )
   image: Optional[Image] = Field(
       default=None,
       description="""The input image for generating the videos.
-      Optional if prompt or video is provided.""",
+      Optional if prompt is provided. Not allowed if video is provided.""",
   )
   video: Optional[Video] = Field(
       default=None,
       description="""The input video for video extension use cases.
-      Optional if prompt or image is provided.""",
+      Optional if prompt is provided. Not allowed if image is provided.""",
   )
   source: Optional[GenerateVideosSource] = Field(
       default=None,
@@ -8671,15 +8603,16 @@ class _GenerateVideosParametersDict(TypedDict, total=False):
     <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`_."""
 
   prompt: Optional[str]
-  """The text prompt for generating the videos. Optional for image to video use cases."""
+  """The text prompt for generating the videos.
+      Optional if image or video is provided."""
 
   image: Optional[ImageDict]
   """The input image for generating the videos.
-      Optional if prompt or video is provided."""
+      Optional if prompt is provided. Not allowed if video is provided."""
 
   video: Optional[VideoDict]
   """The input video for video extension use cases.
-      Optional if prompt or image is provided."""
+      Optional if prompt is provided. Not allowed if image is provided."""
 
   source: Optional[GenerateVideosSourceDict]
   """A set of source input(s) for video generation."""
@@ -11506,6 +11439,70 @@ class InlinedResponseDict(TypedDict, total=False):
 InlinedResponseOrDict = Union[InlinedResponse, InlinedResponseDict]
 
 
+class SingleEmbedContentResponse(_common.BaseModel):
+  """Config for `response` parameter."""
+
+  embedding: Optional[ContentEmbedding] = Field(
+      default=None,
+      description="""The response to the request.
+      """,
+  )
+  token_count: Optional[int] = Field(
+      default=None,
+      description="""The error encountered while processing the request.
+      """,
+  )
+
+
+class SingleEmbedContentResponseDict(TypedDict, total=False):
+  """Config for `response` parameter."""
+
+  embedding: Optional[ContentEmbeddingDict]
+  """The response to the request.
+      """
+
+  token_count: Optional[int]
+  """The error encountered while processing the request.
+      """
+
+
+SingleEmbedContentResponseOrDict = Union[
+    SingleEmbedContentResponse, SingleEmbedContentResponseDict
+]
+
+
+class InlinedEmbedContentResponse(_common.BaseModel):
+  """Config for `inlined_embedding_responses` parameter."""
+
+  response: Optional[SingleEmbedContentResponse] = Field(
+      default=None,
+      description="""The response to the request.
+      """,
+  )
+  error: Optional[JobError] = Field(
+      default=None,
+      description="""The error encountered while processing the request.
+      """,
+  )
+
+
+class InlinedEmbedContentResponseDict(TypedDict, total=False):
+  """Config for `inlined_embedding_responses` parameter."""
+
+  response: Optional[SingleEmbedContentResponseDict]
+  """The response to the request.
+      """
+
+  error: Optional[JobErrorDict]
+  """The error encountered while processing the request.
+      """
+
+
+InlinedEmbedContentResponseOrDict = Union[
+    InlinedEmbedContentResponse, InlinedEmbedContentResponseDict
+]
+
+
 class BatchJobDestination(_common.BaseModel):
   """Config for `des` parameter."""
 
@@ -11541,6 +11538,15 @@ class BatchJobDestination(_common.BaseModel):
       the input requests.
       """,
   )
+  inlined_embed_content_responses: Optional[
+      list[InlinedEmbedContentResponse]
+  ] = Field(
+      default=None,
+      description="""The responses to the requests in the batch. Returned when the batch was
+      built using inlined requests. The responses will be in the same order as
+      the input requests.
+      """,
+  )
 
 
 class BatchJobDestinationDict(TypedDict, total=False):
@@ -11573,6 +11579,14 @@ class BatchJobDestinationDict(TypedDict, total=False):
       the input requests.
       """
 
+  inlined_embed_content_responses: Optional[
+      list[InlinedEmbedContentResponseDict]
+  ]
+  """The responses to the requests in the batch. Returned when the batch was
+      built using inlined requests. The responses will be in the same order as
+      the input requests.
+      """
+
 
 BatchJobDestinationOrDict = Union[BatchJobDestination, BatchJobDestinationDict]
 
@@ -11733,6 +11747,13 @@ class BatchJob(_common.BaseModel):
       """,
   )
 
+  @property
+  def done(self) -> bool:
+    """Returns True if the batch job has ended."""
+    if self.state is None:
+      return False
+    return self.state.name in JOB_STATES_ENDED
+
 
 class BatchJobDict(TypedDict, total=False):
   """Config for batches.create return value."""
@@ -11783,6 +11804,138 @@ class BatchJobDict(TypedDict, total=False):
 BatchJobOrDict = Union[BatchJob, BatchJobDict]
 
 
+class EmbedContentBatch(_common.BaseModel):
+  """Parameters for the embed_content method."""
+
+  contents: Optional[ContentListUnion] = Field(
+      default=None,
+      description="""The content to embed. Only the `parts.text` fields will be counted.
+      """,
+  )
+  config: Optional[EmbedContentConfig] = Field(
+      default=None,
+      description="""Configuration that contains optional parameters.
+      """,
+  )
+
+
+class EmbedContentBatchDict(TypedDict, total=False):
+  """Parameters for the embed_content method."""
+
+  contents: Optional[ContentListUnionDict]
+  """The content to embed. Only the `parts.text` fields will be counted.
+      """
+
+  config: Optional[EmbedContentConfigDict]
+  """Configuration that contains optional parameters.
+      """
+
+
+EmbedContentBatchOrDict = Union[EmbedContentBatch, EmbedContentBatchDict]
+
+
+class EmbeddingsBatchJobSource(_common.BaseModel):
+
+  file_name: Optional[str] = Field(
+      default=None,
+      description="""The Gemini Developer API's file resource name of the input data
+      (e.g. "files/12345").
+      """,
+  )
+  inlined_requests: Optional[EmbedContentBatch] = Field(
+      default=None,
+      description="""The Gemini Developer API's inlined input data to run batch job.
+      """,
+  )
+
+
+class EmbeddingsBatchJobSourceDict(TypedDict, total=False):
+
+  file_name: Optional[str]
+  """The Gemini Developer API's file resource name of the input data
+      (e.g. "files/12345").
+      """
+
+  inlined_requests: Optional[EmbedContentBatchDict]
+  """The Gemini Developer API's inlined input data to run batch job.
+      """
+
+
+EmbeddingsBatchJobSourceOrDict = Union[
+    EmbeddingsBatchJobSource, EmbeddingsBatchJobSourceDict
+]
+
+
+class CreateEmbeddingsBatchJobConfig(_common.BaseModel):
+  """Config for optional parameters."""
+
+  http_options: Optional[HttpOptions] = Field(
+      default=None, description="""Used to override HTTP request options."""
+  )
+  display_name: Optional[str] = Field(
+      default=None,
+      description="""The user-defined name of this BatchJob.
+      """,
+  )
+
+
+class CreateEmbeddingsBatchJobConfigDict(TypedDict, total=False):
+  """Config for optional parameters."""
+
+  http_options: Optional[HttpOptionsDict]
+  """Used to override HTTP request options."""
+
+  display_name: Optional[str]
+  """The user-defined name of this BatchJob.
+      """
+
+
+CreateEmbeddingsBatchJobConfigOrDict = Union[
+    CreateEmbeddingsBatchJobConfig, CreateEmbeddingsBatchJobConfigDict
+]
+
+
+class _CreateEmbeddingsBatchJobParameters(_common.BaseModel):
+  """Config for batches.create parameters."""
+
+  model: Optional[str] = Field(
+      default=None,
+      description="""The name of the model to produces the predictions via the BatchJob.
+      """,
+  )
+  src: Optional[EmbeddingsBatchJobSource] = Field(
+      default=None,
+      description="""input data to run batch job".
+      """,
+  )
+  config: Optional[CreateEmbeddingsBatchJobConfig] = Field(
+      default=None,
+      description="""Optional parameters for creating a BatchJob.
+      """,
+  )
+
+
+class _CreateEmbeddingsBatchJobParametersDict(TypedDict, total=False):
+  """Config for batches.create parameters."""
+
+  model: Optional[str]
+  """The name of the model to produces the predictions via the BatchJob.
+      """
+
+  src: Optional[EmbeddingsBatchJobSourceDict]
+  """input data to run batch job".
+      """
+
+  config: Optional[CreateEmbeddingsBatchJobConfigDict]
+  """Optional parameters for creating a BatchJob.
+      """
+
+
+_CreateEmbeddingsBatchJobParametersOrDict = Union[
+    _CreateEmbeddingsBatchJobParameters, _CreateEmbeddingsBatchJobParametersDict
+]
+
+
 class GetBatchJobConfig(_common.BaseModel):
   """Optional parameters."""
 
@@ -12422,8 +12575,8 @@ class UpscaleImageConfig(_common.BaseModel):
   )
   output_compression_quality: Optional[int] = Field(
       default=None,
-      description="""The level of compression if the ``output_mime_type`` is
-      ``image/jpeg``.""",
+      description="""The level of compression. Only applicable if the
+      ``output_mime_type`` is ``image/jpeg``.""",
   )
   enhance_input_image: Optional[bool] = Field(
       default=None,
@@ -12462,8 +12615,8 @@ class UpscaleImageConfigDict(TypedDict, total=False):
   """The image format that the output should be saved as."""
 
   output_compression_quality: Optional[int]
-  """The level of compression if the ``output_mime_type`` is
-      ``image/jpeg``."""
+  """The level of compression. Only applicable if the
+      ``output_mime_type`` is ``image/jpeg``."""
 
   enhance_input_image: Optional[bool]
   """Whether to add an image enhancing step before upscaling.