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

google/genai/_interactions/types/interaction_create_params.py

@@ -0,0 +1,212 @@
+# 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 List, Union, Iterable
+from typing_extensions import Literal, Required, TypeAlias, TypedDict
+
+from .tool_param import ToolParam
+from .turn_param import TurnParam
+from .model_param import ModelParam
+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 .generation_config_param import GenerationConfigParam
+from .dynamic_agent_config_param import DynamicAgentConfigParam
+from .function_call_content_param import FunctionCallContentParam
+from .function_result_content_param import FunctionResultContentParam
+from .url_context_call_content_param import URLContextCallContentParam
+from .deep_research_agent_config_param import DeepResearchAgentConfigParam
+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__ = [
+    "BaseCreateModelInteractionParams",
+    "Input",
+    "ContentList",
+    "BaseCreateAgentInteractionParams",
+    "AgentConfig",
+    "CreateModelInteractionParamsNonStreaming",
+    "CreateModelInteractionParamsStreaming",
+    "CreateAgentInteractionParamsNonStreaming",
+    "CreateAgentInteractionParamsStreaming",
+]
+
+
+class BaseCreateModelInteractionParams(TypedDict, total=False):
+    input: Required[Input]
+    """The inputs for the interaction."""
+
+    model: Required[ModelParam]
+    """The name of the `Model` used for generating the interaction."""
+
+    api_version: str
+
+    background: bool
+    """Whether to run the model interaction in the background."""
+
+    generation_config: GenerationConfigParam
+    """Input only. Configuration parameters for the model interaction."""
+
+    previous_interaction_id: str
+    """The ID of the previous interaction, if any."""
+
+    response_format: object
+    """
+    Enforces that the generated response is a JSON object that complies with
+    the JSON schema specified in this field.
+    """
+
+    response_mime_type: str
+    """The mime type of the response. This is required if response_format is set."""
+
+    response_modalities: List[Literal["text", "image", "audio"]]
+    """The requested modalities of the response (TEXT, IMAGE, AUDIO)."""
+
+    store: bool
+    """Input only. Whether to store the response and request for later retrieval."""
+
+    system_instruction: str
+    """System instruction for the interaction."""
+
+    tools: Iterable[ToolParam]
+    """A list of tool declarations the model may call during interaction."""
+
+
+ContentList: TypeAlias = Union[
+    TextContentParam,
+    ImageContentParam,
+    AudioContentParam,
+    DocumentContentParam,
+    VideoContentParam,
+    ThoughtContentParam,
+    FunctionCallContentParam,
+    FunctionResultContentParam,
+    CodeExecutionCallContentParam,
+    CodeExecutionResultContentParam,
+    URLContextCallContentParam,
+    URLContextResultContentParam,
+    GoogleSearchCallContentParam,
+    GoogleSearchResultContentParam,
+    MCPServerToolCallContentParam,
+    MCPServerToolResultContentParam,
+    FileSearchResultContentParam,
+]
+
+Input: TypeAlias = Union[
+    str,
+    Iterable[ContentList],
+    Iterable[TurnParam],
+    TextContentParam,
+    ImageContentParam,
+    AudioContentParam,
+    DocumentContentParam,
+    VideoContentParam,
+    ThoughtContentParam,
+    FunctionCallContentParam,
+    FunctionResultContentParam,
+    CodeExecutionCallContentParam,
+    CodeExecutionResultContentParam,
+    URLContextCallContentParam,
+    URLContextResultContentParam,
+    GoogleSearchCallContentParam,
+    GoogleSearchResultContentParam,
+    MCPServerToolCallContentParam,
+    MCPServerToolResultContentParam,
+    FileSearchResultContentParam,
+]
+
+
+class BaseCreateAgentInteractionParams(TypedDict, total=False):
+    agent: Required[Union[str, Literal["deep-research-pro-preview-12-2025"]]]
+    """The name of the `Agent` used for generating the interaction."""
+
+    input: Required[Input]
+    """The inputs for the interaction."""
+
+    api_version: str
+
+    agent_config: AgentConfig
+    """Configuration for the agent."""
+
+    background: bool
+    """Whether to run the model interaction in the background."""
+
+    previous_interaction_id: str
+    """The ID of the previous interaction, if any."""
+
+    response_format: object
+    """
+    Enforces that the generated response is a JSON object that complies with
+    the JSON schema specified in this field.
+    """
+
+    response_mime_type: str
+    """The mime type of the response. This is required if response_format is set."""
+
+    response_modalities: List[Literal["text", "image", "audio"]]
+    """The requested modalities of the response (TEXT, IMAGE, AUDIO)."""
+
+    store: bool
+    """Input only. Whether to store the response and request for later retrieval."""
+
+    system_instruction: str
+    """System instruction for the interaction."""
+
+    tools: Iterable[ToolParam]
+    """A list of tool declarations the model may call during interaction."""
+
+
+AgentConfig: TypeAlias = Union[DynamicAgentConfigParam, DeepResearchAgentConfigParam]
+
+
+class CreateModelInteractionParamsNonStreaming(BaseCreateModelInteractionParams, total=False):
+    stream: Literal[False]
+    """Input only. Whether the interaction will be streamed."""
+
+
+class CreateModelInteractionParamsStreaming(BaseCreateModelInteractionParams):
+    stream: Required[Literal[True]]
+    """Input only. Whether the interaction will be streamed."""
+
+
+class CreateAgentInteractionParamsNonStreaming(BaseCreateAgentInteractionParams, total=False):
+    stream: Literal[False]
+    """Input only. Whether the interaction will be streamed."""
+
+
+class CreateAgentInteractionParamsStreaming(BaseCreateAgentInteractionParams):
+    stream: Required[Literal[True]]
+    """Input only. Whether the interaction will be streamed."""
+
+
+InteractionCreateParams = Union[
+    CreateModelInteractionParamsNonStreaming,
+    CreateModelInteractionParamsStreaming,
+    CreateAgentInteractionParamsNonStreaming,
+    CreateAgentInteractionParamsStreaming,
+]

