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

google/genai/types.py

@@ -23,7 +23,7 @@ import logging
 import sys
 import types as builtin_types
 import typing
-from typing import Any, Callable, Literal, Optional, Union, _UnionGenericAlias
+from typing import Any, Callable, Literal, Optional, Union, _UnionGenericAlias  # type: ignore
 import pydantic
 from pydantic import Field
 from typing_extensions import TypedDict
@@ -56,6 +56,8 @@ else:
 
 logger = logging.getLogger('google_genai.types')
 
+T = typing.TypeVar('T', bound='GenerateContentResponse')
+
 
 class Outcome(_common.CaseInSensitiveEnum):
   """Required. Outcome of the code execution."""
@@ -717,10 +719,12 @@ class UserContent(Content):
   role: Literal['user'] = Field(default='user', init=False, frozen=True)
   parts: list[Part] = Field()
 
-  def __init__(self, parts: Union['PartUnionDict', list['PartUnionDict']]):
+  def __init__(
+      self, parts: Union['PartUnionDict', list['PartUnionDict'], list['Part']]
+  ):
     from . import _transformers as t
 
-    super().__init__(parts=t.t_parts(None, parts=parts))
+    super().__init__(parts=t.t_parts(parts=parts))
 
 
 class ModelContent(Content):
@@ -745,10 +749,12 @@ class ModelContent(Content):
   role: Literal['model'] = Field(default='model', init=False, frozen=True)
   parts: list[Part] = Field()
 
-  def __init__(self, parts: Union['PartUnionDict', list['PartUnionDict']]):
+  def __init__(
+      self, parts: Union['PartUnionDict', list['PartUnionDict'], list['Part']]
+  ):
     from . import _transformers as t
 
-    super().__init__(parts=t.t_parts(None, parts=parts))
+    super().__init__(parts=t.t_parts(parts=parts))
 
 
 class ContentDict(TypedDict, total=False):
@@ -819,17 +825,9 @@ class Schema(_common.BaseModel):
       default=None,
       description="""Optional. Pattern of the Type.STRING to restrict a string to a regular expression.""",
   )
-  minimum: Optional[float] = Field(
-      default=None,
-      description="""Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER""",
-  )
   default: Optional[Any] = Field(
       default=None, description="""Optional. Default value of the data."""
   )
-  any_of: Optional[list['Schema']] = Field(
-      default=None,
-      description="""Optional. The value should be validated against any (one or more) of the subschemas in the list.""",
-  )
   max_length: Optional[int] = Field(
       default=None,
       description="""Optional. Maximum length of the Type.STRING""",
@@ -845,14 +843,14 @@ class Schema(_common.BaseModel):
       default=None,
       description="""Optional. Minimum number of the properties for Type.OBJECT.""",
   )
-  maximum: Optional[float] = Field(
-      default=None,
-      description="""Optional. Maximum value of the Type.INTEGER and Type.NUMBER""",
-  )
   max_properties: Optional[int] = Field(
       default=None,
       description="""Optional. Maximum number of the properties for Type.OBJECT.""",
   )
+  any_of: Optional[list['Schema']] = Field(
+      default=None,
+      description="""Optional. The value should be validated against any (one or more) of the subschemas in the list.""",
+  )
   description: Optional[str] = Field(
       default=None, description="""Optional. The description of the data."""
   )
@@ -872,10 +870,18 @@ class Schema(_common.BaseModel):
       default=None,
       description="""Optional. Maximum number of the elements for Type.ARRAY.""",
   )
+  maximum: Optional[float] = Field(
+      default=None,
+      description="""Optional. Maximum value of the Type.INTEGER and Type.NUMBER""",
+  )
   min_items: Optional[int] = Field(
       default=None,
       description="""Optional. Minimum number of the elements for Type.ARRAY.""",
   )
+  minimum: Optional[float] = Field(
+      default=None,
+      description="""Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER""",
+  )
   nullable: Optional[bool] = Field(
       default=None,
       description="""Optional. Indicates if the value may be null.""",
@@ -909,15 +915,9 @@ class SchemaDict(TypedDict, total=False):
   pattern: Optional[str]
   """Optional. Pattern of the Type.STRING to restrict a string to a regular expression."""
 
-  minimum: Optional[float]
-  """Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER"""
-
   default: Optional[Any]
   """Optional. Default value of the data."""
 
-  any_of: Optional[list['SchemaDict']]
-  """Optional. The value should be validated against any (one or more) of the subschemas in the list."""
-
   max_length: Optional[int]
   """Optional. Maximum length of the Type.STRING"""
 
@@ -930,12 +930,12 @@ class SchemaDict(TypedDict, total=False):
   min_properties: Optional[int]
   """Optional. Minimum number of the properties for Type.OBJECT."""
 
-  maximum: Optional[float]
-  """Optional. Maximum value of the Type.INTEGER and Type.NUMBER"""
-
   max_properties: Optional[int]
   """Optional. Maximum number of the properties for Type.OBJECT."""
 
+  any_of: Optional[list['SchemaDict']]
+  """Optional. The value should be validated against any (one or more) of the subschemas in the list."""
+
   description: Optional[str]
   """Optional. The description of the data."""
 
@@ -951,9 +951,15 @@ class SchemaDict(TypedDict, total=False):
   max_items: Optional[int]
   """Optional. Maximum number of the elements for Type.ARRAY."""
 
+  maximum: Optional[float]
+  """Optional. Maximum value of the Type.INTEGER and Type.NUMBER"""
+
   min_items: Optional[int]
   """Optional. Minimum number of the elements for Type.ARRAY."""
 
+  minimum: Optional[float]
+  """Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER"""
+
   nullable: Optional[bool]
   """Optional. Indicates if the value may be null."""
 
@@ -1072,12 +1078,11 @@ class FunctionDeclaration(_common.BaseModel):
           type='OBJECT',
           properties=parameters_properties,
       )
-      if api_option == 'VERTEX_AI':
-        declaration.parameters.required = (
-            _automatic_function_calling_util._get_required_fields(
-                declaration.parameters
-            )
-        )
+      declaration.parameters.required = (
+          _automatic_function_calling_util._get_required_fields(
+              declaration.parameters
+          )
+      )
     if api_option == 'GEMINI_API':
       return declaration
 
@@ -1661,7 +1666,7 @@ class File(_common.BaseModel):
   )
   sha256_hash: Optional[str] = Field(
       default=None,
-      description="""Output only. SHA-256 hash of the uploaded bytes.""",
+      description="""Output only. SHA-256 hash of the uploaded bytes. The hash value is encoded in base64 format.""",
   )
   uri: Optional[str] = Field(
       default=None, description="""Output only. The URI of the `File`."""
@@ -1710,7 +1715,7 @@ class FileDict(TypedDict, total=False):
   """Output only. The timestamp of when the `File` was last updated."""
 
   sha256_hash: Optional[str]
-  """Output only. SHA-256 hash of the uploaded bytes."""
+  """Output only. SHA-256 hash of the uploaded bytes. The hash value is encoded in base64 format."""
 
   uri: Optional[str]
   """Output only. The URI of the `File`."""
@@ -1736,7 +1741,7 @@ FileOrDict = Union[File, FileDict]
 if _is_pillow_image_imported:
   PartUnion = Union[File, Part, PIL_Image, str]
 else:
-  PartUnion = Union[File, Part, str]
+  PartUnion = Union[File, Part, str]  # type: ignore[misc]
 
 
 PartUnionDict = Union[PartUnion, PartDict]
@@ -3012,8 +3017,11 @@ class GenerateContentResponse(_common.BaseModel):
 
   @classmethod
   def _from_response(
-      cls, *, response: dict[str, object], kwargs: dict[str, object]
-  ) -> _common.BaseModel:
+      cls: typing.Type[T],
+      *,
+      response: dict[str, object],
+      kwargs: dict[str, object],
+  ) -> T:
     result = super()._from_response(response=response, kwargs=kwargs)
 
     # Handles response schema.
@@ -3029,13 +3037,14 @@ class GenerateContentResponse(_common.BaseModel):
     ):
       # Pydantic schema.
       try:
-        result.parsed = response_schema.model_validate_json(result.text)
+        if result.text is not None:
+          result.parsed = response_schema.model_validate_json(result.text)
       # may not be a valid json per stream response
       except pydantic.ValidationError:
         pass
       except json.decoder.JSONDecodeError:
         pass
-    elif isinstance(response_schema, EnumMeta):
+    elif isinstance(response_schema, EnumMeta) and result.text is not None:
       # Enum with "application/json" returns response in double quotes.
       enum_value = result.text.replace('"', '')
       try:
@@ -3044,7 +3053,7 @@ class GenerateContentResponse(_common.BaseModel):
             hasattr(response_schema, '__name__')
             and response_schema.__name__ == 'PlaceholderLiteralEnum'
         ):
