google-genai 1.52.0__tar.gz → 1.53.0__tar.gz

{google_genai-1.52.0/google_genai.egg-info → google_genai-1.53.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-genai
-Version: 1.52.0
+Version: 1.53.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License-Expression: Apache-2.0
@@ -20,7 +20,7 @@ Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: anyio<5.0.0,>=4.8.0
-Requires-Dist: google-auth<3.0.0,>=2.14.1
+Requires-Dist: google-auth[requests]<3.0.0,>=2.14.1
 Requires-Dist: httpx<1.0.0,>=0.28.1
 Requires-Dist: pydantic<3.0.0,>=2.9.0
 Requires-Dist: requests<3.0.0,>=2.28.1
@@ -51,6 +51,16 @@ Google's generative models into their Python applications. It supports the
 [Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview)
 APIs.
 
+## Code Generation
+
+Generative models are often unaware of recent API and SDK updates and may suggest outdated or legacy code.
+
+We recommend using our Code Generation instructions [codegen_instructions.md](https://raw.githubusercontent.com/googleapis/python-genai/refs/heads/main/codegen_instructions.md) when generating Google Gen AI SDK code to guide your model towards using the more recent SDK features.
+
+Copy and paste the instructions from [this file](https://raw.githubusercontent.com/googleapis/python-genai/refs/heads/main/codegen_instructions.md)
+into your development environment to provide the model with the necessary
+context
+
 ## Installation
 
 ```sh
@@ -91,6 +101,44 @@ client = genai.Client(
 )
 ```
 
+## Using types
+
+All API methods support Pydantic types and dictionaries, which you can access
+from `google.genai.types`. You can import the types module with the following:
+
+```python
+from google.genai import types
+```
+
+Below is an example `generate_content()` call using types from the types module:
+
+```python
+response = client.models.generate_content(
+    model='gemini-2.0-flash-001',
+    contents=types.Part.from_text(text='Why is the sky blue?'),
+    config=types.GenerateContentConfig(
+        temperature=0,
+        top_p=0.95,
+        top_k=20,
+    ),
+)
+```
+
+Alternatively, you can accomplish the same request using dictionaries instead of
+types:
+
+```python
+response = client.models.generate_content(
+    model='gemini-2.0-flash-001',
+    contents={'text': 'Why is the sky blue?'},
+    config={
+        'temperature': 0,
+        'top_p': 0.95,
+        'top_k': 20,
+    },
+)
+```
+
 **(Optional) Using environment variables:**
 
 You can create a client by configuring the necessary environment variables.
@@ -583,33 +631,6 @@ response = client.models.generate_content(
 print(response.text)
 ```
 
-### Typed Config
-
-All API methods support Pydantic types for parameters as well as
-dictionaries. You can get the type from `google.genai.types`.
-
-```python
-from google.genai import types
-
-response = client.models.generate_content(
-    model='gemini-2.0-flash-001',
-    contents=types.Part.from_text(text='Why is the sky blue?'),
-    config=types.GenerateContentConfig(
-        temperature=0,
-        top_p=0.95,
-        top_k=20,
-        candidate_count=1,
-        seed=5,
-        max_output_tokens=100,
-        stop_sequences=['STOP!'],
-        presence_penalty=0.0,
-        frequency_penalty=0.0,
-    ),
-)
-
-print(response.text)
-```
-
 ### List Base Models
 
 To retrieve tuned models, see [list tuned models](#list-tuned-models).

{google_genai-1.52.0 → google_genai-1.53.0}/README.md

@@ -15,6 +15,16 @@ Google's generative models into their Python applications. It supports the
 [Vertex AI](https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview)
 APIs.
 
+## Code Generation
+
+Generative models are often unaware of recent API and SDK updates and may suggest outdated or legacy code.
+
+We recommend using our Code Generation instructions [codegen_instructions.md](https://raw.githubusercontent.com/googleapis/python-genai/refs/heads/main/codegen_instructions.md) when generating Google Gen AI SDK code to guide your model towards using the more recent SDK features.
+
+Copy and paste the instructions from [this file](https://raw.githubusercontent.com/googleapis/python-genai/refs/heads/main/codegen_instructions.md)
+into your development environment to provide the model with the necessary
+context
+
 ## Installation
 
 ```sh
@@ -55,6 +65,44 @@ client = genai.Client(
 )
 ```
 
+## Using types
+
+All API methods support Pydantic types and dictionaries, which you can access
+from `google.genai.types`. You can import the types module with the following:
+
+```python
+from google.genai import types
+```
+
+Below is an example `generate_content()` call using types from the types module:
+
+```python
+response = client.models.generate_content(
+    model='gemini-2.0-flash-001',
+    contents=types.Part.from_text(text='Why is the sky blue?'),
+    config=types.GenerateContentConfig(
+        temperature=0,
+        top_p=0.95,
+        top_k=20,
+    ),
+)
+```
+
+Alternatively, you can accomplish the same request using dictionaries instead of
+types:
+
+```python
+response = client.models.generate_content(
+    model='gemini-2.0-flash-001',
+    contents={'text': 'Why is the sky blue?'},
+    config={
+        'temperature': 0,
+        'top_p': 0.95,
+        'top_k': 20,
+    },
+)
+```
+
 **(Optional) Using environment variables:**
 
 You can create a client by configuring the necessary environment variables.
@@ -547,33 +595,6 @@ response = client.models.generate_content(
 print(response.text)
 ```
 
-### Typed Config
-
-All API methods support Pydantic types for parameters as well as
-dictionaries. You can get the type from `google.genai.types`.
-
-```python
-from google.genai import types
-
-response = client.models.generate_content(
-    model='gemini-2.0-flash-001',
-    contents=types.Part.from_text(text='Why is the sky blue?'),
-    config=types.GenerateContentConfig(
-        temperature=0,
-        top_p=0.95,
-        top_k=20,
-        candidate_count=1,
-        seed=5,
-        max_output_tokens=100,
-        stop_sequences=['STOP!'],
-        presence_penalty=0.0,
-        frequency_penalty=0.0,
-    ),
-)
-
-print(response.text)
-```
-
 ### List Base Models
 
 To retrieve tuned models, see [list tuned models](#list-tuned-models).

{google_genai-1.52.0 → google_genai-1.53.0}/google/genai/batches.py

@@ -1902,6 +1902,34 @@ class Batches(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
+  def list(
+      self, *, config: Optional[types.ListBatchJobsConfigOrDict] = None
+  ) -> Pager[types.BatchJob]:
+    """Lists batch jobs.
+
+    Args:
+      config (ListBatchJobsConfig): Optional configuration for the list request.
+
+    Returns:
+      A Pager object that contains one page of batch jobs. When iterating over
+      the pager, it automatically fetches the next page if there are more.
+
+    Usage:
+
+    .. code-block:: python
+      config = {'page_size': 10}
+      for batch_job in client.batches.list(config):
+        print(batch_job.name)
+    """
+
+    list_request = self._list
+    return Pager(
+        'batch_jobs',
+        list_request,
+        self._list(config=config),
+        config,
+    )
+
   def create(
       self,
       *,
@@ -1997,35 +2025,6 @@ class Batches(_api_module.BaseModule):
     else:
       return self._create_embeddings(model=model, src=src, config=config)
 
-  def list(
-      self, *, config: Optional[types.ListBatchJobsConfigOrDict] = None
-  ) -> Pager[types.BatchJob]:
-    """Lists batch jobs.
-
-    Args:
-      config (ListBatchJobsConfig): Optional configuration for the list request.
-
-    Returns:
-      A Pager object that contains one page of batch jobs. When iterating over
-      the pager, it automatically fetches the next page if there are more.
-
-    Usage:
-
-    .. code-block:: python
-
-      batch_jobs = client.batches.list(config={"page_size": 10})
-      for batch_job in batch_jobs:
-        print(f"Batch job: {batch_job.name}, state {batch_job.state}")
-    """
-    if config is None:
-      config = types.ListBatchJobsConfig()
-    return Pager(
-        'batch_jobs',
-        self._list,
-        self._list(config=config),
-        config,
-    )
-
 
 class AsyncBatches(_api_module.BaseModule):
 
@@ -2452,6 +2451,33 @@ class AsyncBatches(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
+  async def list(
+      self, *, config: Optional[types.ListBatchJobsConfigOrDict] = None
+  ) -> AsyncPager[types.BatchJob]:
+    """Lists batch jobs asynchronously.
+
+    Args:
+      config (ListBatchJobsConfig): Optional configuration for the list request.
+
+    Returns:
+      A Pager object that contains one page of batch jobs. When iterating over
+      the pager, it automatically fetches the next page if there are more.
+
+    Usage:
+
+    .. code-block:: python
+      async for batch_job in await client.aio.batches.list():
+        print(batch_job.name)
+    """
+
+    list_request = self._list
+    return AsyncPager(
+        'batch_jobs',
+        list_request,
+        await self._list(config=config),
+        config,
+    )
+
   async def create(
       self,
       *,
@@ -2552,33 +2578,3 @@ class AsyncBatches(_api_module.BaseModule):
       raise ValueError('Vertex AI does not support batches.create_embeddings.')
     else:
       return await self._create_embeddings(model=model, src=src, config=config)
-
-  async def list(
-      self, *, config: Optional[types.ListBatchJobsConfigOrDict] = None
-  ) -> AsyncPager[types.BatchJob]:
-    """Lists batch jobs asynchronously.
-
-    Args:
-      config (ListBatchJobsConfig): Optional configuration for the list request.
-
-    Returns:
-      A Pager object that contains one page of batch jobs. When iterating over
-      the pager, it automatically fetches the next page if there are more.
-
-    Usage:
-
-    .. code-block:: python
-
-      batch_jobs = await client.aio.batches.list(config={'page_size': 5})
-      print(f"current page: {batch_jobs.page}")
-      await batch_jobs_pager.next_page()
-      print(f"next page: {batch_jobs_pager.page}")
-    """
-    if config is None:
-      config = types.ListBatchJobsConfig()
-    return AsyncPager(
-        'batch_jobs',
-        self._list,
-        await self._list(config=config),
-        config,
-    )

{google_genai-1.52.0 → google_genai-1.53.0}/google/genai/caches.py

@@ -1129,15 +1129,6 @@ class Caches(_api_module.BaseModule):
   def _list(
       self, *, config: Optional[types.ListCachedContentsConfigOrDict] = None
   ) -> types.ListCachedContentsResponse:
-    """Lists cached content configurations.
-
-    .. code-block:: python
-
-      cached_contents = client.caches.list(config={'page_size': 2})
-      for cached_content in cached_contents:
-        print(cached_content)
-    """
-
     parameter_model = types._ListCachedContentsParameters(
         config=config,
     )
@@ -1196,9 +1187,28 @@ class Caches(_api_module.BaseModule):
   def list(
       self, *, config: Optional[types.ListCachedContentsConfigOrDict] = None
   ) -> Pager[types.CachedContent]:
+    """Lists cached contents.
+
+    Args:
+      config (ListCachedContentsConfig): Optional configuration for the list
+        request.
+
+    Returns:
+      A Pager object that contains one page of cached contents. When iterating
+      over
+      the pager, it automatically fetches the next page if there are more.
+
+    Usage:
+
+    .. code-block:: python
+      for cached_content in client.caches.list():
+        print(cached_content.name)
+    """
+
+    list_request = self._list
     return Pager(
         'cached_contents',
-        self._list,
+        list_request,
         self._list(config=config),
         config,
     )
@@ -1505,15 +1515,6 @@ class AsyncCaches(_api_module.BaseModule):
   async def _list(
       self, *, config: Optional[types.ListCachedContentsConfigOrDict] = None
   ) -> types.ListCachedContentsResponse:
-    """Lists cached content configurations.
-
-    .. code-block:: python
-
-      cached_contents = await client.aio.caches.list(config={'page_size': 2})
-      async for cached_content in cached_contents:
-        print(cached_content)
-    """
-
     parameter_model = types._ListCachedContentsParameters(
         config=config,
     )
@@ -1574,9 +1575,28 @@ class AsyncCaches(_api_module.BaseModule):
   async def list(
       self, *, config: Optional[types.ListCachedContentsConfigOrDict] = None
   ) -> AsyncPager[types.CachedContent]:
+    """Lists cached contents asynchronously.
+
+    Args:
+      config (ListCachedContentsConfig): Optional configuration for the list
+        request.
+
+    Returns:
+      A Pager object that contains one page of cached contents. When iterating
+      over
+      the pager, it automatically fetches the next page if there are more.
+
+    Usage:
+
+    .. code-block:: python
+      async for cached_content in await client.aio.caches.list():
+        print(cached_content.name)
+    """
+
+    list_request = self._list
     return AsyncPager(
         'cached_contents',
-        self._list,
+        list_request,
         await self._list(config=config),
         config,
     )

{google_genai-1.52.0 → google_genai-1.53.0}/google/genai/documents.py

@@ -249,17 +249,6 @@ class Documents(_api_module.BaseModule):
       parent: str,
       config: Optional[types.ListDocumentsConfigOrDict] = None,
   ) -> types.ListDocumentsResponse:
-    """Lists all Documents in a FileSearchStore.
-
-    Args:
-      parent (str): The name of the FileSearchStore containing the Documents.
-      config (ListDocumentsConfig | None): Optional parameters for the request,
-        such as page_size.
-
-    Returns:
-      ListDocumentsResponse: A paginated list of Documents.
-    """
-
     parameter_model = types._ListDocumentsParameters(
         parent=parent,
         config=config,
@@ -328,6 +317,7 @@ class Documents(_api_module.BaseModule):
       for document in client.documents.list(parent='rag_store_name'):
         print(f"document: {document.name} - {document.display_name}")
     """
+
     list_request = partial(self._list, parent=parent)
     return Pager(
         'documents',
@@ -461,17 +451,6 @@ class AsyncDocuments(_api_module.BaseModule):
       parent: str,
       config: Optional[types.ListDocumentsConfigOrDict] = None,
   ) -> types.ListDocumentsResponse:
-    """Lists all Documents in a FileSearchStore.
-
-    Args:
-      parent (str): The name of the FileSearchStore containing the Documents.
-      config (ListDocumentsConfig | None): Optional parameters for the request,
-        such as page_size.
-
-    Returns:
-      ListDocumentsResponse: A paginated list of Documents.
-    """
-
     parameter_model = types._ListDocumentsParameters(
         parent=parent,
         config=config,
@@ -540,9 +519,10 @@ class AsyncDocuments(_api_module.BaseModule):
     Usage:
     .. code-block:: python
       async for document in await
-      client.documents.list(parent='rag_store_name'):
+      client.aio.documents.list(parent='rag_store_name'):
         print(f"document: {document.name} - {document.display_name}")
     """
+
     list_request = partial(self._list, parent=parent)
     return AsyncPager(
         'documents',

{google_genai-1.52.0 → google_genai-1.53.0}/google/genai/file_search_stores.py

@@ -499,16 +499,6 @@ class FileSearchStores(_api_module.BaseModule):
   def _list(
       self, *, config: Optional[types.ListFileSearchStoresConfigOrDict] = None
   ) -> types.ListFileSearchStoresResponse:
-    """Lists all FileSearchStore owned by the user.
-
-    Args:
-      config (ListFileSearchStoresConfig | None): Optional parameters for the
-        request, such as page_size.
-
-    Returns:
-      ListFileSearchStoresResponse: A paginated list of FileSearchStore.
-    """
-
     parameter_model = types._ListFileSearchStoresParameters(
         config=config,
     )
@@ -705,6 +695,36 @@ class FileSearchStores(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
+  def list(
+      self, *, config: Optional[types.ListFileSearchStoresConfigOrDict] = None
+  ) -> Pager[types.FileSearchStore]:
+    """Lists FileSearchStores.
+
+    Args:
+      config (ListFileSearchStoresConfig): Optional configuration for the list
+        request.
+
+    Returns:
+      A Pager object that contains one page of file search stores. When
+      iterating over
+      the pager, it automatically fetches the next page if there are more.
+
+    Usage:
+
+    .. code-block:: python
+      for file_search_store in client.file_search_stores.list():
+        print(f"file search store: {file_search_store.name} -
+        {file_search_store.display_name}")
+    """
+
+    list_request = self._list
+    return Pager(
+        'file_search_stores',
+        list_request,
+        self._list(config=config),
+        config,
+    )
+
   def upload_to_file_search_store(
       self,
       *,
@@ -781,34 +801,6 @@ class FileSearchStores(_api_module.BaseModule):
         response=response_dict, kwargs={}
     )
 
-  def list(
-      self, *, config: Optional[types.ListFileSearchStoresConfigOrDict] = None
-  ) -> Pager[types.FileSearchStore]:
-    """Lists FileSearchStores.
-
-    Args:
-      config (ListFileSearchStoresConfig): Optional configuration for the list
-        request.
-
-    Returns:
-      A Pager object that contains one page of file search stores. When
-      iterating over
-      the pager, it automatically fetches the next page if there are more.
-
-    Usage:
-
-    .. code-block:: python
-      for file_search_store in client.file_search_stores.list():
-        print(f"file search store: {file_search_store.name} -
-        {file_search_store.display_name}")
-    """
-    return Pager(
-        'file_search_stores',
-        self._list,
-        self._list(config=config),
-        config,
-    )
-
 
 class AsyncFileSearchStores(_api_module.BaseModule):
 
@@ -999,16 +991,6 @@ class AsyncFileSearchStores(_api_module.BaseModule):
   async def _list(
       self, *, config: Optional[types.ListFileSearchStoresConfigOrDict] = None
   ) -> types.ListFileSearchStoresResponse:
-    """Lists all FileSearchStore owned by the user.
-
-    Args:
-      config (ListFileSearchStoresConfig | None): Optional parameters for the
-        request, such as page_size.
-
-    Returns:
-      ListFileSearchStoresResponse: A paginated list of FileSearchStore.
-    """
-
     parameter_model = types._ListFileSearchStoresParameters(
         config=config,
     )
@@ -1207,6 +1189,36 @@ class AsyncFileSearchStores(_api_module.BaseModule):
     self._api_client._verify_response(return_value)
     return return_value
 
+  async def list(
+      self, *, config: Optional[types.ListFileSearchStoresConfigOrDict] = None
+  ) -> AsyncPager[types.FileSearchStore]:
+    """Lists FileSearchStores asynchronously.
+
+    Args:
+      config (ListFileSearchStoresConfig): Optional parameters for the request,
+        such as page_size.
+
+    Returns:
+      A Pager object that contains one page of FileSearchStores. When iterating
+      over
+      the pager, it automatically fetches the next page if there are more.
+
+    Usage:
+
+    .. code-block:: python
+      async for file_search_store in await client.aio.file_search_stores.list():
+        print(f"file search store: {file_search_store.name} -
+        {file_search_store.display_name}")
+    """
+
+    list_request = self._list
+    return AsyncPager(
+        'file_search_stores',
+        list_request,
+        await self._list(config=config),
+        config,
+    )
+
   async def upload_to_file_search_store(
       self,
       *,
@@ -1282,31 +1294,3 @@ class AsyncFileSearchStores(_api_module.BaseModule):
     return types.UploadToFileSearchStoreOperation._from_response(
         response=response_dict, kwargs={}
     )
-
-  async def list(
-      self, *, config: Optional[types.ListFileSearchStoresConfigOrDict] = None
-  ) -> AsyncPager[types.FileSearchStore]:
-    """Lists FileSearchStores asynchronously.
-
-    Args:
-      config (ListFileSearchStoresConfig): Optional configuration for the list
-        request.
-
-    Returns:
-      A Pager object that contains one page of FileSearchStores. When iterating
-      over
-      the pager, it automatically fetches the next page if there are more.
-
-    Usage:
-
-    .. code-block:: python
-      async for file_search_store in await client.file_search_stores.list():
-        print(f"file search store: {file_search_store.name} -
-        {file_search_store.display_name}")
-    """
-    return AsyncPager(
-        'file_search_stores',
-        self._list,
-        await self._list(config=config),
-        config,
-    )