google-genai 1.5.0__py3-none-any.whl → 1.7.0__py3-none-any.whl

google/genai/models.py

@@ -175,15 +175,9 @@ def _Schema_to_mldev(
   if getv(from_object, ['pattern']) is not None:
     raise ValueError('pattern parameter is not supported in Gemini API.')
 
-  if getv(from_object, ['minimum']) is not None:
-    raise ValueError('minimum parameter is not supported in Gemini API.')
-
   if getv(from_object, ['default']) is not None:
     raise ValueError('default parameter is not supported in Gemini API.')
 
-  if getv(from_object, ['any_of']) is not None:
-    raise ValueError('any_of parameter is not supported in Gemini API.')
-
   if getv(from_object, ['max_length']) is not None:
     raise ValueError('max_length parameter is not supported in Gemini API.')
 
@@ -196,12 +190,12 @@ def _Schema_to_mldev(
   if getv(from_object, ['min_properties']) is not None:
     raise ValueError('min_properties parameter is not supported in Gemini API.')
 
-  if getv(from_object, ['maximum']) is not None:
-    raise ValueError('maximum parameter is not supported in Gemini API.')
-
   if getv(from_object, ['max_properties']) is not None:
     raise ValueError('max_properties parameter is not supported in Gemini API.')
 
+  if getv(from_object, ['any_of']) is not None:
+    setv(to_object, ['anyOf'], getv(from_object, ['any_of']))
+
   if getv(from_object, ['description']) is not None:
     setv(to_object, ['description'], getv(from_object, ['description']))
 
@@ -217,9 +211,15 @@ def _Schema_to_mldev(
   if getv(from_object, ['max_items']) is not None:
     setv(to_object, ['maxItems'], getv(from_object, ['max_items']))
 
+  if getv(from_object, ['maximum']) is not None:
+    setv(to_object, ['maximum'], getv(from_object, ['maximum']))
+
   if getv(from_object, ['min_items']) is not None:
     setv(to_object, ['minItems'], getv(from_object, ['min_items']))
 
+  if getv(from_object, ['minimum']) is not None:
+    setv(to_object, ['minimum'], getv(from_object, ['minimum']))
+
   if getv(from_object, ['nullable']) is not None:
     setv(to_object, ['nullable'], getv(from_object, ['nullable']))
 
@@ -254,15 +254,9 @@ def _Schema_to_vertex(
   if getv(from_object, ['pattern']) is not None:
     setv(to_object, ['pattern'], getv(from_object, ['pattern']))
 
-  if getv(from_object, ['minimum']) is not None:
-    setv(to_object, ['minimum'], getv(from_object, ['minimum']))
-
   if getv(from_object, ['default']) is not None:
     setv(to_object, ['default'], getv(from_object, ['default']))
 
-  if getv(from_object, ['any_of']) is not None:
-    setv(to_object, ['anyOf'], getv(from_object, ['any_of']))
-
   if getv(from_object, ['max_length']) is not None:
     setv(to_object, ['maxLength'], getv(from_object, ['max_length']))
 
@@ -275,12 +269,12 @@ def _Schema_to_vertex(
   if getv(from_object, ['min_properties']) is not None:
     setv(to_object, ['minProperties'], getv(from_object, ['min_properties']))
 
-  if getv(from_object, ['maximum']) is not None:
-    setv(to_object, ['maximum'], getv(from_object, ['maximum']))
-
   if getv(from_object, ['max_properties']) is not None:
     setv(to_object, ['maxProperties'], getv(from_object, ['max_properties']))
 
+  if getv(from_object, ['any_of']) is not None:
+    setv(to_object, ['anyOf'], getv(from_object, ['any_of']))
+
   if getv(from_object, ['description']) is not None:
     setv(to_object, ['description'], getv(from_object, ['description']))
 
@@ -296,9 +290,15 @@ def _Schema_to_vertex(
   if getv(from_object, ['max_items']) is not None:
     setv(to_object, ['maxItems'], getv(from_object, ['max_items']))
 
+  if getv(from_object, ['maximum']) is not None:
+    setv(to_object, ['maximum'], getv(from_object, ['maximum']))
+
   if getv(from_object, ['min_items']) is not None:
     setv(to_object, ['minItems'], getv(from_object, ['min_items']))
 
+  if getv(from_object, ['minimum']) is not None:
+    setv(to_object, ['minimum'], getv(from_object, ['minimum']))
+
   if getv(from_object, ['nullable']) is not None:
     setv(to_object, ['nullable'], getv(from_object, ['nullable']))
 
@@ -1351,10 +1351,8 @@ def _GenerateImagesConfig_to_mldev(
     raise ValueError('output_gcs_uri parameter is not supported in Gemini API.')
 
   if getv(from_object, ['negative_prompt']) is not None:
-    setv(
-        parent_object,
-        ['parameters', 'negativePrompt'],
-        getv(from_object, ['negative_prompt']),
+    raise ValueError(
+        'negative_prompt parameter is not supported in Gemini API.'
     )
 
   if getv(from_object, ['number_of_images']) is not None:
@@ -1910,10 +1908,8 @@ def _EditImageConfig_to_mldev(
     raise ValueError('output_gcs_uri parameter is not supported in Gemini API.')
 
   if getv(from_object, ['negative_prompt']) is not None:
-    setv(
-        parent_object,
-        ['parameters', 'negativePrompt'],
-        getv(from_object, ['negative_prompt']),
+    raise ValueError(
+        'negative_prompt parameter is not supported in Gemini API.'
     )
 
   if getv(from_object, ['number_of_images']) is not None:
@@ -2003,6 +1999,9 @@ def _EditImageConfig_to_mldev(
         getv(from_object, ['edit_mode']),
     )
 
+  if getv(from_object, ['base_steps']) is not None:
+    raise ValueError('base_steps parameter is not supported in Gemini API.')
+
   return to_object
 
 
@@ -2107,6 +2106,13 @@ def _EditImageConfig_to_vertex(
         getv(from_object, ['edit_mode']),
     )
 
+  if getv(from_object, ['base_steps']) is not None:
+    setv(
+        parent_object,
+        ['parameters', 'editConfig', 'baseSteps'],
+        getv(from_object, ['base_steps']),
+    )
+
   return to_object
 
 
@@ -3561,6 +3567,48 @@ def _Image_from_vertex(
   return to_object
 
 
+def _SafetyAttributes_from_mldev(
+    api_client: BaseApiClient,
+    from_object: Union[dict, object],
+    parent_object: Optional[dict] = None,
+) -> dict:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['safetyAttributes', 'categories']) is not None:
+    setv(
+        to_object,
+        ['categories'],
+        getv(from_object, ['safetyAttributes', 'categories']),
+    )
+
+  if getv(from_object, ['safetyAttributes', 'scores']) is not None:
+    setv(
+        to_object, ['scores'], getv(from_object, ['safetyAttributes', 'scores'])
+    )
+
+  return to_object
+
+
+def _SafetyAttributes_from_vertex(
+    api_client: BaseApiClient,
+    from_object: Union[dict, object],
+    parent_object: Optional[dict] = None,
+) -> dict:
+  to_object: dict[str, Any] = {}
+  if getv(from_object, ['safetyAttributes', 'categories']) is not None:
+    setv(
+        to_object,
+        ['categories'],
+        getv(from_object, ['safetyAttributes', 'categories']),
+    )
+
+  if getv(from_object, ['safetyAttributes', 'scores']) is not None:
+    setv(
+        to_object, ['scores'], getv(from_object, ['safetyAttributes', 'scores'])
+    )
+
+  return to_object
+
+
 def _GeneratedImage_from_mldev(
     api_client: BaseApiClient,
     from_object: Union[dict, object],
@@ -3581,6 +3629,15 @@ def _GeneratedImage_from_mldev(
         getv(from_object, ['raiFilteredReason']),
     )
 
+  if getv(from_object, ['_self']) is not None:
+    setv(
+        to_object,
+        ['safety_attributes'],
+        _SafetyAttributes_from_mldev(
+            api_client, getv(from_object, ['_self']), to_object
+        ),
+    )
+
   return to_object
 
 
@@ -3604,6 +3661,15 @@ def _GeneratedImage_from_vertex(
         getv(from_object, ['raiFilteredReason']),
     )
 
+  if getv(from_object, ['_self']) is not None:
+    setv(
+        to_object,
+        ['safety_attributes'],
+        _SafetyAttributes_from_vertex(
+            api_client, getv(from_object, ['_self']), to_object
+        ),
+    )
+
   if getv(from_object, ['prompt']) is not None:
     setv(to_object, ['enhanced_prompt'], getv(from_object, ['prompt']))
 
@@ -4539,7 +4605,7 @@ class Models(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
-  def edit_image(
+  def _edit_image(
       self,
       *,
       model: str,
@@ -4980,7 +5046,7 @@ class Models(_api_module.BaseModule):
     .. code-block:: python
 
       response = client.models.count_tokens(
-          model='gemini-1.5-flash',
+          model='gemini-2.0-flash',
           contents='What is your name?',
       )
       print(response)
@@ -5054,9 +5120,9 @@ class Models(_api_module.BaseModule):
       contents: Union[types.ContentListUnion, types.ContentListUnionDict],
       config: Optional[types.ComputeTokensConfigOrDict] = None,
   ) -> types.ComputeTokensResponse:
-    """Return a list of tokens based on the input contents.
+    """Given a list of contents, returns a corresponding TokensInfo containing the
 
-    Only text is supported.
+    list of tokens and list of token ids.
 
     This method is not supported by the Gemini Developer API.
 
@@ -5069,7 +5135,7 @@ class Models(_api_module.BaseModule):
     .. code-block:: python
 
       response = client.models.compute_tokens(
-          model='gemini-1.5-flash',
+          model='gemini-2.0-flash',
           contents='What is your name?',
       )
       print(response)
@@ -5234,21 +5300,21 @@ class Models(_api_module.BaseModule):
     """Makes an API request to generate content using a model.
 
     For the `model` parameter, supported formats for Vertex AI API include:
-    - The Gemini model ID, for example: 'gemini-1.5-flash-002'
+    - The Gemini model ID, for example: 'gemini-2.0-flash'
     - The full resource name starts with 'projects/', for example:
-      'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-1.5-flash-002'
+      'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-2.0-flash'
     - The partial resource name with 'publishers/', for example:
-      'publishers/google/models/gemini-1.5-flash-002' or
+      'publishers/google/models/gemini-2.0-flash' or
       'publishers/meta/models/llama-3.1-405b-instruct-maas'
     - `/` separated publisher and model name, for example:
-      'google/gemini-1.5-flash-002' or 'meta/llama-3.1-405b-instruct-maas'
+      'google/gemini-2.0-flash' or 'meta/llama-3.1-405b-instruct-maas'
 
     For the `model` parameter, supported formats for Gemini API include:
-    - The Gemini model ID, for example: 'gemini-1.5-flash-002'
+    - The Gemini model ID, for example: 'gemini-2.0-flash'
     - The model name starts with 'models/', for example:
-      'models/gemini-1.5-flash-002'
-    - if you would like to use a tuned model, the model name starts with
-      'tunedModels/', for example:
+      'models/gemini-2.0-flash'
+    - For tuned models, the model name starts with 'tunedModels/',
+      for example:
       'tunedModels/1234567890123456789'
 
     Some models support multimodal input and output.
@@ -5265,7 +5331,7 @@ class Models(_api_module.BaseModule):
       )
 
       response = client.models.generate_content(
-        model='gemini-1.5-flash-002',
+        model='gemini-2.0-flash',
         contents='''What is a good name for a flower shop that specializes in
           selling bouquets of dried flowers?'''
       )
@@ -5276,7 +5342,7 @@ class Models(_api_module.BaseModule):
       # * Timeless Petals
 
       response = client.models.generate_content(
-        model='gemini-1.5-flash-002',
+        model='gemini-2.0-flash',
         contents=[
           types.Part.from_text('What is shown in this image?'),
           types.Part.from_uri('gs://generativeai-downloads/images/scones.jpg',
@@ -5354,21 +5420,21 @@ class Models(_api_module.BaseModule):
     """Makes an API request to generate content using a model and yields the model's response in chunks.
 
     For the `model` parameter, supported formats for Vertex AI API include:
-    - The Gemini model ID, for example: 'gemini-1.5-flash-002'
+    - The Gemini model ID, for example: 'gemini-2.0-flash'
     - The full resource name starts with 'projects/', for example:
-      'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-1.5-flash-002'
+      'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-2.0-flash'
     - The partial resource name with 'publishers/', for example:
-      'publishers/google/models/gemini-1.5-flash-002' or
+      'publishers/google/models/gemini-2.0-flash' or
       'publishers/meta/models/llama-3.1-405b-instruct-maas'
     - `/` separated publisher and model name, for example:
-      'google/gemini-1.5-flash-002' or 'meta/llama-3.1-405b-instruct-maas'
+      'google/gemini-2.0-flash' or 'meta/llama-3.1-405b-instruct-maas'
 
     For the `model` parameter, supported formats for Gemini API include:
-    - The Gemini model ID, for example: 'gemini-1.5-flash-002'
+    - The Gemini model ID, for example: 'gemini-2.0-flash'
     - The model name starts with 'models/', for example:
-      'models/gemini-1.5-flash-002'
-    - If you would like to use a tuned model, the model name starts with
-      'tunedModels/', for example:
+      'models/gemini-2.0-flash'
+    - For tuned models, the model name starts with 'tunedModels/',
+      for example:
       'tunedModels/1234567890123456789'
 
     Some models support multimodal input and output.
@@ -5385,7 +5451,7 @@ class Models(_api_module.BaseModule):
       )
 
       for chunk in client.models.generate_content_stream(
-        model='gemini-1.5-flash-002',
+        model='gemini-2.0-flash',
         contents='''What is a good name for a flower shop that specializes in
           selling bouquets of dried flowers?'''
       ):
@@ -5396,7 +5462,7 @@ class Models(_api_module.BaseModule):
       # * Timeless Petals
 
       for chunk in client.models.generate_content_stream(
-        model='gemini-1.5-flash-002',
+        model='gemini-2.0-flash',
         contents=[
           types.Part.from_text('What is shown in this image?'),
           types.Part.from_uri('gs://generativeai-downloads/images/scones.jpg',
@@ -5492,6 +5558,62 @@ class Models(_api_module.BaseModule):
       automatic_function_calling_history.append(func_call_content)
       automatic_function_calling_history.append(func_response_content)
 
+  def edit_image(
+      self,
+      *,
+      model: str,
+      prompt: str,
+      reference_images: list[types._ReferenceImageAPIOrDict],
+      config: Optional[types.EditImageConfigOrDict] = None,
+  ) -> types.EditImageResponse:
+    """Edits an image based on a text description and configuration.
+
+    Args:
+      model (str): The model to use.
+      prompt (str): A text description of the edit to apply to the image.
+        reference_images (list[Union[RawReferenceImage, MaskReferenceImage,
+        ControlReferenceImage, StyleReferenceImage, SubjectReferenceImage]): The
+        reference images for editing.
+      config (EditImageConfig): Configuration for editing.
+
+    Usage:
+
+    .. code-block:: python
+
+      from google.genai.types import RawReferenceImage, MaskReferenceImage
+
+      raw_ref_image = RawReferenceImage(
+        reference_id=1,
+        reference_image=types.Image.from_file(IMAGE_FILE_PATH),
+      )
+
+      mask_ref_image = MaskReferenceImage(
+        reference_id=2,
+        config=types.MaskReferenceConfig(
+            mask_mode='MASK_MODE_FOREGROUND',
+            mask_dilation=0.06,
+        ),
+      )
+      response = client.models.edit_image(
+        model='imagen-3.0-capability-001',
+        prompt='man with dog',
+        reference_images=[raw_ref_image, mask_ref_image],
+        config=types.EditImageConfig(
+            edit_mode= "EDIT_MODE_INPAINT_INSERTION",
+            number_of_images= 1,
+            include_rai_reason= True,
+        )
+      )
+      response.generated_images[0].image.show()
+      # Shows a man with a dog instead of a cat.
+    """
+    return self._edit_image(
+        model=model,
+        prompt=prompt,
+        reference_images=reference_images,
+        config=config,
+    )
+
   def upscale_image(
       self,
       *,
@@ -5924,7 +6046,7 @@ class AsyncModels(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
-  async def edit_image(
+  async def _edit_image(
       self,
       *,
       model: str,
@@ -6365,7 +6487,7 @@ class AsyncModels(_api_module.BaseModule):
     .. code-block:: python
 
       response = await client.aio.models.count_tokens(
-          model='gemini-1.5-flash',
+          model='gemini-2.0-flash',
           contents='What is your name?',
       )
       print(response)
@@ -6439,11 +6561,10 @@ class AsyncModels(_api_module.BaseModule):
       contents: Union[types.ContentListUnion, types.ContentListUnionDict],
       config: Optional[types.ComputeTokensConfigOrDict] = None,
   ) -> types.ComputeTokensResponse:
-    """Return a list of tokens based on the input contents.
+    """Given a list of contents, returns a corresponding TokensInfo containing the
 
-    Only text is supported.
+    list of tokens and list of token ids.
 
-    This method is not supported by the Gemini Developer API.
 
     Args:
       model (str): The model to use.
@@ -6454,7 +6575,7 @@ class AsyncModels(_api_module.BaseModule):
     .. code-block:: python
 
       response = await client.aio.models.compute_tokens(
-          model='gemini-1.5-flash',
+          model='gemini-2.0-flash',
           contents='What is your name?',
       )
       print(response)
@@ -6632,7 +6753,7 @@ class AsyncModels(_api_module.BaseModule):
       )
 
       response = await client.aio.models.generate_content(
-          model='gemini-1.5-flash-002',
+          model='gemini-2.0-flash',
           contents='User input: I like bagels. Answer:',
           config=types.GenerateContentConfig(
               system_instruction=
@@ -6709,21 +6830,21 @@ class AsyncModels(_api_module.BaseModule):
     """Makes an API request to generate content using a model and yields the model's response in chunks.
 
     For the `model` parameter, supported formats for Vertex AI API include:
-    - The Gemini model ID, for example: 'gemini-1.5-flash-002'
+    - The Gemini model ID, for example: 'gemini-2.0-flash'
     - The full resource name starts with 'projects/', for example:
-      'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-1.5-flash-002'
+      'projects/my-project-id/locations/us-central1/publishers/google/models/gemini-2.0-flash'
     - The partial resource name with 'publishers/', for example:
-      'publishers/google/models/gemini-1.5-flash-002' or
+      'publishers/google/models/gemini-2.0-flash' or
       'publishers/meta/models/llama-3.1-405b-instruct-maas'
     - `/` separated publisher and model name, for example:
-      'google/gemini-1.5-flash-002' or 'meta/llama-3.1-405b-instruct-maas'
+      'google/gemini-2.0-flash' or 'meta/llama-3.1-405b-instruct-maas'
 
     For the `model` parameter, supported formats for Gemini API include:
-    - The Gemini model ID, for example: 'gemini-1.5-flash-002'
+    - The Gemini model ID, for example: 'gemini-2.0-flash'
     - The model name starts with 'models/', for example:
-      'models/gemini-1.5-flash-002'
-    - If you would like to use a tuned model, the model name starts with
-      'tunedModels/', for example:
+      'models/gemini-2.0-flash'
+    - For tuned models, the model name starts with 'tunedModels/',
+      for example:
       'tunedModels/1234567890123456789'
 
     Some models support multimodal input and output.
@@ -6740,7 +6861,7 @@ class AsyncModels(_api_module.BaseModule):
       )
 
       async for chunk in await client.aio.models.generate_content_stream(
-        model='gemini-1.5-flash-002',
+        model='gemini-2.0-flash',
         contents='''What is a good name for a flower shop that specializes in
           selling bouquets of dried flowers?'''
       ):
@@ -6751,7 +6872,7 @@ class AsyncModels(_api_module.BaseModule):
       # * Timeless Petals
 
       async for chunk in awiat client.aio.models.generate_content_stream(
-        model='gemini-1.5-flash-002',
+        model='gemini-2.0-flash',
         contents=[
           types.Part.from_text('What is shown in this image?'),
           types.Part.from_uri('gs://generativeai-downloads/images/scones.jpg',
@@ -6858,6 +6979,62 @@ class AsyncModels(_api_module.BaseModule):
 
     return async_generator(model, contents, config)
 
+  async def edit_image(
+      self,
+      *,
+      model: str,
+      prompt: str,
+      reference_images: list[types._ReferenceImageAPIOrDict],
+      config: Optional[types.EditImageConfigOrDict] = None,
+  ) -> types.EditImageResponse:
+    """Edits an image based on a text description and configuration.
+
+    Args:
+      model (str): The model to use.
+      prompt (str): A text description of the edit to apply to the image.
+        reference_images (list[Union[RawReferenceImage, MaskReferenceImage,
+        ControlReferenceImage, StyleReferenceImage, SubjectReferenceImage]): The
+        reference images for editing.
+      config (EditImageConfig): Configuration for editing.
+
+    Usage:
+
+    .. code-block:: python
+
+      from google.genai.types import RawReferenceImage, MaskReferenceImage
+
+      raw_ref_image = RawReferenceImage(
+        reference_id=1,
+        reference_image=types.Image.from_file(IMAGE_FILE_PATH),
+      )
+
+      mask_ref_image = MaskReferenceImage(
+        reference_id=2,
+        config=types.MaskReferenceConfig(
+            mask_mode='MASK_MODE_FOREGROUND',
+            mask_dilation=0.06,
+        ),
+      )
+      response = await client.aio.models.edit_image(
+        model='imagen-3.0-capability-001',
+        prompt='man with dog',
+        reference_images=[raw_ref_image, mask_ref_image],
+        config=types.EditImageConfig(
+            edit_mode= "EDIT_MODE_INPAINT_INSERTION",
+            number_of_images= 1,
+            include_rai_reason= True,
+        )
+      )
+      response.generated_images[0].image.show()
+      # Shows a man with a dog instead of a cat.
+    """
+    return await self._edit_image(
+        model=model,
+        prompt=prompt,
+        reference_images=reference_images,
+        config=config,
+    )
+
   async def list(
       self,
       *,

google/genai/operations.py

@@ -465,10 +465,24 @@ class Operations(_api_module.BaseModule):
     # TODO(b/398233524): Cast operation types
     if self._api_client.vertexai:
       resource_name = operation_name.rpartition('/operations/')[0]
+      http_options = types.HttpOptions()
+      if isinstance(config, dict):
+        dict_options = config.get('http_options', None)
+        if dict_options is not None:
+          http_options = types.HttpOptions(**dict(dict_options))
+      elif isinstance(config, types.GetOperationConfig) and config is not None:
+        http_options = (
+            config.http_options
+            if config.http_options is not None
+            else types.HttpOptions()
+        )
+      fetch_operation_config = types.FetchPredictOperationConfig(
+          http_options=http_options
+      )
       return self._fetch_predict_operation(
           operation_name=operation_name,
           resource_name=resource_name,
-          config=config,
+          config=fetch_operation_config,
       )
     else:
       return self._get_operation(
@@ -623,10 +637,24 @@ class AsyncOperations(_api_module.BaseModule):
 
     if self._api_client.vertexai:
       resource_name = operation_name.rpartition('/operations/')[0]
+      http_options = types.HttpOptions()
+      if isinstance(config, dict):
+        dict_options = config.get('http_options', None)
+        if dict_options is not None:
+          http_options = types.HttpOptions(**dict(dict_options))
+      elif isinstance(config, types.GetOperationConfig) and config is not None:
+        http_options = (
+            config.http_options
+            if config.http_options is not None
+            else types.HttpOptions()
+        )
+      fetch_operation_config = types.FetchPredictOperationConfig(
+          http_options=http_options
+      )
       return await self._fetch_predict_operation(
           operation_name=operation_name,
           resource_name=resource_name,
-          config=config,
+          config=fetch_operation_config,
       )
     else:
       return await self._get_operation(

google/genai/pagers.py

@@ -65,9 +65,9 @@ class _BasePager(Generic[T]):
 
   @property
   def page(self) -> list[T]:
-    """Returns the current page, which is a list of items.
+    """Returns a subset of the entire list of items. 
 
-    The returned list of items is a subset of the entire list.
+    For the number of items returned, see `pageSize()`.
 
     Usage:
 
@@ -97,9 +97,7 @@ class _BasePager(Generic[T]):
 
   @property
   def page_size(self) -> int:
-    """Returns the length of the page fetched each time by this pager.
-
-    The number of items in the page is less than or equal to the page length.
+    """Returns the maximum number of items fetched by the pager at one time.
 
     Usage: