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

google/genai/_interactions/types/turn_param.py

@@ -0,0 +1,73 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union, Iterable
+from typing_extensions import TypeAlias, TypedDict
+
+from .text_content_param import TextContentParam
+from .audio_content_param import AudioContentParam
+from .image_content_param import ImageContentParam
+from .video_content_param import VideoContentParam
+from .thought_content_param import ThoughtContentParam
+from .document_content_param import DocumentContentParam
+from .function_call_content_param import FunctionCallContentParam
+from .function_result_content_param import FunctionResultContentParam
+from .url_context_call_content_param import URLContextCallContentParam
+from .file_search_result_content_param import FileSearchResultContentParam
+from .google_search_call_content_param import GoogleSearchCallContentParam
+from .url_context_result_content_param import URLContextResultContentParam
+from .code_execution_call_content_param import CodeExecutionCallContentParam
+from .google_search_result_content_param import GoogleSearchResultContentParam
+from .mcp_server_tool_call_content_param import MCPServerToolCallContentParam
+from .code_execution_result_content_param import CodeExecutionResultContentParam
+from .mcp_server_tool_result_content_param import MCPServerToolResultContentParam
+
+__all__ = ["TurnParam", "ContentUnionMember1"]
+
+ContentUnionMember1: TypeAlias = Union[
+    TextContentParam,
+    ImageContentParam,
+    AudioContentParam,
+    DocumentContentParam,
+    VideoContentParam,
+    ThoughtContentParam,
+    FunctionCallContentParam,
+    FunctionResultContentParam,
+    CodeExecutionCallContentParam,
+    CodeExecutionResultContentParam,
+    URLContextCallContentParam,
+    URLContextResultContentParam,
+    GoogleSearchCallContentParam,
+    GoogleSearchResultContentParam,
+    MCPServerToolCallContentParam,
+    MCPServerToolResultContentParam,
+    FileSearchResultContentParam,
+]
+
+
+class TurnParam(TypedDict, total=False):
+    content: Union[str, Iterable[ContentUnionMember1]]
+    """The content of the turn."""
+
+    role: str
+    """The originator of this turn.
+
+    Must be user for input or model for
+    model output.
+    """

google/genai/_interactions/types/url_context_call_arguments.py

@@ -0,0 +1,29 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from .._models import BaseModel
+
+__all__ = ["URLContextCallArguments"]
+
+
+class URLContextCallArguments(BaseModel):
+    """The arguments to pass to the URL context."""
+
+    urls: Optional[List[str]] = None
+    """The URLs to fetch."""

google/genai/_interactions/types/url_context_call_arguments_param.py

@@ -0,0 +1,31 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import TypedDict
+
+from .._types import SequenceNotStr
+
+__all__ = ["URLContextCallArgumentsParam"]
+
+
+class URLContextCallArgumentsParam(TypedDict, total=False):
+    """The arguments to pass to the URL context."""
+
+    urls: SequenceNotStr[str]
+    """The URLs to fetch."""

google/genai/_interactions/types/url_context_call_content.py

@@ -0,0 +1,37 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .url_context_call_arguments import URLContextCallArguments
+
+__all__ = ["URLContextCallContent"]
+
+
+class URLContextCallContent(BaseModel):
+    """URL context content."""
+
+    type: Literal["url_context_call"]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    id: Optional[str] = None
+    """A unique ID for this specific tool call."""
+
+    arguments: Optional[URLContextCallArguments] = None
+    """The arguments to pass to the URL context."""

google/genai/_interactions/types/url_context_call_content_param.py

@@ -0,0 +1,37 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+from .url_context_call_arguments_param import URLContextCallArgumentsParam
+
+__all__ = ["URLContextCallContentParam"]
+
+
+class URLContextCallContentParam(TypedDict, total=False):
+    """URL context content."""
+
+    type: Required[Literal["url_context_call"]]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    id: str
+    """A unique ID for this specific tool call."""
+
+    arguments: URLContextCallArgumentsParam
+    """The arguments to pass to the URL context."""

google/genai/_interactions/types/url_context_result.py

@@ -0,0 +1,33 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["URLContextResult"]
+
+
+class URLContextResult(BaseModel):
+    """The result of the URL context."""
+
+    status: Optional[Literal["success", "error", "paywall", "unsafe"]] = None
+    """The status of the URL retrieval."""
+
+    url: Optional[str] = None
+    """The URL that was fetched."""

google/genai/_interactions/types/url_context_result_content.py

@@ -0,0 +1,43 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .url_context_result import URLContextResult
+
+__all__ = ["URLContextResultContent"]
+
+
+class URLContextResultContent(BaseModel):
+    """URL context result content."""
+
+    type: Literal["url_context_result"]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    call_id: Optional[str] = None
+    """ID to match the ID from the url context call block."""
+
+    is_error: Optional[bool] = None
+    """Whether the URL context resulted in an error."""
+
+    result: Optional[List[URLContextResult]] = None
+    """The results of the URL context."""
+
+    signature: Optional[str] = None
+    """The signature of the URL context result."""

google/genai/_interactions/types/url_context_result_content_param.py

@@ -0,0 +1,44 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, Required, TypedDict
+
+from .url_context_result_param import URLContextResultParam
+
+__all__ = ["URLContextResultContentParam"]
+
+
+class URLContextResultContentParam(TypedDict, total=False):
+    """URL context result content."""
+
+    type: Required[Literal["url_context_result"]]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    call_id: str
+    """ID to match the ID from the url context call block."""
+
+    is_error: bool
+    """Whether the URL context resulted in an error."""
+
+    result: Iterable[URLContextResultParam]
+    """The results of the URL context."""
+
+    signature: str
+    """The signature of the URL context result."""

google/genai/_interactions/types/url_context_result_param.py

@@ -0,0 +1,32 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, TypedDict
+
+__all__ = ["URLContextResultParam"]
+
+
+class URLContextResultParam(TypedDict, total=False):
+    """The result of the URL context."""
+
+    status: Literal["success", "error", "paywall", "unsafe"]
+    """The status of the URL retrieval."""
+
+    url: str
+    """The URL that was fetched."""

google/genai/_interactions/types/usage.py

@@ -0,0 +1,106 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = [
+    "Usage",
+    "CachedTokensByModality",
+    "InputTokensByModality",
+    "OutputTokensByModality",
+    "ToolUseTokensByModality",
+]
+
+
+class CachedTokensByModality(BaseModel):
+    """The token count for a single response modality."""
+
+    modality: Optional[Literal["text", "image", "audio"]] = None
+    """The modality associated with the token count."""
+
+    tokens: Optional[int] = None
+    """Number of tokens for the modality."""
+
+
+class InputTokensByModality(BaseModel):
+    """The token count for a single response modality."""
+
+    modality: Optional[Literal["text", "image", "audio"]] = None
+    """The modality associated with the token count."""
+
+    tokens: Optional[int] = None
+    """Number of tokens for the modality."""
+
+
+class OutputTokensByModality(BaseModel):
+    """The token count for a single response modality."""
+
+    modality: Optional[Literal["text", "image", "audio"]] = None
+    """The modality associated with the token count."""
+
+    tokens: Optional[int] = None
+    """Number of tokens for the modality."""
+
+
+class ToolUseTokensByModality(BaseModel):
+    """The token count for a single response modality."""
+
+    modality: Optional[Literal["text", "image", "audio"]] = None
+    """The modality associated with the token count."""
+
+    tokens: Optional[int] = None
+    """Number of tokens for the modality."""
+
+
+class Usage(BaseModel):
+    """Statistics on the interaction request's token usage."""
+
+    cached_tokens_by_modality: Optional[List[CachedTokensByModality]] = None
+    """A breakdown of cached token usage by modality."""
+
+    input_tokens_by_modality: Optional[List[InputTokensByModality]] = None
+    """A breakdown of input token usage by modality."""
+
+    output_tokens_by_modality: Optional[List[OutputTokensByModality]] = None
+    """A breakdown of output token usage by modality."""
+
+    tool_use_tokens_by_modality: Optional[List[ToolUseTokensByModality]] = None
+    """A breakdown of tool-use token usage by modality."""
+
+    total_cached_tokens: Optional[int] = None
+    """Number of tokens in the cached part of the prompt (the cached content)."""
+
+    total_input_tokens: Optional[int] = None
+    """Number of tokens in the prompt (context)."""
+
+    total_output_tokens: Optional[int] = None
+    """Total number of tokens across all the generated responses."""
+
+    total_reasoning_tokens: Optional[int] = None
+    """Number of tokens of thoughts for thinking models."""
+
+    total_tokens: Optional[int] = None
+    """
+    Total token count for the interaction request (prompt + responses + other
+    internal tokens).
+    """
+
+    total_tool_use_tokens: Optional[int] = None
+    """Number of tokens present in tool-use prompt(s)."""

google/genai/_interactions/types/usage_param.py

@@ -0,0 +1,106 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, TypedDict
+
+__all__ = [
+    "UsageParam",
+    "CachedTokensByModality",
+    "InputTokensByModality",
+    "OutputTokensByModality",
+    "ToolUseTokensByModality",
+]
+
+
+class CachedTokensByModality(TypedDict, total=False):
+    """The token count for a single response modality."""
+
+    modality: Literal["text", "image", "audio"]
+    """The modality associated with the token count."""
+
+    tokens: int
+    """Number of tokens for the modality."""
+
+
+class InputTokensByModality(TypedDict, total=False):
+    """The token count for a single response modality."""
+
+    modality: Literal["text", "image", "audio"]
+    """The modality associated with the token count."""
+
+    tokens: int
+    """Number of tokens for the modality."""
+
+
+class OutputTokensByModality(TypedDict, total=False):
+    """The token count for a single response modality."""
+
+    modality: Literal["text", "image", "audio"]
+    """The modality associated with the token count."""
+
+    tokens: int
+    """Number of tokens for the modality."""
+
+
+class ToolUseTokensByModality(TypedDict, total=False):
+    """The token count for a single response modality."""
+
+    modality: Literal["text", "image", "audio"]
+    """The modality associated with the token count."""
+
+    tokens: int
+    """Number of tokens for the modality."""
+
+
+class UsageParam(TypedDict, total=False):
+    """Statistics on the interaction request's token usage."""
+
+    cached_tokens_by_modality: Iterable[CachedTokensByModality]
+    """A breakdown of cached token usage by modality."""
+
+    input_tokens_by_modality: Iterable[InputTokensByModality]
+    """A breakdown of input token usage by modality."""
+
+    output_tokens_by_modality: Iterable[OutputTokensByModality]
+    """A breakdown of output token usage by modality."""
+
+    tool_use_tokens_by_modality: Iterable[ToolUseTokensByModality]
+    """A breakdown of tool-use token usage by modality."""
+
+    total_cached_tokens: int
+    """Number of tokens in the cached part of the prompt (the cached content)."""
+
+    total_input_tokens: int
+    """Number of tokens in the prompt (context)."""
+
+    total_output_tokens: int
+    """Total number of tokens across all the generated responses."""
+
+    total_reasoning_tokens: int
+    """Number of tokens of thoughts for thinking models."""
+
+    total_tokens: int
+    """
+    Total token count for the interaction request (prompt + responses + other
+    internal tokens).
+    """
+
+    total_tool_use_tokens: int
+    """Number of tokens present in tool-use prompt(s)."""

google/genai/_interactions/types/video_content.py

@@ -0,0 +1,41 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+from .video_mime_type import VideoMimeType
+
+__all__ = ["VideoContent"]
+
+
+class VideoContent(BaseModel):
+    """A video content block."""
+
+    type: Literal["video"]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    data: Optional[str] = None
+
+    mime_type: Optional[VideoMimeType] = None
+    """The mime type of the video."""
+
+    resolution: Optional[Literal["low", "medium", "high"]] = None
+    """The resolution of the media."""
+
+    uri: Optional[str] = None

google/genai/_interactions/types/video_content_param.py

@@ -0,0 +1,48 @@
+# 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.
+#
+
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Union
+from typing_extensions import Literal, Required, Annotated, TypedDict
+
+from .._types import Base64FileInput
+from .._utils import PropertyInfo
+from .._models import set_pydantic_config
+from .video_mime_type_param import VideoMimeTypeParam
+
+__all__ = ["VideoContentParam"]
+
+
+class VideoContentParam(TypedDict, total=False):
+    """A video content block."""
+
+    type: Required[Literal["video"]]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    data: Annotated[Union[str, Base64FileInput], PropertyInfo(format="base64")]
+
+    mime_type: VideoMimeTypeParam
+    """The mime type of the video."""
+
+    resolution: Literal["low", "medium", "high"]
+    """The resolution of the media."""
+
+    uri: str
+
+
+set_pydantic_config(VideoContentParam, {"arbitrary_types_allowed": True})