google-genai 1.21.0__py3-none-any.whl → 1.22.0__py3-none-any.whl

google/genai/types.py

@@ -435,8 +435,11 @@ class PersonGeneration(_common.CaseInSensitiveEnum):
   """Enum that controls the generation of people."""
 
   DONT_ALLOW = 'DONT_ALLOW'
+  """Block generation of images of people."""
   ALLOW_ADULT = 'ALLOW_ADULT'
+  """Generate images of adults, but not children."""
   ALLOW_ALL = 'ALLOW_ALL'
+  """Generate images that include adults and children."""
 
 
 class ImagePromptLanguage(_common.CaseInSensitiveEnum):
@@ -490,6 +493,17 @@ class EditMode(_common.CaseInSensitiveEnum):
   EDIT_MODE_PRODUCT_IMAGE = 'EDIT_MODE_PRODUCT_IMAGE'
 
 
+class VideoCompressionQuality(_common.CaseInSensitiveEnum):
+  """Enum that controls the compression quality of the generated videos."""
+
+  OPTIMIZED = 'OPTIMIZED'
+  """Optimized video compression quality. This will produce videos
+      with a compressed, smaller file size."""
+  LOSSLESS = 'LOSSLESS'
+  """Lossless video compression quality. This will produce videos
+      with a larger file size."""
+
+
 class FileState(_common.CaseInSensitiveEnum):
   """State for the lifecycle of a File."""
 
@@ -3257,7 +3271,7 @@ class ThinkingConfig(_common.BaseModel):
   )
   thinking_budget: Optional[int] = Field(
       default=None,
-      description="""Indicates the thinking budget in tokens.
+      description="""Indicates the thinking budget in tokens. 0 is DISABLED. -1 is AUTOMATIC. The default values and allowed ranges are model dependent.
       """,
   )
 
@@ -3270,7 +3284,7 @@ class ThinkingConfigDict(TypedDict, total=False):
       """
 
   thinking_budget: Optional[int]
-  """Indicates the thinking budget in tokens.
+  """Indicates the thinking budget in tokens. 0 is DISABLED. -1 is AUTOMATIC. The default values and allowed ranges are model dependent.
       """
 
 
@@ -3617,6 +3631,24 @@ class GenerateContentConfig(_common.BaseModel):
       Compatible mimetypes: `application/json`: Schema for JSON response.
       """,
   )