-          result.parsed = str(response_schema(enum_value).name)
+          result.parsed = str(response_schema(enum_value).name)  # type: ignore
       except ValueError:
         pass
     elif isinstance(response_schema, builtin_types.GenericAlias) or isinstance(
@@ -3052,12 +3061,13 @@ class GenerateContentResponse(_common.BaseModel):
     ):
 
       class Placeholder(pydantic.BaseModel):
-        placeholder: response_schema
+        placeholder: response_schema  # type: ignore[valid-type]
 
       try:
-        parsed = {'placeholder': json.loads(result.text)}
-        placeholder = Placeholder.model_validate(parsed)
-        result.parsed = placeholder.placeholder
+        if result.text is not None:
+          parsed = {'placeholder': json.loads(result.text)}
+          placeholder = Placeholder.model_validate(parsed)
+          result.parsed = placeholder.placeholder
       except json.decoder.JSONDecodeError:
         pass
       except pydantic.ValidationError:
@@ -3070,7 +3080,8 @@ class GenerateContentResponse(_common.BaseModel):
       # want the result converted to. So just return json.
       # JSON schema.
       try:
-        result.parsed = json.loads(result.text)
+        if result.text is not None:
+          result.parsed = json.loads(result.text)
       # may not be a valid json per stream response
       except json.decoder.JSONDecodeError:
         pass
@@ -3080,20 +3091,22 @@ class GenerateContentResponse(_common.BaseModel):
       for union_type in union_types:
         if issubclass(union_type, pydantic.BaseModel):
           try:
+            if result.text is not None:
 
-            class Placeholder(pydantic.BaseModel):  # type: ignore[no-redef]
-              placeholder: response_schema
+              class Placeholder(pydantic.BaseModel):  # type: ignore[no-redef]
+                placeholder: response_schema  # type: ignore[valid-type]
 
-            parsed = {'placeholder': json.loads(result.text)}
-            placeholder = Placeholder.model_validate(parsed)
-            result.parsed = placeholder.placeholder
+              parsed = {'placeholder': json.loads(result.text)}
+              placeholder = Placeholder.model_validate(parsed)
+              result.parsed = placeholder.placeholder
           except json.decoder.JSONDecodeError:
             pass
           except pydantic.ValidationError:
             pass
         else:
           try:
-            result.parsed = json.loads(result.text)
+            if result.text is not None:
+              result.parsed = json.loads(result.text)
           # may not be a valid json per stream response
           except json.decoder.JSONDecodeError:
             pass
@@ -3602,18 +3615,23 @@ class Image(_common.BaseModel):
   """Image."""
 
   @classmethod
-  def from_file(cls, *, location: str) -> 'Image':
+  def from_file(
+      cls, *, location: str, mime_type: Optional[str] = None
+  ) -> 'Image':
     """Lazy-loads an image from a local file or Google Cloud Storage.
 
     Args:
         location: The local path or Google Cloud Storage URI from which to load
           the image.
+        mime_type: The MIME type of the image. If not provided, the MIME type
+          will be automatically determined.
 
     Returns:
         A loaded image as an `Image` object.
     """
     import urllib
     import pathlib
+    import mimetypes
 
     parsed_url = urllib.parse.urlparse(location)
     if (
@@ -3632,7 +3650,10 @@ class Image(_common.BaseModel):
 
     # Load image from local path
     image_bytes = pathlib.Path(location).read_bytes()
-    image = cls(image_bytes=image_bytes)
+
+    if not mime_type:
+      mime_type, _ = mimetypes.guess_type(location)
+    image = cls(image_bytes=image_bytes, mime_type=mime_type)
     return image
 
   def show(self):
@@ -3663,6 +3684,8 @@ class Image(_common.BaseModel):
             'The PIL module is not available. Please install the Pillow'
             ' package. `pip install pillow`'
         )
+      if self.image_bytes is None:
+        raise ValueError('The image bytes are not set.')
       self._loaded_image = PIL_Image.open(io.BytesIO(self.image_bytes))
     return self._loaded_image
 