google/genai/_interactions/types/interaction_event.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 .interaction import Interaction
+
+__all__ = ["InteractionEvent"]
+
+
+class InteractionEvent(BaseModel):
+    event_id: Optional[str] = None
+    """
+    The event_id token to be used to resume the interaction stream, from
+    this event.
+    """
+
+    event_type: Optional[Literal["interaction.start", "interaction.complete"]] = None
+
+    interaction: Optional[Interaction] = None
+    """The Interaction resource."""

google/genai/_interactions/types/interaction_get_params.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.
+#
+
+# 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, TypedDict
+
+__all__ = ["InteractionGetParamsBase", "InteractionGetParamsNonStreaming", "InteractionGetParamsStreaming"]
+
+
+class InteractionGetParamsBase(TypedDict, total=False):
+    api_version: str
+
+    last_event_id: str
+    """Optional.
+
+    If set, resumes the interaction stream from the next chunk after the event marked by the event id. Can only be used if `stream` is true.
+    """
+
+
+class InteractionGetParamsNonStreaming(InteractionGetParamsBase, total=False):
+    stream: Literal[False]
+    """If set to true, the generated content will be streamed incrementally."""
+
+
+class InteractionGetParamsStreaming(InteractionGetParamsBase):
+    stream: Required[Literal[True]]
+    """If set to true, the generated content will be streamed incrementally."""
+
+
+InteractionGetParams = Union[InteractionGetParamsNonStreaming, InteractionGetParamsStreaming]

google/genai/_interactions/types/interaction_sse_event.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 typing import Union
+from typing_extensions import TypeAlias
+
+from .error_event import ErrorEvent
+from .content_stop import ContentStop
+from .content_delta import ContentDelta
+from .content_start import ContentStart
+from .interaction_event import InteractionEvent
+from .interaction_status_update import InteractionStatusUpdate
+
+__all__ = ["InteractionSSEEvent"]
+
+InteractionSSEEvent: TypeAlias = Union[
+    InteractionEvent, InteractionStatusUpdate, ContentStart, ContentDelta, ContentStop, ErrorEvent
+]

google/genai/_interactions/types/interaction_status_update.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
+
+__all__ = ["InteractionStatusUpdate"]
+
+
+class InteractionStatusUpdate(BaseModel):
+    event_id: Optional[str] = None
+    """
+    The event_id token to be used to resume the interaction stream, from
+    this event.
+    """
+
+    event_type: Optional[Literal["interaction.status_update"]] = None
+
+    interaction_id: Optional[str] = None
+
+    status: Optional[Literal["in_progress", "requires_action", "completed", "failed", "cancelled"]] = None

google/genai/_interactions/types/mcp_server_tool_call_content.py

@@ -0,0 +1,42 @@
+# 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 Dict
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["MCPServerToolCallContent"]
+
+
+class MCPServerToolCallContent(BaseModel):
+    """MCPServer tool call content."""
+
+    id: str
+    """A unique ID for this specific tool call."""
+
+    arguments: Dict[str, object]
+    """The JSON object of arguments for the function."""
+
+    name: str
+    """The name of the tool which was called."""
+
+    server_name: str
+    """The name of the used MCP server."""
+
+    type: Literal["mcp_server_tool_call"]
+    """Used as the OpenAPI type discriminator for the content oneof."""

google/genai/_interactions/types/mcp_server_tool_call_content_param.py