+  response_json_schema: Optional[Any] = Field(
+      default=None,
+      description="""Optional. Output schema of the generated response.
+      This is an alternative to `response_schema` that accepts [JSON
+      Schema](https://json-schema.org/). If set, `response_schema` must be
+      omitted, but `response_mime_type` is required. While the full JSON Schema
+      may be sent, not all features are supported. Specifically, only the
+      following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor`
+      - `type` - `format` - `title` - `description` - `enum` (for strings and
+      numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
+      `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) -
+      `properties` - `additionalProperties` - `required` The non-standard
+      `propertyOrdering` property may also be set. Cyclic references are
+      unrolled to a limited degree and, as such, may only be used within
+      non-required properties. (Nullable properties are not sufficient.) If
+      `$ref` is set on a sub-schema, no other properties, except for than those
+      starting as a `$`, may be set.""",
+  )
   routing_config: Optional[GenerationConfigRoutingConfig] = Field(
       default=None,
       description="""Configuration for model router requests.
@@ -3799,6 +3831,23 @@ class GenerateContentConfigDict(TypedDict, total=False):
       Compatible mimetypes: `application/json`: Schema for JSON response.
       """
 
+  response_json_schema: Optional[Any]
+  """Optional. Output schema of the generated response.
+      This is an alternative to `response_schema` that accepts [JSON
+      Schema](https://json-schema.org/). If set, `response_schema` must be
+      omitted, but `response_mime_type` is required. While the full JSON Schema
+      may be sent, not all features are supported. Specifically, only the
+      following properties are supported: - `$id` - `$defs` - `$ref` - `$anchor`
+      - `type` - `format` - `title` - `description` - `enum` (for strings and
+      numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` -
+      `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) -
+      `properties` - `additionalProperties` - `required` The non-standard
+      `propertyOrdering` property may also be set. Cyclic references are
+      unrolled to a limited degree and, as such, may only be used within
+      non-required properties. (Nullable properties are not sufficient.) If
+      `$ref` is set on a sub-schema, no other properties, except for than those
+      starting as a `$`, may be set."""
+
   routing_config: Optional[GenerationConfigRoutingConfigDict]
   """Configuration for model router requests.
       """
@@ -3908,6 +3957,32 @@ _GenerateContentParametersOrDict = Union[
 ]
 
 
+class HttpResponse(_common.BaseModel):
+  """A wrapper class for the http response."""
+
+  headers: Optional[dict[str, str]] = Field(
+      default=None,
+      description="""Used to retain the processed HTTP headers in the response.""",
+  )
+  body: Optional[str] = Field(
+      default=None,
+      description="""The raw HTTP response body, in JSON format.""",
+  )
+
+
+class HttpResponseDict(TypedDict, total=False):
+  """A wrapper class for the http response."""
+
+  headers: Optional[dict[str, str]]
+  """Used to retain the processed HTTP headers in the response."""
+
+  body: Optional[str]
+  """The raw HTTP response body, in JSON format."""
+
+
+HttpResponseOrDict = Union[HttpResponse, HttpResponseDict]
+
+
 class GoogleTypeDate(_common.BaseModel):
   """Represents a whole or partial calendar date, such as a birthday.
 
@@ -4773,6 +4848,9 @@ GenerateContentResponseUsageMetadataOrDict = Union[
 class GenerateContentResponse(_common.BaseModel):
   """Response message for PredictionService.GenerateContent."""
 
+  sdk_http_response: Optional[HttpResponse] = Field(
+      default=None, description="""Used to retain the full HTTP response."""
+  )
   candidates: Optional[list[Candidate]] = Field(
       default=None,
       description="""Response variations returned by the model.
@@ -5025,6 +5103,9 @@ class GenerateContentResponse(_common.BaseModel):
 class GenerateContentResponseDict(TypedDict, total=False):
   """Response message for PredictionService.GenerateContent."""
 
+  sdk_http_response: Optional[HttpResponseDict]
+  """Used to retain the full HTTP response."""
+
   candidates: Optional[list[CandidateDict]]
   """Response variations returned by the model.
       """
@@ -5316,7 +5397,8 @@ class GenerateImagesConfig(_common.BaseModel):
   )
   aspect_ratio: Optional[str] = Field(
       default=None,
-      description="""Aspect ratio of the generated images.
+      description="""Aspect ratio of the generated images. Supported values are
+      "1:1", "3:4", "4:3", "9:16", and "16:9".
       """,
   )
   guidance_scale: Optional[float] = Field(
@@ -5401,7 +5483,8 @@ class GenerateImagesConfigDict(TypedDict, total=False):
       """
 
   aspect_ratio: Optional[str]
-  """Aspect ratio of the generated images.
+  """Aspect ratio of the generated images. Supported values are
+      "1:1", "3:4", "4:3", "9:16", and "16:9".
       """
 
   guidance_scale: Optional[float]
@@ -5987,7 +6070,8 @@ class EditImageConfig(_common.BaseModel):
   )
   aspect_ratio: Optional[str] = Field(
       default=None,
-      description="""Aspect ratio of the generated images.
+      description="""Aspect ratio of the generated images. Supported values are
+      "1:1", "3:4", "4:3", "9:16", and "16:9".
       """,
   )
   guidance_scale: Optional[float] = Field(
@@ -6071,7 +6155,8 @@ class EditImageConfigDict(TypedDict, total=False):
       """
 
   aspect_ratio: Optional[str]
-  """Aspect ratio of the generated images.
+  """Aspect ratio of the generated images. Supported values are
+      "1:1", "3:4", "4:3", "9:16", and "16:9".
       """
 
   guidance_scale: Optional[float]
@@ -6208,6 +6293,19 @@ class _UpscaleImageAPIConfig(_common.BaseModel):
       description="""The level of compression if the ``output_mime_type`` is
       ``image/jpeg``.""",
   )
