feat: add response api

Author: liyuxuan-bd

volcenginesdkarkruntime/resources/example.py

@@ -59,7 +59,6 @@ def generate(
                 - disabled: Disables multi-image; the model generates only a single image
         """
 
-
     @overload
     def generate(
         self,
@@ -140,7 +139,10 @@ def generate(
                 "watermark": watermark,
                 "optimize_prompt": optimize_prompt,
                 "sequential_image_generation": sequential_image_generation,
-                "sequential_image_generation_options": sequential_image_generation_options.model_dump(mode='json'),
+                "sequential_image_generation_options": (
+                    sequential_image_generation_options.model_dump(mode="json")
+                    if sequential_image_generation_options is not None else None
+                ),
                 "stream": stream,
             },
             options=make_request_options(
@@ -261,7 +263,11 @@ async def generate(
                 "watermark": watermark,
                 "optimize_prompt": optimize_prompt,
                 "sequential_image_generation": sequential_image_generation,
-                "sequential_image_generation_options": sequential_image_generation_options,
+                "sequential_image_generation_options": (
+                    sequential_image_generation_options.model_dump(mode="json")
+                    if sequential_image_generation_options is not None else None
+                ),
+                "stream": stream,
             },
             options=make_request_options(
                 extra_headers=extra_headers,

volcenginesdkarkruntime/resources/images/images.py

@@ -13,4 +13,4 @@
 from .images import SequentialImageGenerationOptions, ImagesResponse
 
 
-__all__ = ["SequentialImageGenerationOptions","ImagesResponse"]
+__all__ = ["SequentialImageGenerationOptions", "ImagesResponse"]

volcenginesdkarkruntime/types/images/__init__.py

@@ -25,6 +25,7 @@ class Usage(BaseModel):
     total_tokens: int
     """The total number of tokens."""
 
+
 class Error(BaseModel):
     message: str
     """The reason for failed image generation"""

volcenginesdkarkruntime/types/images/image_gen_completed_event.py

@@ -18,6 +18,7 @@
 
 __all__ = ["ImageGenGeneratingEvent"]
 
+
 class Error(BaseModel):
     message: str
     """The reason for failed image generation"""

volcenginesdkarkruntime/types/images/image_gen_generating_event.py

@@ -15,7 +15,7 @@
 
 from volcenginesdkarkruntime._utils import PropertyInfo
 from .image_gen_completed_event import ImageGenCompletedEvent
-from .image_gen_generating_event  import ImageGenGeneratingEvent
+from .image_gen_generating_event import ImageGenGeneratingEvent
 
 __all__ = ["ImageGenStreamEvent"]
 

volcenginesdkarkruntime/types/images/image_gen_stream_event.py

@@ -16,6 +16,7 @@
 
 __all__ = ["SequentialImageGenerationOptions", "ImagesResponse"]
 
+
 class SequentialImageGenerationOptions(BaseModel):
     max_images: Optional[int] = None
     """ Maximum number of images to generate in this request; effective only when the multi-image feature is enabled """

volcenginesdkarkruntime/types/images/images.py

@@ -0,0 +1,109 @@
+
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from typing_extensions import TypedDict, Required, Optional, Iterable, Literal
+
+__all__ = [
+    "McpListTools",
+    "McpListToolsTool",
+    "McpApprovalRequest",
+    "McpApprovalResponse",
+    "McpCall",
+]
+
+
+class McpListToolsTool(TypedDict, total=False):
+    input_schema: Required[object]
+    """The JSON schema describing the tool's input."""
+
+    name: Required[str]
+    """The name of the tool."""
+
+    annotations: Optional[object]
+    """Additional annotations about the tool."""
+
+    description: Optional[str]
+    """The description of the tool."""
+
+
+class McpListTools(TypedDict, total=False):
+    id: Required[str]
+    """The unique ID of the list."""
+
+    server_label: Required[str]
+    """The label of the MCP server."""
+
+    tools: Required[Iterable[McpListToolsTool]]
+    """The tools available on the server."""
+
+    type: Required[Literal["mcp_list_tools"]]
+    """The type of the item. Always `mcp_list_tools`."""
+
+    error: Optional[str]
+    """Error message if the server could not list tools."""
+
+
+class McpApprovalRequest(TypedDict, total=False):
+    id: Required[str]
+    """The unique ID of the approval request."""
+
+    arguments: Required[str]
+    """A JSON string of arguments for the tool."""
+
+    name: Required[str]
+    """The name of the tool to run."""
+
+    server_label: Required[str]
+    """The label of the MCP server making the request."""
+
+    type: Required[Literal["mcp_approval_request"]]
+    """The type of the item. Always `mcp_approval_request`."""
+
+
+class McpApprovalResponse(TypedDict, total=False):
+    approval_request_id: Required[str]
+    """The ID of the approval request being answered."""
+
+    approve: Required[bool]
+    """Whether the request was approved."""
+
+    type: Required[Literal["mcp_approval_response"]]
+    """The type of the item. Always `mcp_approval_response`."""
+
+    id: Optional[str]
+    """The unique ID of the approval response"""
+
+    reason: Optional[str]
+    """Optional reason for the decision."""
+
+
+class McpCall(TypedDict, total=False):
+    id: Required[str]
+    """The unique ID of the tool call."""
+
+    arguments: Required[str]
+    """A JSON string of the arguments passed to the tool."""
+
+    name: Required[str]
+    """The name of the tool that was run."""
+
+    server_label: Required[str]
+    """The label of the MCP server running the tool."""
+
+    type: Required[Literal["mcp_call"]]
+    """The type of the item. Always `mcp_call`."""
+
+    error: Optional[str]
+    """The error from the tool call, if any."""
+
+    output: Optional[str]
+    """The output from the tool call."""

volcenginesdkarkruntime/types/responses/mcp_input_item_param.py

@@ -0,0 +1,80 @@
+
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from typing_extensions import Literal, Optional, Dict, TypeAlias, Union, List
+
+from ..._models import BaseModel
+
+
+__all__ = [
+    "Mcp",
+    "McpAllowedTools",
+    "McpAllowedToolsMcpAllowedToolsFilter",
+    "McpRequireApproval",
+    "McpRequireApprovalMcpToolApprovalFilter",
+    "McpRequireApprovalMcpToolApprovalFilterAlways",
+    "McpRequireApprovalMcpToolApprovalFilterNever",
+]
+
+
+class McpAllowedToolsMcpAllowedToolsFilter(BaseModel):
+    tool_names: Optional[List[str]] = None
+    """List of allowed tool names."""
+
+
+class McpRequireApprovalMcpToolApprovalFilterAlways(BaseModel):
+    tool_names: Optional[List[str]] = None
+    """List of tools that require approval."""
+
+
+class McpRequireApprovalMcpToolApprovalFilterNever(BaseModel):
+    tool_names: Optional[List[str]] = None
+    """List of tools that do not require approval."""
+
+
+class McpRequireApprovalMcpToolApprovalFilter(BaseModel):
+    always: Optional[McpRequireApprovalMcpToolApprovalFilterAlways] = None
+    """A list of tools that always require approval."""
+
+    never: Optional[McpRequireApprovalMcpToolApprovalFilterNever] = None
+    """A list of tools that never require approval."""
+
+
+McpAllowedTools: TypeAlias = Union[List[str], McpAllowedToolsMcpAllowedToolsFilter, None]
+
+McpRequireApproval: TypeAlias = Union[McpRequireApprovalMcpToolApprovalFilter, Literal["always", "never"], None]
+
+
+class Mcp(BaseModel):
+    server_label: str
+    """A label for this MCP server, used to identify it in tool calls."""
+
+    server_url: str
+    """The URL for the MCP server."""
+
+    type: Literal["mcp"]
+    """The type of the MCP tool. Always `mcp`."""
+
+    allowed_tools: Optional[McpAllowedTools] = None
+    """List of allowed tool names or a filter object."""
+
+    headers: Optional[Dict[str, str]] = None
+    """Optional HTTP headers to send to the MCP server.
+
+    Use for authentication or other purposes.
+    """
+
+    require_approval: Optional[McpRequireApproval] = None
+    """Specify which of the MCP server's tools require approval."""
+
+    server_description: Optional[str] = None
+    """Optional description of the MCP server, used to provide more context."""

volcenginesdkarkruntime/types/responses/mcp_tool.py

@@ -0,0 +1,78 @@
+
+# Copyright (c) [2025] [OpenAI]
+# Copyright (c) [2025] [ByteDance Ltd. and/or its affiliates.]
+# SPDX-License-Identifier: Apache-2.0
+#
+# This file has been modified by [ByteDance Ltd. and/or its affiliates.] on 2025.7
+#
+# Original file was released under Apache License Version 2.0, with the full license text
+# available at https://github.com/openai/openai-python/blob/main/LICENSE.
+#
+# This modified file is released under the same license.
+
+from typing_extensions import Literal, TypedDict, Required, Optional, Dict, TypeAlias, Union, List
+
+__all__ = [
+    "Mcp",
+    "McpAllowedTools",
+    "McpAllowedToolsMcpAllowedToolsFilter",
+    "McpRequireApproval",
+    "McpRequireApprovalMcpToolApprovalFilter",
+    "McpRequireApprovalMcpToolApprovalFilterAlways",
+    "McpRequireApprovalMcpToolApprovalFilterNever",
+]
+
+
+class McpAllowedToolsMcpAllowedToolsFilter(TypedDict, total=False):
+    tool_names: List[str]
+    """List of allowed tool names."""
+
+
+class McpRequireApprovalMcpToolApprovalFilterAlways(TypedDict, total=False):
+    tool_names: List[str]
+    """List of tools that require approval."""
+
+
+class McpRequireApprovalMcpToolApprovalFilterNever(TypedDict, total=False):
+    tool_names: List[str]
+    """List of tools that do not require approval."""
+
+
+class McpRequireApprovalMcpToolApprovalFilter(TypedDict, total=False):
+    always: McpRequireApprovalMcpToolApprovalFilterAlways
+    """A list of tools that always require approval."""
+
+    never: McpRequireApprovalMcpToolApprovalFilterNever
+    """A list of tools that never require approval."""
+
+
+McpAllowedTools: TypeAlias = Union[List[str], McpAllowedToolsMcpAllowedToolsFilter]
+
+
+McpRequireApproval: TypeAlias = Union[McpRequireApprovalMcpToolApprovalFilter, Literal["always", "never"]]
+
+
+class Mcp(TypedDict, total=False):
+    server_label: Required[str]
+    """A label for this MCP server, used to identify it in tool calls."""
+
+    server_url: Required[str]
+    """The URL for the MCP server."""
+
+    type: Required[Literal["mcp"]]
+    """The type of the MCP tool. Always `mcp`."""
+
+    allowed_tools: Optional[McpAllowedTools]
+    """List of allowed tool names or a filter object."""
+
+    headers: Optional[Dict[str, str]]
+    """Optional HTTP headers to send to the MCP server.
+
+    Use for authentication or other purposes.
+    """
+
+    require_approval: Optional[McpRequireApproval]
+    """Specify which of the MCP server's tools require approval."""
+
+    server_description: str
+    """Optional description of the MCP server, used to provide more context."""