google-genai 1.46.0__tar.gz → 1.47.0__tar.gz

{google_genai-1.46.0/google_genai.egg-info → google_genai-1.47.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-genai
-Version: 1.46.0
+Version: 1.47.0
 Summary: GenAI Python SDK
 Author-email: Google LLC <googleapis-packages@google.com>
 License-Expression: Apache-2.0
@@ -23,7 +23,7 @@ License-File: LICENSE
 Requires-Dist: anyio<5.0.0,>=4.8.0
 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: pydantic<3.0.0,>=2.9.0
 Requires-Dist: requests<3.0.0,>=2.28.1
 Requires-Dist: tenacity<9.2.0,>=8.2.3
 Requires-Dist: websockets<15.1.0,>=13.0.0
@@ -128,7 +128,6 @@ Explicitly close the sync client to ensure that resources, such as the
  underlying HTTP connections, are properly cleaned up and closed.
 
 ```python
-
 from google.genai import Client
 
 client = Client()
@@ -147,7 +146,6 @@ client.close()
 To explicitly close the async client:
 
 ```python
-
 from google.genai import Client
 
 aclient = Client(
@@ -174,15 +172,14 @@ By using the sync client context manager, it will close the underlying
 from google.genai import Client
 
 with Client() as client:
-  response_1 = client.models.generate_content(
-      model=MODEL_ID,
-      contents='Hello',
-  )
-  response_2 = client.models.generate_content(
-      model=MODEL_ID,
-      contents='Ask a question',
-  )
-
+    response_1 = client.models.generate_content(
+        model=MODEL_ID,
+        contents='Hello',
+    )
+    response_2 = client.models.generate_content(
+        model=MODEL_ID,
+        contents='Ask a question',
+    )
 ```
 
 By using the async client context manager, it will close the underlying
@@ -192,15 +189,14 @@ By using the async client context manager, it will close the underlying
 from google.genai import Client
 
 async with Client().aio as aclient:
-  response_1 = await aclient.models.generate_content(
-      model=MODEL_ID,
-      contents='Hello',
-  )
-  response_2 = await aclient.models.generate_content(
-      model=MODEL_ID,
-      contents='Ask a question',
-  )
-
+    response_1 = await aclient.models.generate_content(
+        model=MODEL_ID,
+        contents='Hello',
+    )
+    response_2 = await aclient.models.generate_content(
+        model=MODEL_ID,
+        contents='Ask a question',
+    )
 ```
 
 ### API Selection
@@ -245,7 +241,6 @@ Additional args of `aiohttp.ClientSession.request()` ([see _RequestOptions args]
 through the following way:
 
 ```python
-
 http_options = types.HttpOptions(
     async_client_args={'cookies': ..., 'ssl': ...},
 )
@@ -259,7 +254,6 @@ 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'
@@ -270,7 +264,6 @@ 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'},
@@ -286,16 +279,14 @@ In some cases you might need a custom base url (for example, API gateway proxy
 You may pass the custom base url like this:
 
 ```python
-
 base_url = 'https://test-api-gateway-proxy.com'
 client = Client(
-  vertexai=True,
-  http_options={
-      'base_url': base_url,
-      'headers': {'Authorization': 'Bearer test_token'},
-  },
+    vertexai=True,  # Currently only vertexai=True is supported
+    http_options={
+        'base_url': base_url,
+        'headers': {'Authorization': 'Bearer test_token'},
+    },
 )
-
 ```
 
 ## Types
@@ -329,17 +320,17 @@ response = client.models.generate_content(
     model='gemini-2.5-flash-image',
     contents='A cartoon infographic for flying sneakers',
     config=types.GenerateContentConfig(
-    response_modalities=["IMAGE"],
-      image_config=types.ImageConfig(
-          aspect_ratio="9:16",
-      ),
+        response_modalities=["IMAGE"],
+        image_config=types.ImageConfig(
+            aspect_ratio="9:16",
+        ),
     ),
 )
 
 for part in response.parts:
-  if part.inline_data:
-    generated_image = part.as_image()
-    generated_image.show()
+    if part.inline_data:
+        generated_image = part.as_image()
+        generated_image.show()
 ```
 
 #### with uploaded file (Gemini Developer API only)
@@ -374,8 +365,8 @@ This is the canonical way to provide contents, SDK will not do any conversion.
 from google.genai import types
 
 contents = types.Content(
-  role='user',
-  parts=[types.Part.from_text(text='Why is the sky blue?')]
+    role='user',
+    parts=[types.Part.from_text(text='Why is the sky blue?')]
 )
 ```
 
@@ -383,10 +374,10 @@ SDK converts this to
 
 ```python
 [
-  types.Content(
-    role='user',
-    parts=[types.Part.from_text(text='Why is the sky blue?')]
-  )
+    types.Content(
+        role='user',
+        parts=[types.Part.from_text(text='Why is the sky blue?')]
+    )
 ]
 ```
 
@@ -400,11 +391,11 @@ The SDK will assume this is a text part, and it converts this into the following
 
 ```python
 [
-  types.UserContent(
-    parts=[
-      types.Part.from_text(text='Why is the sky blue?')
-    ]
-  )
+    types.UserContent(
+        parts=[
+            types.Part.from_text(text='Why is the sky blue?')
+        ]
+    )
 ]
 ```
 
@@ -422,12 +413,12 @@ like the following:
 
 ```python
 [
-  types.UserContent(
-    parts=[
-      types.Part.from_text(text='Why is the sky blue?'),
-      types.Part.from_text(text='Why is the cloud white?'),
-    ]
-  )
+    types.UserContent(
+        parts=[
+            types.Part.from_text(text='Why is the sky blue?'),
+            types.Part.from_text(text='Why is the cloud white?'),
+        ]
+    )
 ]
 ```
 
@@ -440,8 +431,8 @@ Where a `types.UserContent` is a subclass of `types.Content`, the
 from google.genai import types
 
 contents = types.Part.from_function_call(
-  name='get_weather_by_location',
-  args={'location': 'Boston'}
+    name='get_weather_by_location',
+    args={'location': 'Boston'}
 )
 ```
 
@@ -449,14 +440,14 @@ The SDK converts a function call part to a content with a `model` role:
 
 ```python
 [
-  types.ModelContent(
-    parts=[
-      types.Part.from_function_call(
-        name='get_weather_by_location',
-        args={'location': 'Boston'}
-      )
-    ]
-  )
+    types.ModelContent(
+        parts=[
+            types.Part.from_function_call(
+                name='get_weather_by_location',
+                args={'location': 'Boston'}
+            )
+        ]
+    )
 ]
 ```
 
@@ -469,14 +460,14 @@ Where a `types.ModelContent` is a subclass of `types.Content`, the
 from google.genai import types
 
 contents = [
-  types.Part.from_function_call(
-    name='get_weather_by_location',
-    args={'location': 'Boston'}
-  ),
-  types.Part.from_function_call(
-    name='get_weather_by_location',
-    args={'location': 'New York'}
-  ),
+    types.Part.from_function_call(
+        name='get_weather_by_location',
+        args={'location': 'Boston'}
+    ),
+    types.Part.from_function_call(
+        name='get_weather_by_location',
+        args={'location': 'New York'}
+    ),
 ]
 ```
 
@@ -484,18 +475,18 @@ The SDK converts a list of function call parts to the a content with a `model` r
 
 ```python
 [
-  types.ModelContent(
-    parts=[
-      types.Part.from_function_call(
-        name='get_weather_by_location',
-        args={'location': 'Boston'}
-      ),
-      types.Part.from_function_call(
-        name='get_weather_by_location',
-        args={'location': 'New York'}
-      )
-    ]
-  )
+    types.ModelContent(
+        parts=[
+            types.Part.from_function_call(
+                name='get_weather_by_location',
+                args={'location': 'Boston'}
+            ),
+            types.Part.from_function_call(
+                name='get_weather_by_location',
+                args={'location': 'New York'}
+            )
+        ]
+    )
 ]
 ```
 
@@ -508,8 +499,8 @@ Where a `types.ModelContent` is a subclass of `types.Content`, the
 from google.genai import types
 
 contents = types.Part.from_uri(
-  file_uri: 'gs://generativeai-downloads/images/scones.jpg',
-  mime_type: 'image/jpeg',
+    file_uri: 'gs://generativeai-downloads/images/scones.jpg',
+    mime_type: 'image/jpeg',
 )
 ```
 
@@ -517,12 +508,12 @@ The SDK converts all non function call parts into a content with a `user` role.
 
 ```python
 [
-  types.UserContent(parts=[
-    types.Part.from_uri(
-      file_uri: 'gs://generativeai-downloads/images/scones.jpg',
-      mime_type: 'image/jpeg',
-    )
-  ])
+    types.UserContent(parts=[
+        types.Part.from_uri(
+            file_uri: 'gs://generativeai-downloads/images/scones.jpg',
+            mime_type: 'image/jpeg',
+        )
+    ])
 ]
 ```
 
@@ -532,11 +523,11 @@ The SDK converts all non function call parts into a content with a `user` role.
 from google.genai import types
 
 contents = [
-  types.Part.from_text('What is this image about?'),
-  types.Part.from_uri(
-    file_uri: 'gs://generativeai-downloads/images/scones.jpg',
-    mime_type: 'image/jpeg',
-  )
+    types.Part.from_text('What is this image about?'),
+    types.Part.from_uri(
+        file_uri: 'gs://generativeai-downloads/images/scones.jpg',
+        mime_type: 'image/jpeg',
+    )
 ]
 ```
 
@@ -544,15 +535,15 @@ The SDK will convert the list of parts into a content with a `user` role
 
 ```python
 [
-  types.UserContent(
-    parts=[
-      types.Part.from_text('What is this image about?'),
-      types.Part.from_uri(
-        file_uri: 'gs://generativeai-downloads/images/scones.jpg',
-        mime_type: 'image/jpeg',
-      )
-    ]
-  )
+    types.UserContent(
+        parts=[
+            types.Part.from_text('What is this image about?'),
+            types.Part.from_uri(
+                file_uri: 'gs://generativeai-downloads/images/scones.jpg',
+                mime_type: 'image/jpeg',
+            )
+        ]
+    )
 ]
 ```
 
@@ -686,7 +677,7 @@ def get_current_weather(location: str) -> str:
     """Returns the current weather.
 
     Args:
-      location: The city and state, e.g. San Francisco, CA
+        location: The city and state, e.g. San Francisco, CA
     """
     return 'sunny'
 
@@ -708,14 +699,14 @@ as follows:
 from google.genai import types
 
 response = client.models.generate_content(
-  model='gemini-2.5-flash',
-  contents='What is the weather like in Boston?',
-  config=types.GenerateContentConfig(
-    tools=[get_current_weather],
-    automatic_function_calling=types.AutomaticFunctionCallingConfig(
-      disable=True
+    model='gemini-2.5-flash',
+    contents='What is the weather like in Boston?',
+    config=types.GenerateContentConfig(
+        tools=[get_current_weather],
+        automatic_function_calling=types.AutomaticFunctionCallingConfig(
+            disable=True
+        ),
     ),
-  ),
 )
 ```
 
@@ -829,7 +820,7 @@ def get_current_weather(location: str) -> str:
     """Returns the current weather.
 
     Args:
-      location: The city and state, e.g. San Francisco, CA
+        location: The city and state, e.g. San Francisco, CA
     """
     return "sunny"
 
@@ -859,7 +850,7 @@ def get_current_weather(location: str) -> str:
     """Returns the current weather.
 
     Args:
-      location: The city and state, e.g. San Francisco, CA
+        location: The city and state, e.g. San Francisco, CA
     """
     return "sunny"
 
@@ -1039,20 +1030,20 @@ values as the response.
 from enum import Enum
 
 class InstrumentEnum(Enum):
-  PERCUSSION = 'Percussion'
-  STRING = 'String'
-  WOODWIND = 'Woodwind'
-  BRASS = 'Brass'
-  KEYBOARD = 'Keyboard'
+    PERCUSSION = 'Percussion'
+    STRING = 'String'
+    WOODWIND = 'Woodwind'
+    BRASS = 'Brass'
+    KEYBOARD = 'Keyboard'
 
 response = client.models.generate_content(
-      model='gemini-2.5-flash',
-      contents='What instrument plays multiple notes at once?',
-      config={
-          'response_mime_type': 'text/x.enum',
-          'response_schema': InstrumentEnum,
-      },
-  )
+    model='gemini-2.5-flash',
+    contents='What instrument plays multiple notes at once?',
+    config={
+        'response_mime_type': 'text/x.enum',
+        'response_schema': InstrumentEnum,
+    },
+)
 print(response.text)
 ```
 
@@ -1065,20 +1056,20 @@ identical but in quotes.
 from enum import Enum
 
 class InstrumentEnum(Enum):
-  PERCUSSION = 'Percussion'
-  STRING = 'String'
-  WOODWIND = 'Woodwind'
-  BRASS = 'Brass'
-  KEYBOARD = 'Keyboard'
+    PERCUSSION = 'Percussion'
+    STRING = 'String'
+    WOODWIND = 'Woodwind'
+    BRASS = 'Brass'
+    KEYBOARD = 'Keyboard'
 
 response = client.models.generate_content(
-      model='gemini-2.5-flash',
-      contents='What instrument plays multiple notes at once?',
-      config={
-          'response_mime_type': 'application/json',
-          'response_schema': InstrumentEnum,
-      },
-  )
+    model='gemini-2.5-flash',
+    contents='What instrument plays multiple notes at once?',
+    config={
+        'response_mime_type': 'application/json',
+        'response_schema': InstrumentEnum,
+    },
+)
 print(response.text)
 ```
 
@@ -1156,7 +1147,6 @@ print(response.text)
 
 ### Generate Content (Asynchronous Streaming)
 
-
 ```python
 async for chunk in await client.aio.models.generate_content_stream(
     model='gemini-2.5-flash', contents='Tell me a story in 300 words.'
@@ -1214,7 +1204,7 @@ result = tokenizer.compute_tokens("What is your name?")
 
 ```python
 response = client.models.embed_content(
-    model='text-embedding-004',
+    model='gemini-embedding-001',
     contents='why is the sky blue?',
 )
 print(response)
@@ -1225,7 +1215,7 @@ from google.genai import types
 
 # multiple contents with config
 response = client.models.embed_content(
-    model='text-embedding-004',
+    model='gemini-embedding-001',
     contents=['why is the sky blue?', 'What is your age?'],
     config=types.EmbedContentConfig(output_dimensionality=10),
 )
@@ -1455,7 +1445,7 @@ async for chunk in await chat.send_message_stream('tell me a story'):
 Files are only supported in Gemini Developer API. See the 'Create a client'
 section above to initialize a client.
 
-```cmd
+```sh
 !gsutil cp gs://cloud-samples-data/generative-ai/pdf/2312.11805v3.pdf .
 !gsutil cp gs://cloud-samples-data/generative-ai/pdf/2403.05530.pdf .
 ```
@@ -1556,14 +1546,14 @@ section above to initialize a client.
 
 ### Tune
 
--   Vertex AI supports tuning from GCS source or from a Vertex Multimodal Dataset
+-   Vertex AI supports tuning from GCS source or from a [Vertex AI Multimodal Dataset](https://docs.cloud.google.com/vertex-ai/generative-ai/docs/multimodal/datasets)
 
 ```python
 from google.genai import types
 
 model = 'gemini-2.5-flash'
 training_dataset = types.TuningDataset(
-  # or gcs_uri=my_vertex_multimodal_dataset
+    # or gcs_uri=my_vertex_multimodal_dataset
     gcs_uri='gs://cloud-samples-data/ai-platform/generative_ai/gemini-1_5/text/sft_train_data.jsonl',
 )
 ```
@@ -1719,7 +1709,7 @@ job = client.batches.create(
     src='bq://my-project.my-dataset.my-table',  # or "gs://path/to/input/data"
 )
 
-job
+print(job)
 ```
 
 Gemini Developer API:
@@ -1729,13 +1719,13 @@ Gemini Developer API:
 batch_job = client.batches.create(
     model="gemini-2.5-flash",
     src=[{
-      "contents": [{
-        "parts": [{
-          "text": "Hello!",
+        "contents": [{
+            "parts": [{
+                "text": "Hello!",
+            }],
+            "role": "user",
         }],
-       "role": "user",
-     }],
-     "config": {"response_modalities": ["text"]},
+        "config": {"response_modalities": ["text"]},
     }],
 )
 
@@ -1843,13 +1833,13 @@ To handle errors raised by the model service, the SDK provides this [APIError](h
 from google.genai import errors
 
 try:
-  client.models.generate_content(
-      model="invalid-model-name",
-      contents="What is your name?",
-  )
+    client.models.generate_content(
+        model="invalid-model-name",
+        contents="What is your name?",
+    )
 except errors.APIError as e:
-  print(e.code) # 404
-  print(e.message)
+    print(e.code) # 404
+    print(e.message)
 ```
 
 ## Extra Request Body