google-genai 0.0.1__py3-none-any.whl → 0.1.0__py3-none-any.whl

google/genai/__init__.py

@@ -17,4 +17,6 @@
 
 from .client import Client
 
+__version__ = '0.1.0'
+
 __all__ = ['Client']

google/genai/_api_client.py

@@ -51,7 +51,7 @@ class HttpOptions(TypedDict):
 def _append_library_version_headers(headers: dict[str, str]) -> None:
   """Appends the telemetry header to the headers dict."""
   # TODO: Automate revisions to the SDK library version.
-  library_label = 'google-genai-sdk/0.1.0'
+  library_label = f'google-genai-sdk/0.1.0'
   language_label = 'gl-python/' + sys.version.split()[0]
   version_header_value = f'{library_label} {language_label}'
   if (

google/genai/_automatic_function_calling_util.py

@@ -295,47 +295,3 @@ def _get_required_fields(schema: types.Schema) -> list[str]:
       if not field_schema.nullable and field_schema.default is None
   ]
 
-
-def function_to_declaration(
-    client, func: Callable
-) -> types.FunctionDeclaration:
-  """Converts a function to a FunctionDeclaration."""
-  parameters_properties = {}
-  for name, param in inspect.signature(func).parameters.items():
-    if param.kind in (
-        inspect.Parameter.POSITIONAL_OR_KEYWORD,
-        inspect.Parameter.KEYWORD_ONLY,
-        inspect.Parameter.POSITIONAL_ONLY,
-    ):
-      schema = _parse_schema_from_parameter(client, param, func.__name__)
-      parameters_properties[name] = schema
-  declaration = types.FunctionDeclaration(
-      name=func.__name__,
-      description=func.__doc__,
-  )
-  if parameters_properties:
-    declaration.parameters = types.Schema(
-        type='OBJECT',
-        properties=parameters_properties,
-    )
-    if client.vertexai:
-      declaration.parameters.required = _get_required_fields(
-          declaration.parameters
-      )
-  if not client.vertexai:
-    return declaration
-
-  return_annotation = inspect.signature(func).return_annotation
-  if return_annotation is inspect._empty:
-    return declaration
-
-  declaration.response = _parse_schema_from_parameter(
-      client,
-      inspect.Parameter(
-          'return_value',
-          inspect.Parameter.POSITIONAL_OR_KEYWORD,
-          annotation=return_annotation,
-      ),
-      func.__name__,
-  )
-  return declaration

google/genai/_extra_utils.py

@@ -293,3 +293,18 @@ def get_max_remote_calls_afc(
   ):
     return _DEFAULT_MAX_REMOTE_CALLS_AFC
   return int(config_model.automatic_function_calling.maximum_remote_calls)
+
+def should_append_afc_history(
+    config: Optional[types.GenerateContentConfigOrDict] = None,
+) -> bool:
+  config_model = (
+      types.GenerateContentConfig(**config)
+      if config and isinstance(config, dict)
+      else config
+  )
+  if (
+      not config_model
+      or not config_model.automatic_function_calling
+  ):
+    return True
+  return not config_model.automatic_function_calling.ignore_call_history

google/genai/_transformers.py

@@ -27,7 +27,6 @@ import PIL.Image
 
 from . import _api_client
 from . import types
-from ._automatic_function_calling_util import function_to_declaration
 
 
 def _resource_name(
@@ -307,7 +306,9 @@ def t_tool(client: _api_client.ApiClient, origin) -> types.Tool:
     return None
   if inspect.isfunction(origin):
     return types.Tool(
-        function_declarations=[function_to_declaration(client, origin)]
+        function_declarations=[
+            types.FunctionDeclaration.from_function(client, origin)
+        ]
     )
   else:
     return origin

google/genai/batches.py

@@ -661,6 +661,24 @@ class Batches(_common.BaseModule):
     return return_value
 
   def get(self, *, name: str) -> types.BatchJob:
+    """Gets a batch job.
+
+    Args:
+      name (str): A fully-qualified BatchJob resource name or ID.
+        Example: "projects/.../locations/.../batchPredictionJobs/456" or "456"
+          when project and location are initialized in the client.
+
+    Returns:
+      A BatchJob object that contains details about the batch job.
+
+    Usage:
+
+    .. code-block:: python
+
+      batch_job = client.batches.get(name='123456789')
+      print(f"Batch job: {batch_job.name}, state {batch_job.state}")
+    """
+
     parameter_model = types._GetBatchJobParameters(
         name=name,
     )
@@ -767,6 +785,23 @@ class Batches(_common.BaseModule):
     return return_value
 
   def delete(self, *, name: str) -> types.DeleteResourceJob:
+    """Deletes a batch job.
+
+    Args:
+      name (str): A fully-qualified BatchJob resource name or ID.
+        Example: "projects/.../locations/.../batchPredictionJobs/456" or "456"
+          when project and location are initialized in the client.
+
+    Returns:
+      A DeleteResourceJob object that shows the status of the deletion.
+
+    Usage:
+
+    .. code-block:: python
+
+      client.batches.delete(name='123456789')
+    """
+
     parameter_model = types._DeleteBatchJobParameters(
         name=name,
     )
@@ -814,12 +849,51 @@ class Batches(_common.BaseModule):
       src: str,
       config: Optional[types.CreateBatchJobConfigOrDict] = None,
   ) -> types.BatchJob:
