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

google/genai/types.py

@@ -1124,6 +1124,63 @@ class ContentDict(TypedDict, total=False):
 ContentOrDict = Union[Content, ContentDict]
 
 
+class HttpRetryOptions(_common.BaseModel):
+  """HTTP retry options to be used in each of the requests."""
+
+  attempts: Optional[int] = Field(
+      default=None,
+      description="""Maximum number of attempts, including the original request.
+      If 0 or 1, it means no retries.""",
+  )
+  initial_delay: Optional[float] = Field(
+      default=None,
+      description="""Initial delay before the first retry, in fractions of a second.""",
+  )
+  max_delay: Optional[float] = Field(
+      default=None,
+      description="""Maximum delay between retries, in fractions of a second.""",
+  )
+  exp_base: Optional[float] = Field(
+      default=None,
+      description="""Multiplier by which the delay increases after each attempt.""",
+  )
+  jitter: Optional[float] = Field(
+      default=None, description="""Randomness factor for the delay."""
+  )
+  http_status_codes: Optional[list[int]] = Field(
+      default=None,
+      description="""List of HTTP status codes that should trigger a retry.
+      If not specified, a default set of retryable codes may be used.""",
+  )
+
+
+class HttpRetryOptionsDict(TypedDict, total=False):
+  """HTTP retry options to be used in each of the requests."""
+
+  attempts: Optional[int]
+  """Maximum number of attempts, including the original request.
+      If 0 or 1, it means no retries."""
+
+  initial_delay: Optional[float]
+  """Initial delay before the first retry, in fractions of a second."""
+
+  max_delay: Optional[float]
+  """Maximum delay between retries, in fractions of a second."""
+
+  exp_base: Optional[float]
+  """Multiplier by which the delay increases after each attempt."""
+
+  jitter: Optional[float]
+  """Randomness factor for the delay."""
+
+  http_status_codes: Optional[list[int]]
+  """List of HTTP status codes that should trigger a retry.
+      If not specified, a default set of retryable codes may be used."""
+
+
+HttpRetryOptionsOrDict = Union[HttpRetryOptions, HttpRetryOptionsDict]
+
+
 class HttpOptions(_common.BaseModel):
   """HTTP options to be used in each of the requests."""
 
@@ -1147,6 +1204,13 @@ class HttpOptions(_common.BaseModel):
   async_client_args: Optional[dict[str, Any]] = Field(
       default=None, description="""Args passed to the async HTTP client."""
   )
+  extra_body: Optional[dict[str, Any]] = Field(
+      default=None,
+      description="""Extra parameters to add to the request body.""",
+  )
+  retry_options: Optional[HttpRetryOptions] = Field(
+      default=None, description="""HTTP retry options for the request."""
+  )
 
 
 class HttpOptionsDict(TypedDict, total=False):
@@ -1170,6 +1234,12 @@ class HttpOptionsDict(TypedDict, total=False):
   async_client_args: Optional[dict[str, Any]]
   """Args passed to the async HTTP client."""
 
+  extra_body: Optional[dict[str, Any]]
+  """Extra parameters to add to the request body."""
+
+  retry_options: Optional[HttpRetryOptionsDict]
+  """HTTP retry options for the request."""
+
 
 HttpOptionsOrDict = Union[HttpOptions, HttpOptionsDict]
 
@@ -1616,22 +1686,22 @@ class Schema(_common.BaseModel):
         if field_value is None:
           continue
         if field_name not in google_schema_field_names:
-          raise ValueError((
+          raise ValueError(
               f'JSONSchema field "{field_name}" is not supported by the '
               'Schema object. And the "raise_error_on_unsupported_field" '
               'argument is set to True. If you still want to convert '
               'it into the Schema object, please either remove the field '
               f'"{field_name}" from the JSONSchema object, or leave the '
               '"raise_error_on_unsupported_field" unset.'
-          ))
+          )
         if (
             field_name in gemini_api_unsupported_field_names
             and api_option == 'GEMINI_API'
         ):