@@ -3674,6 +3697,8 @@ class Image(_common.BaseModel):
     """
     import pathlib
 
+    if self.image_bytes is None:
+      raise ValueError('The image bytes are not set.')
     pathlib.Path(location).write_bytes(self.image_bytes)
 
 
@@ -3723,6 +3748,36 @@ class ImageDict(TypedDict, total=False):
 ImageOrDict = Union[Image, ImageDict]
 
 
+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.
+      """,
+  )
+  scores: Optional[list[float]] = Field(
+      default=None,
+      description="""List of scores of each categories.
+      """,
+  )
+
+
+class SafetyAttributesDict(TypedDict, total=False):
+  """Safety attributes of a GeneratedImage or the user-provided prompt."""
+
+  categories: Optional[list[str]]
+  """List of RAI categories.
+      """
+
+  scores: Optional[list[float]]
+  """List of scores of each categories.
+      """
+
+
+SafetyAttributesOrDict = Union[SafetyAttributes, SafetyAttributesDict]
+
+
 class GeneratedImage(_common.BaseModel):
   """An output image."""
 
@@ -3737,6 +3792,12 @@ class GeneratedImage(_common.BaseModel):
       response.
       """,
   )
+  safety_attributes: Optional[SafetyAttributes] = Field(
+      default=None,
+      description="""Safety attributes of the image. Lists of RAI categories and their
+      scores of each content.
+      """,
+  )
   enhanced_prompt: Optional[str] = Field(
       default=None,
       description="""The rewritten prompt used for the image generation if the prompt
@@ -3757,6 +3818,11 @@ class GeneratedImageDict(TypedDict, total=False):
       response.
       """
 
+  safety_attributes: Optional[SafetyAttributesDict]
+  """Safety attributes of the image. Lists of RAI categories and their
+      scores of each content.
+      """
+
   enhanced_prompt: Optional[str]
   """The rewritten prompt used for the image generation if the prompt
       enhancer is enabled.
@@ -4048,6 +4114,11 @@ class EditImageConfig(_common.BaseModel):
       default=None,
       description="""Describes the editing mode for the request.""",
   )
+  base_steps: Optional[int] = Field(
+      default=None,
+      description="""The number of sampling steps. A higher value has better image
+      quality, while a lower value has better latency.""",
+  )
 
 
 class EditImageConfigDict(TypedDict, total=False):
@@ -4116,6 +4187,10 @@ class EditImageConfigDict(TypedDict, total=False):
   edit_mode: Optional[EditMode]
   """Describes the editing mode for the request."""
 
+  base_steps: Optional[int]
+  """The number of sampling steps. A higher value has better image
+      quality, while a lower value has better latency."""
+
 
 EditImageConfigOrDict = Union[EditImageConfig, EditImageConfigDict]
 
@@ -5074,6 +5149,11 @@ class _GenerateVideosParameters(_common.BaseModel):
       default=None,
       description="""The text prompt for generating the videos. Optional for image to video use cases.""",
   )
+  image: Optional[Image] = Field(
+      default=None,
+      description="""The input image for generating the videos.
+      Optional if prompt is provided.""",
+  )
   config: Optional[GenerateVideosConfig] = Field(
       default=None, description="""Configuration for generating videos."""
   )
@@ -5089,6 +5169,10 @@ class _GenerateVideosParametersDict(TypedDict, total=False):
   prompt: Optional[str]
   """The text prompt for generating the videos. Optional for image to video use cases."""
 
+  image: Optional[ImageDict]
+  """The input image for generating the videos.
+      Optional if prompt is provided."""
+
   config: Optional[GenerateVideosConfigDict]
   """Configuration for generating videos."""
 
@@ -5130,14 +5214,16 @@ class Video(_common.BaseModel):
   def show(self):
     """Shows the video.
 
+    If the video has no mime_type, it is assumed to be video/mp4.
+
     This method only works in a notebook environment.
     """
-    if self.uri:
+    if self.uri and not self.video_bytes:
       return ValueError('Showing remote videos is not supported.')
     if not self.video_bytes:
       return ValueError('Video has no bytes.')
-    if not self.mime_type:
-      return ValueError('Mime type must be provided to display video.')
+
+    mime_type = self.mime_type or 'video/mp4'
 
     try:
       from IPython import display as IPython_display
@@ -5145,8 +5231,10 @@ class Video(_common.BaseModel):
       IPython_display = None
 
     if IPython_display:
-      return IPython_display.Video(
-          data=self.video_bytes, mimetype=self.mime_type, embed=True
+      IPython_display.display(
+          IPython_display.Video(
+              data=self.video_bytes, mimetype=mime_type, embed=True
+          )
       )
 
   def __repr__(self):

google/genai/version.py

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