+  enhance_input_image: Optional[bool] = Field(
+      default=None,
+      description="""Whether to add an image enhancing step before upscaling.
+      It is expected to suppress the noise and JPEG compression artifacts
+      from the input image.""",
+  )
+  image_preservation_factor: Optional[float] = Field(
+      default=None,
+      description="""With a higher image preservation factor, the original image
+      pixels are more respected. With a lower image preservation factor, the
+      output image will have be more different from the input image, but
+      with finer details and less noise.""",
+  )
   number_of_images: Optional[int] = Field(default=None, description="""""")
   mode: Optional[str] = Field(default=None, description="""""")
 
@@ -6233,6 +6331,17 @@ class _UpscaleImageAPIConfigDict(TypedDict, total=False):
   """The level of compression if the ``output_mime_type`` is
       ``image/jpeg``."""
 
+  enhance_input_image: Optional[bool]
+  """Whether to add an image enhancing step before upscaling.
+      It is expected to suppress the noise and JPEG compression artifacts
+      from the input image."""
+
+  image_preservation_factor: Optional[float]
+  """With a higher image preservation factor, the original image
+      pixels are more respected. With a lower image preservation factor, the
+      output image will have be more different from the input image, but
+      with finer details and less noise."""
+
   number_of_images: Optional[int]
   """"""
 
@@ -7266,6 +7375,10 @@ class GenerateVideosConfig(_common.BaseModel):
       default=None,
       description="""Image to use as the last frame of generated videos. Only supported for image to video use cases.""",
   )
+  compression_quality: Optional[VideoCompressionQuality] = Field(
+      default=None,
+      description="""Compression quality of the generated videos.""",
+  )
 
 
 class GenerateVideosConfigDict(TypedDict, total=False):
@@ -7313,6 +7426,9 @@ class GenerateVideosConfigDict(TypedDict, total=False):
   last_frame: Optional[ImageDict]
   """Image to use as the last frame of generated videos. Only supported for image to video use cases."""
 
+  compression_quality: Optional[VideoCompressionQuality]
+  """Compression quality of the generated videos."""
+
 
 GenerateVideosConfigOrDict = Union[
     GenerateVideosConfig, GenerateVideosConfigDict
@@ -9407,32 +9523,6 @@ _CreateFileParametersOrDict = Union[
 ]
 
 
-class HttpResponse(_common.BaseModel):
-  """A wrapper class for the http response."""
-
-  headers: Optional[dict[str, str]] = Field(
-      default=None,
-      description="""Used to retain the processed HTTP headers in the response.""",
-  )
-  body: Optional[str] = Field(
-      default=None,
-      description="""The raw HTTP response body, in JSON format.""",
-  )
-
-
-class HttpResponseDict(TypedDict, total=False):
-  """A wrapper class for the http response."""
-
-  headers: Optional[dict[str, str]]
-  """Used to retain the processed HTTP headers in the response."""
-
-  body: Optional[str]
-  """The raw HTTP response body, in JSON format."""
-
-
-HttpResponseOrDict = Union[HttpResponse, HttpResponseDict]
-
-
 class CreateFileResponse(_common.BaseModel):
   """Response for the create file method."""
 
@@ -9556,6 +9646,45 @@ class DeleteFileResponseDict(TypedDict, total=False):
 DeleteFileResponseOrDict = Union[DeleteFileResponse, DeleteFileResponseDict]
 
 
+class InlinedRequest(_common.BaseModel):
+  """Config for inlined request."""
+
+  model: Optional[str] = Field(
+      default=None,
+      description="""ID of the model to use. For a list of models, see `Google models
+      <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`_.""",
+  )
+  contents: Optional[ContentListUnion] = Field(
+      default=None,
+      description="""Content of the request.
+      """,
+  )
+  config: Optional[GenerateContentConfig] = Field(
+      default=None,
+      description="""Configuration that contains optional model parameters.
+      """,
+  )
+
+
+class InlinedRequestDict(TypedDict, total=False):
+  """Config for inlined request."""
+
+  model: Optional[str]
+  """ID of the model to use. For a list of models, see `Google models
+      <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`_."""
+
+  contents: Optional[ContentListUnionDict]
+  """Content of the request.
+      """
+
+  config: Optional[GenerateContentConfigDict]
+  """Configuration that contains optional model parameters.
+      """
+
+
+InlinedRequestOrDict = Union[InlinedRequest, InlinedRequestDict]
+
+
 class BatchJobSource(_common.BaseModel):
   """Config for `src` parameter."""
 
@@ -9575,6 +9704,17 @@ class BatchJobSource(_common.BaseModel):
       description="""The BigQuery URI to input table.
       """,
   )