-          raise ValueError((
+          raise ValueError(
               f'The "{field_name}" field is not supported by the Schema '
               'object for GEMINI_API.'
-          ))
+          )
 
     def copy_schema_fields(
         json_schema_dict: dict[str, Any],
@@ -1916,10 +1986,18 @@ class FunctionDeclaration(_common.BaseModel):
       default=None,
       description="""Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1""",
   )
+  parameters_json_schema: Optional[Any] = Field(
+      default=None,
+      description="""Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`.""",
+  )
   response: Optional[Schema] = Field(
       default=None,
       description="""Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function.""",
   )
+  response_json_schema: Optional[Any] = Field(
+      default=None,
+      description="""Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`.""",
+  )
 
   @classmethod
   def from_callable_with_api_option(
@@ -2041,9 +2119,15 @@ class FunctionDeclarationDict(TypedDict, total=False):
   parameters: Optional[SchemaDict]
   """Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1"""
 
+  parameters_json_schema: Optional[Any]
+  """Optional. Describes the parameters to the function in JSON Schema format. The schema must describe an object where the properties are the parameters to the function. For example: ``` { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "integer" } }, "additionalProperties": false, "required": ["name", "age"], "propertyOrdering": ["name", "age"] } ``` This field is mutually exclusive with `parameters`."""
+
   response: Optional[SchemaDict]
   """Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function."""
 
+  response_json_schema: Optional[Any]
+  """Optional. Describes the output from this function in JSON Schema format. The value specified by the schema is the response value of the function. This field is mutually exclusive with `response`."""
+
 
 FunctionDeclarationOrDict = Union[FunctionDeclaration, FunctionDeclarationDict]
 
@@ -2375,6 +2459,42 @@ class UrlContextDict(TypedDict, total=False):
 UrlContextOrDict = Union[UrlContext, UrlContextDict]
 
 
+class VertexAISearchDataStoreSpec(_common.BaseModel):
+  """Define data stores within engine to filter on in a search call and configurations for those data stores.
+
+  For more information, see
+  https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+  """
+
+  data_store: Optional[str] = Field(
+      default=None,
+      description="""Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`""",
+  )
+  filter: Optional[str] = Field(
+      default=None,
+      description="""Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)""",
+  )
+
+
+class VertexAISearchDataStoreSpecDict(TypedDict, total=False):
+  """Define data stores within engine to filter on in a search call and configurations for those data stores.
+
+  For more information, see
+  https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc/google.cloud.discoveryengine.v1#datastorespec
+  """
+
+  data_store: Optional[str]
+  """Full resource name of DataStore, such as Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`"""
+
+  filter: Optional[str]
+  """Optional. Filter specification to filter documents in the data store specified by data_store field. For more information on filtering, see [Filtering](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)"""
+
+
+VertexAISearchDataStoreSpecOrDict = Union[
+    VertexAISearchDataStoreSpec, VertexAISearchDataStoreSpecDict
+]
+
+
 class VertexAISearch(_common.BaseModel):
   """Retrieve from Vertex AI Search datastore or engine for grounding.
 
@@ -2382,6 +2502,10 @@ class VertexAISearch(_common.BaseModel):
   https://cloud.google.com/products/agent-builder
   """
 
+  data_store_specs: Optional[list[VertexAISearchDataStoreSpec]] = Field(
+      default=None,
+      description="""Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used.""",
+  )
   datastore: Optional[str] = Field(
       default=None,
       description="""Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`""",
@@ -2407,6 +2531,9 @@ class VertexAISearchDict(TypedDict, total=False):
   https://cloud.google.com/products/agent-builder
   """
 
+  data_store_specs: Optional[list[VertexAISearchDataStoreSpecDict]]
+  """Specifications that define the specific DataStores to be searched, along with configurations for those data stores. This is only considered for Engines with multiple data stores. It should only be set if engine is used."""
+
   datastore: Optional[str]
   """Optional. Fully-qualified Vertex AI Search data store resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`"""
 
@@ -2632,6 +2759,10 @@ class VertexRagStore(_common.BaseModel):
       default=None,
       description="""Optional. Number of top k results to return from the selected corpora.""",
   )
+  store_context: Optional[bool] = Field(
+      default=None,
+      description="""Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions.""",
+  )
   vector_distance_threshold: Optional[float] = Field(
       default=None,
       description="""Optional. Only return results with vector distance smaller than the threshold.""",
@@ -2653,6 +2784,9 @@ class VertexRagStoreDict(TypedDict, total=False):
   similarity_top_k: Optional[int]
   """Optional. Number of top k results to return from the selected corpora."""
 
+  store_context: Optional[bool]
+  """Optional. Currently only supported for Gemini Multimodal Live API. In Gemini Multimodal Live API, if `store_context` bool is specified, Gemini will leverage it to automatically memorize the interactions between the client and Gemini, and retrieve context when needed to augment the response generation for users' ongoing and future interactions."""
+
   vector_distance_threshold: Optional[float]
   """Optional. Only return results with vector distance smaller than the threshold."""
 
@@ -6655,6 +6789,10 @@ class GenerationConfig(_common.BaseModel):
       default=None,
       description="""Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. 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="""Optional. Routing configuration."""
   )
@@ -6722,6 +6860,9 @@ class GenerationConfigDict(TypedDict, total=False):
   response_schema: Optional[SchemaDict]
   """Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. 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]
   """Optional. Routing configuration."""
 
@@ -6967,6 +7108,109 @@ ComputeTokensResponseOrDict = Union[
 ]
 
 
+class Video(_common.BaseModel):
+  """A generated video."""
+
+  uri: Optional[str] = Field(
+      default=None, description="""Path to another storage."""
+  )
+  video_bytes: Optional[bytes] = Field(
+      default=None, description="""Video bytes."""
+  )
+  mime_type: Optional[str] = Field(
+      default=None, description="""Video encoding, for example "video/mp4"."""
+  )
+
+  @classmethod
+  def from_file(
+      cls, *, location: str, mime_type: Optional[str] = None
+  ) -> 'Video':
+    """Loads a video from a local file.
+
+    Args:
+        location: The local path to load the video from.
+        mime_type: The MIME type of the video. If not provided, the MIME type
+          will be automatically determined.
+
+    Returns:
+        A loaded video as an `Video` object.
+    """
+    import mimetypes  # pylint: disable=g-import-not-at-top
+    import pathlib  # pylint: disable=g-import-not-at-top
+
+    video_bytes = pathlib.Path(location).read_bytes()
+
+    if not mime_type:
+      mime_type, _ = mimetypes.guess_type(location)
+    video = cls(video_bytes=video_bytes, mime_type=mime_type)
+    return video
+
+  def save(
+      self,
+      path: str,
+  ) -> None:
+    """Saves the video to a file.
+
+    Args:
+        path: Local path where to save the video.
+    """
+    import pathlib  # pylint: disable=g-import-not-at-top
+
+    if not self.video_bytes:
+      raise NotImplementedError('Saving remote videos is not supported.')
+
+    pathlib.Path(path).write_bytes(self.video_bytes)
+
+  def show(self) -> None:
+    """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 and not self.video_bytes:
+      raise ValueError('Showing remote videos is not supported.')
+    if not self.video_bytes:
+      raise ValueError('Video has no bytes.')
+
+    mime_type = self.mime_type or 'video/mp4'
+
+    try:
+      from IPython import display as IPython_display
+    except ImportError:
+      IPython_display = None
+
+    if IPython_display:
+      IPython_display.display(
+          IPython_display.Video(
+              data=self.video_bytes, mimetype=mime_type, embed=True
+          )
+      )
+
+  def __repr__(self) -> str:
+    video_bytes = '<video_bytes>' if self.video_bytes else 'None'
+    return (
+        f'Video(uri={self.uri}, video_bytes={video_bytes},'
+        f' mime_type={self.mime_type})'
+    )
+
+
+class VideoDict(TypedDict, total=False):
+  """A generated video."""
+
+  uri: Optional[str]
+  """Path to another storage."""
+
+  video_bytes: Optional[bytes]
+  """Video bytes."""
+
+  mime_type: Optional[str]
+  """Video encoding, for example "video/mp4"."""
+
+
+VideoOrDict = Union[Video, VideoDict]
+
+
 class GenerateVideosConfig(_common.BaseModel):
   """Configuration for generating videos."""
 
@@ -7018,6 +7262,10 @@ class GenerateVideosConfig(_common.BaseModel):
       default=None,
       description="""Whether to generate audio along with the video.""",
   )
+  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.""",
+  )
 
 
 class GenerateVideosConfigDict(TypedDict, total=False):
@@ -7062,6 +7310,9 @@ class GenerateVideosConfigDict(TypedDict, total=False):
   generate_audio: Optional[bool]
   """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."""
+
 
 GenerateVideosConfigOrDict = Union[
     GenerateVideosConfig, GenerateVideosConfigDict
@@ -7069,7 +7320,7 @@ GenerateVideosConfigOrDict = Union[
 
 
 class _GenerateVideosParameters(_common.BaseModel):
-  """Class that represents the parameters for generating an image."""
+  """Class that represents the parameters for generating videos."""
 
   model: Optional[str] = Field(
       default=None,
@@ -7083,7 +7334,12 @@ class _GenerateVideosParameters(_common.BaseModel):
   image: Optional[Image] = Field(
       default=None,
       description="""The input image for generating the videos.
-      Optional if prompt is provided.""",
+      Optional if prompt or 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.""",
   )
   config: Optional[GenerateVideosConfig] = Field(
       default=None, description="""Configuration for generating videos."""
@@ -7091,7 +7347,7 @@ class _GenerateVideosParameters(_common.BaseModel):
 
 
 class _GenerateVideosParametersDict(TypedDict, total=False):
-  """Class that represents the parameters for generating an image."""
+  """Class that represents the parameters for generating videos."""
 
   model: Optional[str]
   """ID of the model to use. For a list of models, see `Google models
@@ -7102,7 +7358,11 @@ class _GenerateVideosParametersDict(TypedDict, total=False):
 
   image: Optional[ImageDict]
   """The input image for generating the videos.
-      Optional if prompt is provided."""
+      Optional if prompt or video is provided."""
+
+  video: Optional[VideoDict]
+  """The input video for video extension use cases.
+      Optional if prompt or image is provided."""
 
   config: Optional[GenerateVideosConfigDict]
   """Configuration for generating videos."""
@@ -7113,85 +7373,6 @@ _GenerateVideosParametersOrDict = Union[
 ]
 
 
-class Video(_common.BaseModel):
-  """A generated video."""
-
-  uri: Optional[str] = Field(
-      default=None, description="""Path to another storage."""
-  )
-  video_bytes: Optional[bytes] = Field(
-      default=None, description="""Video bytes."""
-  )
-  mime_type: Optional[str] = Field(
-      default=None, description="""Video encoding, for example "video/mp4"."""
-  )
-
-  def save(
-      self,
-      path: str,
-  ) -> None:
-    """Saves the video to a file.
-
-    Args:
-        path: Local path where to save the video.
-    """
-    import pathlib  # pylint: disable=g-import-not-at-top
-
-    if not self.video_bytes:
-      raise NotImplementedError('Saving remote videos is not supported.')
-
-    pathlib.Path(path).write_bytes(self.video_bytes)
-
-  def show(self) -> None:
-    """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 and not self.video_bytes:
-      raise ValueError('Showing remote videos is not supported.')
-    if not self.video_bytes:
-      raise ValueError('Video has no bytes.')
-
-    mime_type = self.mime_type or 'video/mp4'
-
-    try:
-      from IPython import display as IPython_display
-    except ImportError:
-      IPython_display = None
-
-    if IPython_display:
-      IPython_display.display(
-          IPython_display.Video(
-              data=self.video_bytes, mimetype=mime_type, embed=True
-          )
-      )
-
-  def __repr__(self) -> str:
-    video_bytes = '<video_bytes>' if self.video_bytes else 'None'
-    return (
-        f'Video(uri={self.uri}, video_bytes={video_bytes},'
-        f' mime_type={self.mime_type})'
-    )
-
-
-class VideoDict(TypedDict, total=False):
-  """A generated video."""
-
-  uri: Optional[str]
-  """Path to another storage."""
-
-  video_bytes: Optional[bytes]
-  """Video bytes."""
-
-  mime_type: Optional[str]
-  """Video encoding, for example "video/mp4"."""
-
-
-VideoOrDict = Union[Video, VideoDict]
-
-
 class GeneratedVideo(_common.BaseModel):
   """A generated video."""
 
@@ -9169,6 +9350,10 @@ class CreateFileConfig(_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.""",
+  )
 
 
 class CreateFileConfigDict(TypedDict, total=False):
@@ -9177,6 +9362,9 @@ class CreateFileConfigDict(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."""
+
 
 CreateFileConfigOrDict = Union[CreateFileConfig, CreateFileConfigDict]
 
@@ -9219,20 +9407,45 @@ _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."""
 
-  http_headers: Optional[dict[str, str]] = Field(
-      default=None,
-      description="""Used to retain the HTTP headers in the request""",
+  sdk_http_response: Optional[HttpResponse] = Field(
+      default=None, description="""Used to retain the full HTTP response."""
   )
 
 
 class CreateFileResponseDict(TypedDict, total=False):
   """Response for the create file method."""
 
-  http_headers: Optional[dict[str, str]]
-  """Used to retain the HTTP headers in the request"""
+  sdk_http_response: Optional[HttpResponseDict]
+  """Used to retain the full HTTP response."""
 
 
 CreateFileResponseOrDict = Union[CreateFileResponse, CreateFileResponseDict]

google/genai/version.py

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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-genai
-Version: 1.19.0
+Version: 1.21.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License: Apache-2.0
@@ -25,8 +25,11 @@ Requires-Dist: google-auth<3.0.0,>=2.14.1
 Requires-Dist: httpx<1.0.0,>=0.28.1
 Requires-Dist: pydantic<3.0.0,>=2.0.0
 Requires-Dist: requests<3.0.0,>=2.28.1
+Requires-Dist: tenacity<9.0.0,>=8.2.3
 Requires-Dist: websockets<15.1.0,>=13.0.0
 Requires-Dist: typing-extensions<5.0.0,>=4.11.0
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp<4.0.0; extra == "aiohttp"
 Dynamic: license-file
 
 # Google Gen AI SDK
@@ -140,6 +143,49 @@ client = genai.Client(
 )
 ```
 
+### Faster async client option: Aiohttp
+
+By default we use httpx for both sync and async client implementations. In order
+to have faster performance, you may install `google-genai[aiohttp]`. In Gen AI
+SDK we configure `trust_env=True` to match with the default behavior of httpx.
+Additional args of `aiohttp.ClientSession.request()` ([see _RequestOptions args](https://github.com/aio-libs/aiohttp/blob/v3.12.13/aiohttp/client.py#L170)) can be passed
+through the following way:
+
+```python
+
+http_options = types.HttpOptions(
+    async_client_args={'cookies': ..., 'ssl': ...},
+)
+
+client=Client(..., http_options=http_options)
+```
+
+### Proxy
+
+Both httpx and aiohttp libraries use `urllib.request.getproxies` from
+environment variables. Before client initialization, you may set proxy (and
+optional SSL_CERT_FILE) by setting the environment variables:
+
+
+```bash
+export HTTPS_PROXY='http://username:password@proxy_uri:port'
+export SSL_CERT_FILE='client.pem'
+```
+
+If you need `socks5` proxy, httpx [supports](https://www.python-httpx.org/advanced/proxies/#socks) `socks5` proxy if you pass it via
+args to `httpx.Client()`. You may install `httpx[socks]` to use it.
+Then, you can pass it through the following way:
+
+```python
+
+http_options = types.HttpOptions(
+    client_args={'proxy': 'socks5://user:pass@host:port'},
+    async_client_args={'proxy': 'socks5://user:pass@host:port'},,
+)
+
+client=Client(..., http_options=http_options)
+```
+
 ## Types
 
 Parameter types can be specified as either dictionaries(`TypedDict`) or