+    """Creates a batch job.
+
+    Args:
+      model (str): The model to use for the batch job.
+      src (str): The source of the batch job. Currently supports GCS URI(-s) or
+        Bigquery URI. Example: "gs://path/to/input/data" or
+        "bq://projectId.bqDatasetId.bqTableId".
+      config (CreateBatchJobConfig): Optional configuration for the batch job.
+
+    Returns:
+      A BatchJob object that contains details about the batch job.
+
+    Usage:
+
+    .. code-block:: python
+
+      batch_job = client.batches.create(
+          model="gemini-1.5-flash",
+          src="gs://path/to/input/data",
+      )
+      print(batch_job.state)
+    """
     config = _extra_utils.format_destination(src, config)
     return self._create(model=model, src=src, config=config)
 
   def list(
       self, *, config: Optional[types.ListBatchJobConfigOrDict] = None
   ) -> Pager[types.BatchJob]:
+    """Lists batch jobs.
+
+    Args:
+      config (ListBatchJobConfig): 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}")
+    """
     return Pager(
         'batch_jobs',
         self._list,
@@ -874,6 +948,24 @@ class AsyncBatches(_common.BaseModule):
     return return_value
 
   async def get(self, *, name: str) -> types.BatchJob:
+    """Gets a batch job.
+
+    Args:
+      name (str): A fully-qualified BatchJob resource name or ID.
+        Example: "projects/.../locations/.../batchPredictionJobs/456" or "456"
+          when project and location are initialized in the client.
+
+    Returns:
+      A BatchJob object that contains details about the batch job.
+
+    Usage:
+
+    .. code-block:: python
+
+      batch_job = client.batches.get(name='123456789')
+      print(f"Batch job: {batch_job.name}, state {batch_job.state}")
+    """
+
     parameter_model = types._GetBatchJobParameters(
         name=name,
     )
@@ -980,6 +1072,23 @@ class AsyncBatches(_common.BaseModule):
     return return_value
 
   async def delete(self, *, name: str) -> types.DeleteResourceJob:
+    """Deletes a batch job.
+
+    Args:
+      name (str): A fully-qualified BatchJob resource name or ID.
+        Example: "projects/.../locations/.../batchPredictionJobs/456" or "456"
+          when project and location are initialized in the client.
+
+    Returns:
+      A DeleteResourceJob object that shows the status of the deletion.
+
+    Usage:
+
+    .. code-block:: python
+
+      client.batches.delete(name='123456789')
+    """
+
     parameter_model = types._DeleteBatchJobParameters(
         name=name,
     )
@@ -1027,12 +1136,51 @@ class AsyncBatches(_common.BaseModule):
       src: str,
       config: Optional[types.CreateBatchJobConfigOrDict] = None,
   ) -> types.BatchJob:
+    """Creates a batch job asynchronously.
+
+    Args:
+      model (str): The model to use for the batch job.
+      src (str): The source of the batch job. Currently supports GCS URI(-s) or
+        Bigquery URI. Example: "gs://path/to/input/data" or
+        "bq://projectId.bqDatasetId.bqTableId".
+      config (CreateBatchJobConfig): Optional configuration for the batch job.
+
+    Returns:
+      A BatchJob object that contains details about the batch job.
+
+    Usage:
+
+    .. code-block:: python
+
+      batch_job = await client.aio.batches.create(
+          model="gemini-1.5-flash",
+          src="gs://path/to/input/data",
+      )
+    """
     config = _extra_utils.format_destination(src, config)
     return await self._create(model=model, src=src, config=config)
 
   async def list(
       self, *, config: Optional[types.ListBatchJobConfigOrDict] = None
   ) -> AsyncPager[types.BatchJob]:
+    """Lists batch jobs asynchronously.
+
+    Args:
+      config (ListBatchJobConfig): 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}")
+    """
     return AsyncPager(
         'batch_jobs',
         self._list,

google/genai/caches.py

@@ -1249,6 +1249,7 @@ class Caches(_common.BaseModule):
     Usage:
 
     .. code-block:: python
+
       contents = ... // Initialize the content to cache.
       response = await client.aio.caches.create(
           model= ... // The publisher model id
@@ -1310,6 +1311,7 @@ class Caches(_common.BaseModule):
     """Gets cached content configurations.
 
     .. code-block:: python
+
       await client.aio.caches.get(name= ... ) // The server-generated resource
       name.
     """
@@ -1364,6 +1366,7 @@ class Caches(_common.BaseModule):
     Usage:
 
     .. code-block:: python
+
       await client.aio.caches.delete(name= ... ) // The server-generated
       resource name.
     """
@@ -1420,6 +1423,7 @@ class Caches(_common.BaseModule):
     """Updates cached content configurations.
 
     .. code-block:: python
+
       response = await client.aio.caches.update(
           name= ... // The server-generated resource name.
           config={
@@ -1473,6 +1477,7 @@ class Caches(_common.BaseModule):
     """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)
@@ -1548,6 +1553,7 @@ class AsyncCaches(_common.BaseModule):
     Usage:
 
     .. code-block:: python
+
       contents = ... // Initialize the content to cache.
       response = await client.aio.caches.create(
           model= ... // The publisher model id
@@ -1609,6 +1615,7 @@ class AsyncCaches(_common.BaseModule):
     """Gets cached content configurations.
 
     .. code-block:: python
+
       await client.aio.caches.get(name= ... ) // The server-generated resource
       name.
     """
@@ -1663,6 +1670,7 @@ class AsyncCaches(_common.BaseModule):
     Usage:
 
     .. code-block:: python
+
       await client.aio.caches.delete(name= ... ) // The server-generated
       resource name.
     """
@@ -1719,6 +1727,7 @@ class AsyncCaches(_common.BaseModule):
     """Updates cached content configurations.
 
     .. code-block:: python
+
       response = await client.aio.caches.update(
           name= ... // The server-generated resource name.
           config={
@@ -1772,6 +1781,7 @@ class AsyncCaches(_common.BaseModule):
     """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)

google/genai/chats.py

@@ -65,7 +65,12 @@ class Chat(_BaseChat):
         config=self._config,
     )
     if response.candidates and response.candidates[0].content:
-      self._curated_history.append(input_content)
+      if response.automatic_function_calling_history:
+        self._curated_history.extend(
+            response.automatic_function_calling_history
+        )
+      else:
+        self._curated_history.append(input_content)
       self._curated_history.append(response.candidates[0].content)
     return response
 
@@ -138,7 +143,12 @@ class AsyncChat(_BaseChat):
         config=self._config,
     )
     if response.candidates and response.candidates[0].content:
-      self._curated_history.append(input_content)
+      if response.automatic_function_calling_history:
+        self._curated_history.extend(
+            response.automatic_function_calling_history
+        )
+      else:
+        self._curated_history.append(input_content)
       self._curated_history.append(response.candidates[0].content)
     return response
 

google/genai/live.py

@@ -53,6 +53,12 @@ except ModuleNotFoundError:
   from websockets.client import connect
 
 
+_FUNCTION_RESPONSE_REQUIRES_ID = (
+    'FunctionResponse request must have an `id` field from the'
+    ' response of a ToolCall.FunctionalCalls in Google AI.'
+)
+
+
 class AsyncSession:
   """AsyncSession."""
 
@@ -81,20 +87,23 @@ class AsyncSession:
     """Receive model responses from the server.
 
     The method will yield the model responses from the server. The returned
-    responses will represent a complete model turn.
-    when the returned message is fuction call, user must call `send` with the
-    function response to continue the turn.
-    Example usage:
-    ```
-    client = genai.Client(api_key=API_KEY)
-
-    async with client.aio.live.connect(model='...') as session:
-      await session.send(input='Hello world!', end_of_turn=True)
-      async for message in session.receive():
-        print(message)
-    ```
+    responses will represent a complete model turn. When the returned message
+    is fuction call, user must call `send` with the function response to
+    continue the turn.
+
     Yields:
-        The model responses from the server.
+      The model responses from the server.
+
+    Example usage:
+
+    .. code-block:: python
+
+      client = genai.Client(api_key=API_KEY)
+
+      async with client.aio.live.connect(model='...') as session:
+        await session.send(input='Hello world!', end_of_turn=True)
+        async for message in session.receive():
+          print(message)
     """
     # TODO(b/365983264) Handle intermittent issues for the user.
     while result := await self._receive():
@@ -113,28 +122,27 @@ class AsyncSession:
     input stream to the model and the other task will be used to receive the
     responses from the model.
 
-    Example usage:
-    ```
-    client = genai.Client(api_key=API_KEY)
-    config = {'response_modalities': ['AUDIO']}
-
-    async def audio_stream():
-      stream = read_audio()
-      for data in stream:
-        yield data
-
-    async with client.aio.live.connect(model='...') as session:
-      for audio in session.start_stream(stream = audio_stream(),
-      mime_type = 'audio/pcm'):
-        play_audio_chunk(audio.data)
-    ```
-
     Args:
-        stream: An iterator that yields the model response.
-        mime_type: The MIME type of the data in the stream.
+      stream: An iterator that yields the model response.
+      mime_type: The MIME type of the data in the stream.
 
     Yields:
-        The audio bytes received from the model and server response messages.
+      The audio bytes received from the model and server response messages.
+
+    Example usage:
+
+    .. code-block:: python
+
+      client = genai.Client(api_key=API_KEY)
+      config = {'response_modalities': ['AUDIO']}
+      async def audio_stream():
+        stream = read_audio()
+        for data in stream:
+          yield data
+      async with client.aio.live.connect(model='...') as session:
+        for audio in session.start_stream(stream = audio_stream(),
+        mime_type = 'audio/pcm'):
+          play_audio_chunk(audio.data)
     """
     stop_event = asyncio.Event()
     # Start the send loop. When stream is complete stop_event is set.
@@ -340,6 +348,8 @@ class AsyncSession:
       input = [input]
     elif isinstance(input, dict) and 'name' in input and 'response' in input:
       # ToolResponse.FunctionResponse
+      if not (self._api_client.vertexai) and 'id' not in input:
+        raise ValueError(_FUNCTION_RESPONSE_REQUIRES_ID)
       input = [input]
 
     if isinstance(input, Sequence) and any(
@@ -395,7 +405,29 @@ class AsyncSession:
       client_message = {'client_content': input.model_dump(exclude_none=True)}
     elif isinstance(input, types.LiveClientToolResponse):
       # ToolResponse.FunctionResponse
+      if not (self._api_client.vertexai) and not (input.function_responses[0].id):
+        raise ValueError(_FUNCTION_RESPONSE_REQUIRES_ID)
       client_message = {'tool_response': input.model_dump(exclude_none=True)}
+    elif isinstance(input, types.FunctionResponse):
+      if not (self._api_client.vertexai) and not (input.id):
+        raise ValueError(_FUNCTION_RESPONSE_REQUIRES_ID)
+      client_message = {
+          'tool_response': {
+              'function_responses': [input.model_dump(exclude_none=True)]
+          }
+      }
+    elif isinstance(input, Sequence) and isinstance(
+        input[0], types.FunctionResponse
+    ):
+      if not (self._api_client.vertexai) and not (input[0].id):
+        raise ValueError(_FUNCTION_RESPONSE_REQUIRES_ID)
+      client_message = {
+          'tool_response': {
+              'function_responses': [
+                  c.model_dump(exclude_none=True) for c in input
+              ]
+          }
+      }
     else:
       raise ValueError(
           f'Unsupported input type "{type(input)}" or input content "{input}"'
@@ -571,16 +603,16 @@ class AsyncLive(_common.BaseModule):
   ) -> AsyncSession:
     """Connect to the live server.
 
-    Example usage:
-    ```
-    client = genai.Client(api_key=API_KEY)
-    config = {}
-
-    async with client.aio.live.connect(model='gemini-1.0-pro-002', config=config) as session:
-      await session.send(input='Hello world!', end_of_turn=True)
-      async for message in session:
-        print(message)
-    ```
+    Usage:
+
+    .. code-block:: python
+
+      client = genai.Client(api_key=API_KEY)
+      config = {}
+      async with client.aio.live.connect(model='gemini-1.0-pro-002', config=config) as session:
+        await session.send(input='Hello world!', end_of_turn=True)
+        async for message in session:
+          print(message)
     """
     base_url = self.api_client._websocket_base_url()
     if self.api_client.api_key: