arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/responses/input_item_list_params_shim.py

@@ -0,0 +1,39 @@
+# Copyright (c) 2025 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+# License text: https://github.com/volcengine/ark-runtime-python/blob/main/LICENSE
+
+from __future__ import annotations
+
+from typing import List
+from typing_extensions import Literal, TypedDict
+
+from arkruntime.types.responses.response_includable import ResponseIncludable as IncludeOption
+
+__all__ = ["InputItemListParams"]
+
+
+class InputItemListParams(TypedDict, total=False):
+    after: str
+    """An item ID to list items after, used in pagination."""
+
+    before: str
+    """An item ID to list items before, used in pagination."""
+
+    include: List[IncludeOption]
+    """Additional fields to include in the response.
+
+    See the `include` parameter for Response creation above for more information.
+    """
+
+    limit: int
+    """A limit on the number of objects to be returned.
+
+    Limit can range between 1 and 100, and the default is 20.
+    """
+
+    order: Literal["asc", "desc"]
+    """The order to return the input items in. Default is `desc`.
+
+    - `asc`: Return the input items in ascending order.
+    - `desc`: Return the input items in descending order.
+    """

arkruntime/types/responses/input_item_param.py

@@ -0,0 +1,33 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import TypeAlias, Union
+
+from .item_easy_message_param import ItemEasyMessageParam
+from .item_function_mcp_approval_request_param import (
+    ItemFunctionMcpApprovalRequestParam,
+)
+from .item_function_mcp_approval_response_param import (
+    ItemFunctionMcpApprovalResponseParam,
+)
+from .item_function_mcp_call_param import ItemFunctionMcpCallParam
+from .item_function_mcp_list_tools_param import ItemFunctionMcpListToolsParam
+from .item_function_tool_call_output_param import ItemFunctionToolCallOutputParam
+from .item_function_tool_call_param import ItemFunctionToolCallParam
+from .item_reasoning_param import ItemReasoningParam
+
+InputItemParam: TypeAlias = Union[
+    ItemEasyMessageParam,
+    ItemFunctionToolCallParam,
+    ItemFunctionToolCallOutputParam,
+    ItemReasoningParam,
+    ItemFunctionMcpApprovalRequestParam,
+    ItemFunctionMcpApprovalResponseParam,
+    ItemFunctionMcpListToolsParam,
+    ItemFunctionMcpCallParam,
+]

arkruntime/types/responses/input_tokens_details.py

@@ -0,0 +1,17 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Optional
+
+from arkruntime._models import BaseModel
+
+
+class InputTokensDetails(BaseModel):
+    cached_tokens: int
+    audio_tokens: Optional[int] = None
+    audio_cached_tokens: Optional[int] = None

arkruntime/types/responses/item_agent_tool_call.py

@@ -0,0 +1,20 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .item_status import ItemStatus
+
+
+class ItemAgentToolCall(BaseModel):
+    type: Literal["agent_tool_call"]
+    id: Optional[str] = None
+    name: str
+    status: ItemStatus

arkruntime/types/responses/item_doubao_app_call.py

@@ -0,0 +1,22 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .doubao_app_call_block import DoubaoAppCallBlock
+from .item_status import ItemStatus
+
+
+class ItemDoubaoAppCall(BaseModel):
+    type: Literal["doubao_app_call"]
+    id: Optional[str] = None
+    feature: Optional[str] = None
+    blocks: Optional[List[DoubaoAppCallBlock]] = None
+    status: Optional[ItemStatus] = None

arkruntime/types/responses/item_easy_message.py

@@ -0,0 +1,22 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .message_content import MessageContent
+from .message_role import MessageRole
+
+
+class ItemEasyMessage(BaseModel):
+    type: Optional[Literal["message"]] = "message"
+    role: Optional[MessageRole] = None
+    content: MessageContent
+    id: Optional[str] = None
+    partial: Optional[bool] = None

arkruntime/types/responses/item_easy_message_param.py

@@ -0,0 +1,26 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .message_content_param import MessageContentParam
+from .message_role import MessageRole
+
+
+class ItemEasyMessageParam(TypedDict, total=False):
+    type: Optional[Literal["message"]]
+
+    role: Optional[MessageRole]
+
+    content: Required[MessageContentParam]
+
+    id: Optional[str]
+
+    partial: Optional[bool]

arkruntime/types/responses/item_function_image_process.py

@@ -0,0 +1,24 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Dict, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .item_status import ItemStatus
+from .response_image_process_action import ResponseImageProcessAction
+from .response_image_process_error import ResponseImageProcessError
+
+
+class ItemFunctionImageProcess(BaseModel):
+    type: Literal["image_process"]
+    action: Optional[ResponseImageProcessAction] = None
+    arguments: Optional[Dict[str, object]] = None
+    status: ItemStatus
+    id: str
+    error: Optional[ResponseImageProcessError] = None

arkruntime/types/responses/item_function_knowledge_search.py

@@ -0,0 +1,21 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .item_status import ItemStatus
+
+
+class ItemFunctionKnowledgeSearch(BaseModel):
+    type: Literal["knowledge_search_call"]
+    queries: List[str]
+    knowledge_resource_id: str
+    status: ItemStatus
+    id: Optional[str] = None

arkruntime/types/responses/item_function_mcp_approval_request.py

@@ -0,0 +1,34 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+
+class ItemFunctionMcpApprovalRequest(BaseModel):
+    type: Literal["mcp_approval_request"]
+    """
+    The type of the item. Always `mcp_approval_request`.
+    """
+    server_label: str
+    """
+    The label of the MCP server making the request.
+    """
+    arguments: str
+    """
+    A JSON string of arguments for the tool.
+    """
+    name: str
+    """
+    The name of the tool to run.
+    """
+    id: Optional[str] = None
+    """
+    The unique ID of the approval request.
+    """

arkruntime/types/responses/item_function_mcp_approval_request_param.py

@@ -0,0 +1,28 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+
+class ItemFunctionMcpApprovalRequestParam(TypedDict, total=False):
+    type: Required[Literal["mcp_approval_request"]]
+    """The type of the item. Always `mcp_approval_request`."""
+
+    server_label: Required[str]
+    """The label of the MCP server making the request."""
+
+    arguments: Required[str]
+    """A JSON string of arguments for the tool."""
+
+    name: Required[str]
+    """The name of the tool to run."""
+
+    id: Optional[str]
+    """The unique ID of the approval request."""

arkruntime/types/responses/item_function_mcp_approval_response.py

@@ -0,0 +1,34 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+
+class ItemFunctionMcpApprovalResponse(BaseModel):
+    id: Optional[str] = None
+    """
+    The unique ID of the approval response
+    """
+    approval_request_id: str
+    """
+    The ID of the approval request being answered.
+    """
+    approve: bool
+    """
+    Whether the request was approved.
+    """
+    type: Literal["mcp_approval_response"]
+    """
+    The type of the item. Always `mcp_approval_response`.
+    """
+    reason: Optional[str] = None
+    """
+    Optional reason for the decision.
+    """

arkruntime/types/responses/item_function_mcp_approval_response_param.py

@@ -0,0 +1,28 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+
+class ItemFunctionMcpApprovalResponseParam(TypedDict, total=False):
+    id: Optional[str]
+    """The unique ID of the approval response"""
+
+    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`."""
+
+    reason: Optional[str]
+    """Optional reason for the decision."""

arkruntime/types/responses/item_function_mcp_call.py

@@ -0,0 +1,44 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+
+class ItemFunctionMcpCall(BaseModel):
+    type: Literal["mcp_call"]
+    """
+    The type of the item. Always `mcp_call`.
+    """
+    server_label: str
+    """
+    The label of the MCP server running the tool.
+    """
+    arguments: Optional[str] = None
+    """
+    A JSON string of the arguments passed to the tool. Streamed in via
+    `response.mcp_call_arguments.delta` so it may be absent on the initial
+    `output_item.added` event.
+    """
+    name: str
+    """
+    The name of the tool that was run.
+    """
+    id: Optional[str] = None
+    """
+    The unique ID of the tool call.
+    """
+    error: Optional[str] = None
+    """
+    The error from the tool call, if any.
+    """
+    output: Optional[str] = None
+    """
+    The output from the tool call.
+    """

arkruntime/types/responses/item_function_mcp_call_param.py

@@ -0,0 +1,38 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+
+class ItemFunctionMcpCallParam(TypedDict, total=False):
+    type: Required[Literal["mcp_call"]]
+    """The type of the item. Always `mcp_call`."""
+
+    server_label: Required[str]
+    """The label of the MCP server running the tool."""
+
+    arguments: Optional[str]
+    """
+    A JSON string of the arguments passed to the tool. Streamed in via
+    `response.mcp_call_arguments.delta` so it may be absent on the initial
+    `output_item.added` event.
+    """
+
+    name: Required[str]
+    """The name of the tool that was run."""
+
+    id: Optional[str]
+    """The unique ID of the tool call."""
+
+    error: Optional[str]
+    """The error from the tool call, if any."""
+
+    output: Optional[str]
+    """The output from the tool call."""

arkruntime/types/responses/item_function_mcp_list_tools.py

@@ -0,0 +1,36 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .mcp_list_tools_tool import McpListToolsTool
+
+
+class ItemFunctionMcpListTools(BaseModel):
+    type: Literal["mcp_list_tools"]
+    """
+    The type of the item. Always `mcp_list_tools`.
+    """
+    server_label: str
+    """
+    The label of the MCP server.
+    """
+    tools: Optional[List[McpListToolsTool]] = None
+    """
+    The tools available on the server.
+    """
+    id: Optional[str] = None
+    """
+    The unique ID of the list.
+    """
+    error: Optional[str] = None
+    """
+    Error message if the server could not list tools.
+    """

arkruntime/types/responses/item_function_mcp_list_tools_param.py

@@ -0,0 +1,30 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import List, Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .mcp_list_tools_tool_param import McpListToolsToolParam
+
+
+class ItemFunctionMcpListToolsParam(TypedDict, total=False):
+    type: Required[Literal["mcp_list_tools"]]
+    """The type of the item. Always `mcp_list_tools`."""
+
+    server_label: Required[str]
+    """The label of the MCP server."""
+
+    tools: Optional[List[McpListToolsToolParam]]
+    """The tools available on the server."""
+
+    id: Optional[str]
+    """The unique ID of the list."""
+
+    error: Optional[str]
+    """Error message if the server could not list tools."""

arkruntime/types/responses/item_function_tool_call.py

@@ -0,0 +1,37 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .item_status import ItemStatus
+
+
+class ItemFunctionToolCall(BaseModel):
+    id: Optional[str] = None
+    """
+    The unique ID of the function tool call.
+    """
+    type: Literal["function_call"]
+    arguments: Optional[str] = None
+    """
+    A JSON string of the arguments passed to the function.
+    """
+    call_id: Optional[str] = None
+    """
+    The ID of the call that produced this tool call.
+    """
+    name: Optional[str] = None
+    """
+    The name of the function to call.
+    """
+    status: Optional[ItemStatus] = None
+    """
+    The status of the item.
+    """

arkruntime/types/responses/item_function_tool_call_output.py

@@ -0,0 +1,22 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .item_status import ItemStatus
+from .message_content import MessageContent
+
+
+class ItemFunctionToolCallOutput(BaseModel):
+    type: Literal["function_call_output"]
+    call_id: Optional[str] = None
+    output: Optional[MessageContent] = None
+    id: Optional[str] = None
+    status: Optional[ItemStatus] = None

arkruntime/types/responses/item_function_tool_call_output_param.py

@@ -0,0 +1,26 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .item_status import ItemStatus
+from .message_content_param import MessageContentParam
+
+
+class ItemFunctionToolCallOutputParam(TypedDict, total=False):
+    type: Required[Literal["function_call_output"]]
+
+    call_id: Optional[str]
+
+    output: Optional[MessageContentParam]
+
+    id: Optional[str]
+
+    status: Optional[ItemStatus]

arkruntime/types/responses/item_function_tool_call_param.py

@@ -0,0 +1,32 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .item_status import ItemStatus
+
+
+class ItemFunctionToolCallParam(TypedDict, total=False):
+    id: Optional[str]
+    """The unique ID of the function tool call."""
+
+    type: Required[Literal["function_call"]]
+
+    arguments: Optional[str]
+    """A JSON string of the arguments passed to the function."""
+
+    call_id: Optional[str]
+    """The ID of the call that produced this tool call."""
+
+    name: Optional[str]
+    """The name of the function to call."""
+
+    status: Optional[ItemStatus]
+    """The status of the item."""

arkruntime/types/responses/item_function_web_search.py

@@ -0,0 +1,21 @@
+# Generated by datamodel-code-generator from ark-apis typespec/openapi.
+# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
+#
+# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+
+from __future__ import annotations
+
+from typing import Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .item_status import ItemStatus
+from .web_search_action import WebSearchAction
+
+
+class ItemFunctionWebSearch(BaseModel):
+    type: Literal["web_search_call"]
+    action: Optional[WebSearchAction] = None
+    status: ItemStatus
+    id: str