google-genai 1.53.0__py3-none-any.whl → 1.55.0__py3-none-any.whl

google/genai/tests/file_search_stores/test_import_file.py

@@ -0,0 +1,112 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Tests for file_search_stores.upload_to_file_search_store()."""
+
+import io
+import pathlib
+import pytest
+from ... import types
+from .. import pytest_helper
+
+_FILE_SEARCH_STORE_NAME = 'fileSearchStores/my-store-37cbhu1nw16r'
+_FILE_NAME = 'files/mk4h34zkv33d'
+
+test_table: list[pytest_helper.TestTableItem] = []
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method='filesearchstores.import_file',
+    test_table=test_table,
+)
+
+
+def test_import(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = client.file_search_stores.import_file(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME, file_name=_FILE_NAME
+    )
+
+
+def test_chunking(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = client.file_search_stores.import_file(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file_name=_FILE_NAME,
+        config=types.ImportFileConfig(
+            chunking_config=types.ChunkingConfig(
+                white_space_config=types.WhiteSpaceConfig(
+                    max_tokens_per_chunk=200,
+                    max_overlap_tokens=20,
+                )
+            ),
+        ),
+    )
+
+
+def test_metadata(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = client.file_search_stores.import_file(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file_name=_FILE_NAME,
+        config=types.ImportFileConfig(
+            custom_metadata=[
+                types.CustomMetadata(key='year', numeric_value=2024),
+                types.CustomMetadata(key='tag', string_value='story'),
+            ],
+        ),
+    )
+
+
+@pytest.mark.asyncio
+async def test_async_import(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = await client.aio.file_search_stores.import_file(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file_name=_FILE_NAME,
+    )
+
+
+@pytest.mark.asyncio
+async def test_async_chunking(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = await client.aio.file_search_stores.import_file(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file_name=_FILE_NAME,
+        config=types.ImportFileConfig(
+            chunking_config=types.ChunkingConfig(
+                white_space_config=types.WhiteSpaceConfig(
+                    max_tokens_per_chunk=200,
+                    max_overlap_tokens=20,
+                )
+            ),
+        ),
+    )
+
+
+@pytest.mark.asyncio
+async def test_async_metadata(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = await client.aio.file_search_stores.import_file(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file_name=_FILE_NAME,
+        config=types.ImportFileConfig(
+            custom_metadata=[
+                types.CustomMetadata(key='year', numeric_value=2024),
+                types.CustomMetadata(key='tag', string_value='story'),
+            ],
+        ),
+    )

google/genai/tests/file_search_stores/test_list.py

@@ -0,0 +1,57 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+"""Tests for file_search_stores.list()."""
+
+import pytest
+
+from ... import types
+from .. import pytest_helper
+
+# All tests will be run for both Vertex and MLDev.
+test_table: list[pytest_helper.TestTableItem] = [
+    pytest_helper.TestTableItem(
+        name="test_list_default",
+        parameters=types._ListFileSearchStoresParameters(),
+        exception_if_vertex="only supported in the Gemini Developer client",
+    ),
+    pytest_helper.TestTableItem(
+        name="test_list_with_page_size",
+        parameters=types._ListFileSearchStoresParameters(
+            config=types.ListFileSearchStoresConfig(
+                page_size=5,
+            ),
+        ),
+        exception_if_vertex="only supported in the Gemini Developer client",
+    ),
+]
+
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method="file_search_stores.list",
+    test_table=test_table,
+)
+
+
+@pytest.mark.asyncio
+async def test_async_pager(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    # Iterate through the first page.
+    async for file_search_store in await client.aio.file_search_stores.list(
+        config={"page_size": 2}
+    ):
+      assert isinstance(file_search_store, types.FileSearchStore)
+      break  # Only check one item

google/genai/tests/file_search_stores/test_upload_to_file_search_store.py

@@ -0,0 +1,141 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Tests for file_search_stores.upload_to_file_search_store()."""
+
+import io
+import pathlib
+import pytest
+from ... import types
+from .. import pytest_helper
+
+_FILE_SEARCH_STORE_NAME = 'fileSearchStores/my-store-37cbhu1nw16r'
+
+test_table: list[pytest_helper.TestTableItem] = []
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method='filesearchstores.upload_to_file_search_store',
+    test_table=test_table,
+)
+
+
+def test_file_path(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = client.file_search_stores.upload_to_file_search_store(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file='tests/data/story.pdf',
+    )
+
+
+def test_bytesio(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    with open('tests/data/story.pdf', 'rb') as f:
+      with io.BytesIO(f.read()) as buffer:
+        operation = client.file_search_stores.upload_to_file_search_store(
+            file_search_store_name=_FILE_SEARCH_STORE_NAME,
+            file=buffer,
+            config=types.UploadToFileSearchStoreConfig(
+                mime_type='application/pdf',
+            ),
+        )
+
+
+def test_chunking(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = client.file_search_stores.upload_to_file_search_store(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file='tests/data/story.pdf',
+        config=types.UploadToFileSearchStoreConfig(
+            chunking_config=types.ChunkingConfig(
+                white_space_config=types.WhiteSpaceConfig(
+                    max_tokens_per_chunk=200,
+                    max_overlap_tokens=20,
+                )
+            ),
+        ),
+    )
+
+
+def test_metadata(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = client.file_search_stores.upload_to_file_search_store(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file='tests/data/story.pdf',
+        config=types.UploadToFileSearchStoreConfig(
+            custom_metadata=[
+                types.CustomMetadata(key='year', numeric_value=2024),
+                types.CustomMetadata(key='tag', string_value='story'),
+            ],
+        ),
+    )
+
+
+@pytest.mark.asyncio
+async def test_async_file_path(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = await client.aio.file_search_stores.upload_to_file_search_store(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file='tests/data/story.pdf',
+    )
+
+
+@pytest.mark.asyncio
+async def test_async_bytesio(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    with open('tests/data/story.pdf', 'rb') as f:
+      with io.BytesIO(f.read()) as buffer:
+        operation = (
+            await client.aio.file_search_stores.upload_to_file_search_store(
+                file_search_store_name=_FILE_SEARCH_STORE_NAME,
+                file=buffer,
+                config=types.UploadToFileSearchStoreConfig(
+                    mime_type='application/pdf',
+                ),
+            )
+        )
+
+
+@pytest.mark.asyncio
+async def test_async_chunking(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = await client.aio.file_search_stores.upload_to_file_search_store(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file='tests/data/story.pdf',
+        config=types.UploadToFileSearchStoreConfig(
+            chunking_config=types.ChunkingConfig(
+                white_space_config=types.WhiteSpaceConfig(
+                    max_tokens_per_chunk=200,
+                    max_overlap_tokens=20,
+                )
+            ),
+        ),
+    )
+
+
+@pytest.mark.asyncio
+async def test_async_metadata(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    operation = await client.aio.file_search_stores.upload_to_file_search_store(
+        file_search_store_name=_FILE_SEARCH_STORE_NAME,
+        file='tests/data/story.pdf',
+        config=types.UploadToFileSearchStoreConfig(
+            custom_metadata=[
+                types.CustomMetadata(key='year', numeric_value=2024),
+                types.CustomMetadata(key='tag', string_value='story'),
+            ],
+        ),
+    )

google/genai/tests/files/__init__.py

@@ -0,0 +1,17 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Tests for the Google GenAI SDK's files module."""

google/genai/tests/files/test_delete.py

@@ -0,0 +1,46 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Test files delete method."""
+
+import pytest
+from ... import types
+from .. import pytest_helper
+
+test_table: list[pytest_helper.TestTableItem] = [
+    pytest_helper.TestTableItem(
+        name='test_delete',
+        parameters=types._DeleteFileParameters(name='files/1g583ke2xdsn'),
+        exception_if_vertex='only supported in the Gemini Developer client',
+        skip_in_api_mode=(
+            'The files have a TTL, they cannot be reliably retrieved for a long'
+            ' time.'
+        ),
+    ),
+]
+
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method='files.delete',
+    test_table=test_table,
+)
+
+
+@pytest.mark.asyncio
+async def test_async(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    file = await client.aio.files.get(name='files/n1gls7dyh90q')

google/genai/tests/files/test_download.py

@@ -0,0 +1,85 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Test files upload method."""
+
+
+import pathlib
+import pytest
+from ... import _transformers as t
+from ... import types
+from .. import pytest_helper
+
+
+test_table: list[pytest_helper.TestTableItem] = []
+
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method='t.t_file_name',
+    test_table=test_table,
+)
+
+pytest_plugins = ('pytest_asyncio',)
+
+
+def test_name_transform_name(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    for file in client.files.list():
+      if file.download_uri is not None:
+        break
+    else:
+      raise ValueError('No files found with a `download_uri`.')
+
+    file_id = file.name.split('/')[-1]
+    video = types.Video(uri=file.download_uri)
+    generated_video = types.GeneratedVideo(video=video)
+    for f in [
+        file,
+        file_id,
+        file.name,
+        file.uri,
+        file.download_uri,
+        video,
+        generated_video,
+    ]:
+      name = t.t_file_name(f)
+      assert name == file_id
+
+
+def test_basic_download(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    for file in client.files.list():
+      if file.download_uri is not None:
+        break
+    else:
+      raise ValueError('No files found with a `download_uri`.')
+
+    content = client.files.download(file=file)
+    assert content[4:8] == b'ftyp'
+
+
+@pytest.mark.asyncio
+async def test_basic_download_async(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    async for file in await client.aio.files.list():
+      if file.download_uri is not None:
+        break
+    else:
+      raise ValueError('No files found with a `download_uri`.')
+
+    content = await client.aio.files.download(file=file)
+    assert content[4:8] == b'ftyp'

google/genai/tests/files/test_get.py

@@ -0,0 +1,46 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Test files get method."""
+
+import pytest
+from ... import types
+from .. import pytest_helper
+
+test_table: list[pytest_helper.TestTableItem] = [
+    pytest_helper.TestTableItem(
+        name='test_get',
+        parameters=types._GetFileParameters(name='files/vjvu9fwk2qj8'),
+        exception_if_vertex='only supported in the Gemini Developer client',
+        skip_in_api_mode=(
+            'The files have a TTL, they cannot be reliably retrieved for a long'
+            ' time.'
+        ),
+    ),
+]
+
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method='files.get',
+    test_table=test_table,
+)
+
+
+@pytest.mark.asyncio
+async def test_async(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    file = await client.aio.files.get(name='files/vjvu9fwk2qj8')

google/genai/tests/files/test_list.py

@@ -0,0 +1,72 @@
+# Copyright 2025 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+
+"""Test files list method."""
+
+import pytest
+
+from ... import types
+from .. import pytest_helper
+
+test_table: list[pytest_helper.TestTableItem] = [
+    pytest_helper.TestTableItem(
+        name='test_not_empty',
+        exception_if_vertex='only supported in the Gemini Developer client',
+        parameters=types._ListFilesParameters(
+            config=types.ListFilesConfig(
+                page_size=2,
+            ),
+        ),
+    ),
+]
+pytestmark = pytest_helper.setup(
+    file=__file__,
+    globals_for_file=globals(),
+    test_method='files.list',
+    test_table=test_table,
+)
+
+
+def test_pager(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    files = client.files.list(config={'page_size': 2})
+    assert 'content-type' in files.sdk_http_response.headers
+    assert files.name == 'files'
+    assert files.page_size == 2
+    assert len(files) <= 2
+
+    # Iterate through all the pages. Then next_page() should raise an exception.
+    for _ in files:
+      pass
+    with pytest.raises(IndexError, match='No more pages to fetch.'):
+      files.next_page()
+
+
+@pytest.mark.asyncio
+async def test_async_pager(client):
+  with pytest_helper.exception_if_vertex(client, ValueError):
+    files = await client.aio.files.list(config={'page_size': 2})
+
+    assert 'Content-Type' in files.sdk_http_response.headers
+    assert files.name == 'files'
+    assert files.page_size == 2
+    assert len(files) <= 2
+
+    # Iterate through all the pages. Then next_page() should raise an exception.
+    async for _ in files:
+      pass
+    with pytest.raises(IndexError, match='No more pages to fetch.'):
+      await files.next_page()