+  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[list[InlinedRequest]] = Field(
+      default=None,
+      description="""The Gemini Developer API's inlined input data to run batch job.
+      """,
+  )
 
 
 class BatchJobSourceDict(TypedDict, total=False):
@@ -9593,10 +9733,79 @@ class BatchJobSourceDict(TypedDict, total=False):
   """The BigQuery URI to input table.
       """
 
+  file_name: Optional[str]
+  """The Gemini Developer API's file resource name of the input data
+      (e.g. "files/12345").
+      """
+
+  inlined_requests: Optional[list[InlinedRequestDict]]
+  """The Gemini Developer API's inlined input data to run batch job.
+      """
+
 
 BatchJobSourceOrDict = Union[BatchJobSource, BatchJobSourceDict]
 
 
+class JobError(_common.BaseModel):
+  """Job error."""
+
+  details: Optional[list[str]] = Field(
+      default=None,
+      description="""A list of messages that carry the error details. There is a common set of message types for APIs to use.""",
+  )
+  code: Optional[int] = Field(default=None, description="""The status code.""")
+  message: Optional[str] = Field(
+      default=None,
+      description="""A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `details` field.""",
+  )
+
+
+class JobErrorDict(TypedDict, total=False):
+  """Job error."""
+
+  details: Optional[list[str]]
+  """A list of messages that carry the error details. There is a common set of message types for APIs to use."""
+
+  code: Optional[int]
+  """The status code."""
+
+  message: Optional[str]
+  """A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `details` field."""
+
+
+JobErrorOrDict = Union[JobError, JobErrorDict]
+
+
+class InlinedResponse(_common.BaseModel):
+  """Config for `inlined_responses` parameter."""
+
+  response: Optional[GenerateContentResponse] = Field(
+      default=None,
+      description="""The response to the request.
+      """,
+  )
+  error: Optional[JobError] = Field(
+      default=None,
+      description="""The error encountered while processing the request.
+      """,
+  )
+
+
+class InlinedResponseDict(TypedDict, total=False):
+  """Config for `inlined_responses` parameter."""
+
+  response: Optional[GenerateContentResponseDict]
+  """The response to the request.
+      """
+
+  error: Optional[JobErrorDict]
+  """The error encountered while processing the request.
+      """
+
+
+InlinedResponseOrDict = Union[InlinedResponse, InlinedResponseDict]
+
+
 class BatchJobDestination(_common.BaseModel):
   """Config for `des` parameter."""
 
@@ -9616,6 +9825,22 @@ class BatchJobDestination(_common.BaseModel):
       description="""The BigQuery URI to the output table.
       """,
   )