@@ -0,0 +1,42 @@
+# 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 Dict
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["MCPServerToolCallContentParam"]
+
+
+class MCPServerToolCallContentParam(TypedDict, total=False):
+    """MCPServer tool call content."""
+
+    id: Required[str]
+    """A unique ID for this specific tool call."""
+
+    arguments: Required[Dict[str, object]]
+    """The JSON object of arguments for the function."""
+
+    name: Required[str]
+    """The name of the tool which was called."""
+
+    server_name: Required[str]
+    """The name of the used MCP server."""
+
+    type: Required[Literal["mcp_server_tool_call"]]
+    """Used as the OpenAPI type discriminator for the content oneof."""

google/genai/_interactions/types/mcp_server_tool_result_content.py

@@ -0,0 +1,52 @@
+# 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, Union, Optional
+from typing_extensions import Literal, TypeAlias
+
+from .._models import BaseModel
+from .image_content import ImageContent
+
+__all__ = ["MCPServerToolResultContent", "Result", "ResultItems", "ResultItemsItem"]
+
+ResultItemsItem: TypeAlias = Union[str, ImageContent]
+
+
+class ResultItems(BaseModel):
+    items: Optional[List[ResultItemsItem]] = None
+
+
+Result: TypeAlias = Union[ResultItems, str, object]
+
+
+class MCPServerToolResultContent(BaseModel):
+    """MCPServer tool result content."""
+
+    call_id: str
+    """ID to match the ID from the MCP server tool call block."""
+
+    result: Result
+    """The result of the tool call."""
+
+    type: Literal["mcp_server_tool_result"]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    name: Optional[str] = None
+    """Name of the tool which is called for this specific tool call."""
+
+    server_name: Optional[str] = None
+    """The name of the used MCP server."""

google/genai/_interactions/types/mcp_server_tool_result_content_param.py

@@ -0,0 +1,54 @@
+# 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, TypeAlias, TypedDict
+
+from .._types import SequenceNotStr
+from .image_content_param import ImageContentParam
+
+__all__ = ["MCPServerToolResultContentParam", "Result", "ResultItems", "ResultItemsItem"]
+
+ResultItemsItem: TypeAlias = Union[str, ImageContentParam]
+
+
+class ResultItems(TypedDict, total=False):
+    items: SequenceNotStr[ResultItemsItem]
+
+
+Result: TypeAlias = Union[ResultItems, str, object]
+
+
+class MCPServerToolResultContentParam(TypedDict, total=False):
+    """MCPServer tool result content."""
+
+    call_id: Required[str]
+    """ID to match the ID from the MCP server tool call block."""
+
+    result: Required[Result]
+    """The result of the tool call."""
+
+    type: Required[Literal["mcp_server_tool_result"]]
+    """Used as the OpenAPI type discriminator for the content oneof."""
+
+    name: str
+    """Name of the tool which is called for this specific tool call."""
+
+    server_name: str
+    """The name of the used MCP server."""

google/genai/_interactions/types/model.py

@@ -0,0 +1,36 @@
+# 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 Union
+from typing_extensions import Literal, TypeAlias
+
+__all__ = ["Model"]
+
+Model: TypeAlias = Union[
+    Literal[
+        "gemini-2.5-pro",
+        "gemini-2.5-flash",
+        "gemini-2.5-flash-preview-09-2025",
+        "gemini-2.5-flash-lite",
+        "gemini-2.5-flash-lite-preview-09-2025",
+        "gemini-2.5-flash-preview-native-audio-dialog",
+        "gemini-2.5-flash-image-preview",
+        "gemini-2.5-pro-preview-tts",
+        "gemini-3-pro-preview",
+    ],
+    str,
+]

google/genai/_interactions/types/model_param.py

@@ -0,0 +1,38 @@
+# 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, TypeAlias
+
+__all__ = ["ModelParam"]
+
+ModelParam: TypeAlias = Union[
+    Literal[
+        "gemini-2.5-pro",
+        "gemini-2.5-flash",
+        "gemini-2.5-flash-preview-09-2025",
+        "gemini-2.5-flash-lite",
+        "gemini-2.5-flash-lite-preview-09-2025",
+        "gemini-2.5-flash-preview-native-audio-dialog",
+        "gemini-2.5-flash-image-preview",
+        "gemini-2.5-pro-preview-tts",
+        "gemini-3-pro-preview",
+    ],
+    str,
+]

google/genai/_interactions/types/speech_config.py

@@ -0,0 +1,35 @@
+# 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 .._models import BaseModel
+
+__all__ = ["SpeechConfig"]
+
+
+class SpeechConfig(BaseModel):
+    """The configuration for speech interaction."""
+
+    language: Optional[str] = None
+    """The language of the speech."""
+
+    speaker: Optional[str] = None
+    """The speaker's name, it should match the speaker name given in the prompt."""
+
+    voice: Optional[str] = None
+    """The voice of the speaker."""