+  file_name: Optional[str] = Field(
+      default=None,
+      description="""The Gemini Developer API's file resource name of the output data
+      (e.g. "files/12345"). The file will be a JSONL file with a single response
+      per line. The responses will be GenerateContentResponse messages formatted
+      as JSON. The responses will be written in the same order as the input
+      requests.
+      """,
+  )
+  inlined_responses: Optional[list[InlinedResponse]] = 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):
@@ -9634,6 +9859,20 @@ class BatchJobDestinationDict(TypedDict, total=False):
   """The BigQuery URI to the output table.
       """
 
+  file_name: Optional[str]
+  """The Gemini Developer API's file resource name of the output data
+      (e.g. "files/12345"). The file will be a JSONL file with a single response
+      per line. The responses will be GenerateContentResponse messages formatted
+      as JSON. The responses will be written in the same order as the input
+      requests.
+      """
+
+  inlined_responses: Optional[list[InlinedResponseDict]]
+  """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]
 
@@ -9678,6 +9917,14 @@ CreateBatchJobConfigOrDict = Union[
 ]
 
 
+BatchJobSourceUnion = Union[BatchJobSource, list[InlinedRequest], str]
+
+
+BatchJobSourceUnionDict = Union[
+    BatchJobSourceUnion, BatchJobSourceDict, list[InlinedRequestDict]
+]
+
+
 class _CreateBatchJobParameters(_common.BaseModel):
   """Config for batches.create parameters."""
 
@@ -9686,7 +9933,7 @@ class _CreateBatchJobParameters(_common.BaseModel):
       description="""The name of the model to produces the predictions via the BatchJob.
       """,
   )
-  src: Optional[str] = Field(
+  src: Optional[BatchJobSourceUnion] = Field(
       default=None,
       description="""GCS URI(-s) or BigQuery URI to your input data to run batch job.
       Example: "gs://path/to/input/data" or "bq://projectId.bqDatasetId.bqTableId".
@@ -9706,7 +9953,7 @@ class _CreateBatchJobParametersDict(TypedDict, total=False):
   """The name of the model to produces the predictions via the BatchJob.
       """
 
-  src: Optional[str]
+  src: Optional[BatchJobSourceUnionDict]
   """GCS URI(-s) or BigQuery URI to your input data to run batch job.
       Example: "gs://path/to/input/data" or "bq://projectId.bqDatasetId.bqTableId".
       """
@@ -9721,48 +9968,23 @@ _CreateBatchJobParametersOrDict = Union[
 ]
 
 
-class JobError(_common.BaseModel):
-  """Job error."""
-
-  details: Optional[list[str]] = Field(
-      default=None,
-      description="""A list of messages that carry the error details. There is a common set of message types for APIs to use.""",
-  )
-  code: Optional[int] = Field(default=None, description="""The status code.""")
-  message: Optional[str] = Field(
-      default=None,
-      description="""A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `details` field.""",
-  )
-
-
-class JobErrorDict(TypedDict, total=False):
-  """Job error."""
-
-  details: Optional[list[str]]
-  """A list of messages that carry the error details. There is a common set of message types for APIs to use."""
-
-  code: Optional[int]
-  """The status code."""
-
-  message: Optional[str]
-  """A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `details` field."""
-
-
-JobErrorOrDict = Union[JobError, JobErrorDict]
-
-
 class BatchJob(_common.BaseModel):
   """Config for batches.create return value."""
 
   name: Optional[str] = Field(
-      default=None, description="""Output only. Resource name of the Job."""
+      default=None,
+      description="""The resource name of the BatchJob. Output only.".
+      """,
   )
   display_name: Optional[str] = Field(
-      default=None, description="""The user-defined name of this Job."""
+      default=None,
+      description="""The display name of the BatchJob.
+      """,
   )
   state: Optional[JobState] = Field(
       default=None,
-      description="""Output only. The detailed state of the job.""",
+      description="""The state of the BatchJob.
+      """,
   )
   error: Optional[JobError] = Field(
       default=None,
@@ -9770,7 +9992,8 @@ class BatchJob(_common.BaseModel):
   )
   create_time: Optional[datetime.datetime] = Field(
       default=None,
-      description="""Output only. Time when the Job was created.""",
+      description="""The time when the BatchJob was created.
+      """,
   )
   start_time: Optional[datetime.datetime] = Field(
       default=None,
@@ -9778,11 +10001,13 @@ class BatchJob(_common.BaseModel):
   )
   end_time: Optional[datetime.datetime] = Field(
       default=None,
-      description="""Output only. Time when the Job entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.""",
+      description="""The time when the BatchJob was completed.
+      """,
   )
   update_time: Optional[datetime.datetime] = Field(
       default=None,
-      description="""Output only. Time when the Job was most recently updated.""",
+      description="""The time when the BatchJob was last updated.
+      """,
   )
   model: Optional[str] = Field(
       default=None,
@@ -9805,28 +10030,34 @@ class BatchJobDict(TypedDict, total=False):
   """Config for batches.create return value."""
 
   name: Optional[str]
-  """Output only. Resource name of the Job."""
+  """The resource name of the BatchJob. Output only.".
+      """
 
   display_name: Optional[str]
-  """The user-defined name of this Job."""
+  """The display name of the BatchJob.
+      """
 
   state: Optional[JobState]
-  """Output only. The detailed state of the job."""
+  """The state of the BatchJob.
+      """
 
   error: Optional[JobErrorDict]
   """Output only. Only populated when the job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED."""
 
   create_time: Optional[datetime.datetime]
-  """Output only. Time when the Job was created."""
+  """The time when the BatchJob was created.
+      """
 
   start_time: Optional[datetime.datetime]
   """Output only. Time when the Job for the first time entered the `JOB_STATE_RUNNING` state."""
 
   end_time: Optional[datetime.datetime]
-  """Output only. Time when the Job entered any of the following states: `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`."""
+  """The time when the BatchJob was completed.
+      """
 
   update_time: Optional[datetime.datetime]
-  """Output only. Time when the Job was most recently updated."""
+  """The time when the BatchJob was last updated.
+      """
 
   model: Optional[str]
   """The name of the model that produces the predictions via the BatchJob.
@@ -10470,6 +10701,19 @@ class UpscaleImageConfig(_common.BaseModel):
       description="""The level of compression if the ``output_mime_type`` is
       ``image/jpeg``.""",
   )
+  enhance_input_image: Optional[bool] = Field(
+      default=None,
+      description="""Whether to add an image enhancing step before upscaling.
+      It is expected to suppress the noise and JPEG compression artifacts
+      from the input image.""",
+  )
+  image_preservation_factor: Optional[float] = Field(
+      default=None,
+      description="""With a higher image preservation factor, the original image
+      pixels are more respected. With a lower image preservation factor, the
+      output image will have be more different from the input image, but
+      with finer details and less noise.""",
+  )
 
 
 class UpscaleImageConfigDict(TypedDict, total=False):
@@ -10494,6 +10738,17 @@ class UpscaleImageConfigDict(TypedDict, total=False):
   """The level of compression if the ``output_mime_type`` is
       ``image/jpeg``."""
 
+  enhance_input_image: Optional[bool]
+  """Whether to add an image enhancing step before upscaling.
+      It is expected to suppress the noise and JPEG compression artifacts
+      from the input image."""
+
+  image_preservation_factor: Optional[float]
+  """With a higher image preservation factor, the original image
+      pixels are more respected. With a lower image preservation factor, the
+      output image will have be more different from the input image, but
+      with finer details and less noise."""
+
 
 UpscaleImageConfigOrDict = Union[UpscaleImageConfig, UpscaleImageConfigDict]
 

google/genai/version.py

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

{google_genai-1.21.0.dist-info → google_genai-1.22.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-genai
-Version: 1.21.0
+Version: 1.22.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache-2.0