arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/responses/responses_input_param.py

@@ -0,0 +1,13 @@
+# 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, TypeAlias, Union
+
+from .input_item_param import InputItemParam
+
+ResponsesInputParam: TypeAlias = Union[str, List[InputItemParam]]

arkruntime/types/responses/responses_request.py

@@ -0,0 +1,50 @@
+# 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, Optional
+
+from arkruntime._models import BaseModel
+
+from .context_management import ContextManagement
+from .reasoning import Reasoning
+from .response_caching import ResponseCaching
+from .response_includable import ResponseIncludable
+from .response_text_config import ResponseTextConfig
+from .responses_input import ResponsesInput
+from .service_tier import ServiceTier
+from .session import Session
+from .thinking import Thinking
+from .tool import Tool
+from .tool_choice import ToolChoice
+
+
+class ResponsesRequest(BaseModel):
+    input: ResponsesInput
+    model: str
+    max_output_tokens: Optional[int] = None
+    previous_response_id: Optional[str] = None
+    thinking: Optional[Thinking] = None
+    service_tier: Optional[ServiceTier] = None
+    store: Optional[bool] = None
+    stream: Optional[bool] = None
+    temperature: Optional[float] = None
+    tools: Optional[List[Tool]] = None
+    top_p: Optional[float] = None
+    instructions: Optional[str] = None
+    include: Optional[List[ResponseIncludable]] = None
+    caching: Optional[ResponseCaching] = None
+    text: Optional[ResponseTextConfig] = None
+    expire_at: Optional[int] = None
+    tool_choice: Optional[ToolChoice] = None
+    parallel_tool_calls: Optional[bool] = None
+    max_tool_calls: Optional[int] = None
+    reasoning: Optional[Reasoning] = None
+    context_management: Optional[ContextManagement] = None
+    session: Optional[Session] = None
+    prompt_cache_key: Optional[str] = None
+    safety_identifier: Optional[str] = None

arkruntime/types/responses/responses_request_param.py

@@ -0,0 +1,73 @@
+# 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, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .context_management_param import ContextManagementParam
+from .reasoning_param import ReasoningParam
+from .response_caching_param import ResponseCachingParam
+from .response_includable import ResponseIncludable
+from .response_text_config_param import ResponseTextConfigParam
+from .responses_input_param import ResponsesInputParam
+from .service_tier import ServiceTier
+from .session_param import SessionParam
+from .thinking_param import ThinkingParam
+from .tool_choice_param import ToolChoiceParam
+from .tool_param import ToolParam
+
+
+class ResponsesRequestParam(TypedDict, total=False):
+    input: Required[ResponsesInputParam]
+
+    model: Required[str]
+
+    max_output_tokens: Optional[int]
+
+    previous_response_id: Optional[str]
+
+    thinking: Optional[ThinkingParam]
+
+    service_tier: Optional[ServiceTier]
+
+    store: Optional[bool]
+
+    stream: Optional[bool]
+
+    temperature: Optional[float]
+
+    tools: Optional[List[ToolParam]]
+
+    top_p: Optional[float]
+
+    instructions: Optional[str]
+
+    include: Optional[List[ResponseIncludable]]
+
+    caching: Optional[ResponseCachingParam]
+
+    text: Optional[ResponseTextConfigParam]
+
+    expire_at: Optional[int]
+
+    tool_choice: Optional[ToolChoiceParam]
+
+    parallel_tool_calls: Optional[bool]
+
+    max_tool_calls: Optional[int]
+
+    reasoning: Optional[ReasoningParam]
+
+    context_management: Optional[ContextManagementParam]
+
+    session: Optional[SessionParam]
+
+    prompt_cache_key: Optional[str]
+
+    safety_identifier: Optional[str]

arkruntime/types/responses/service_tier.py

@@ -0,0 +1,14 @@
+# 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 enum import Enum
+
+
+class ServiceTier(str, Enum):
+    auto = "auto"
+    default = "default"

arkruntime/types/responses/session.py

@@ -0,0 +1,13 @@
+# 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 arkruntime._models import BaseModel
+
+
+class Session(BaseModel):
+    id: str

arkruntime/types/responses/session_param.py

@@ -0,0 +1,13 @@
+# 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_extensions import Required, TypedDict
+
+
+class SessionParam(TypedDict, total=False):
+    id: Required[str]

arkruntime/types/responses/text_format.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 Annotated, Dict, Optional
+
+from arkruntime._models import BaseModel
+from pydantic import Field
+
+from .text_format_type import TextFormatType
+
+
+class TextFormat(BaseModel):
+    type: TextFormatType
+    schema_: Annotated[Optional[Dict[str, object]], Field(alias="schema")] = None
+    name: Optional[str] = None
+    description: Optional[str] = None
+    strict: Optional[bool] = None

arkruntime/types/responses/text_format_param.py

@@ -0,0 +1,25 @@
+# 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, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .text_format_type import TextFormatType
+
+
+class TextFormatParam(TypedDict, total=False):
+    type: Required[TextFormatType]
+
+    schema: Optional[Dict[str, object]]
+
+    name: Optional[str]
+
+    description: Optional[str]
+
+    strict: Optional[bool]

arkruntime/types/responses/text_format_type.py

@@ -0,0 +1,15 @@
+# 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 enum import Enum
+
+
+class TextFormatType(str, Enum):
+    text = "text"
+    json_object = "json_object"
+    json_schema = "json_schema"

arkruntime/types/responses/text_translation_options.py

@@ -0,0 +1,14 @@
+# 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 arkruntime._models import BaseModel
+
+
+class TextTranslationOptions(BaseModel):
+    source_language: str
+    target_language: str

arkruntime/types/responses/thinking.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
+
+from .thinking_mode import ThinkingMode
+
+
+class Thinking(BaseModel):
+    type: Optional[ThinkingMode] = None

arkruntime/types/responses/thinking_mode.py

@@ -0,0 +1,15 @@
+# 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 enum import Enum
+
+
+class ThinkingMode(str, Enum):
+    enabled = "enabled"
+    disabled = "disabled"
+    auto = "auto"

arkruntime/types/responses/thinking_param.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 typing_extensions import TypedDict
+
+from .thinking_mode import ThinkingMode
+
+
+class ThinkingParam(TypedDict, total=False):
+    type: Optional[ThinkingMode]

arkruntime/types/responses/thinking_turns_param.py

@@ -0,0 +1,16 @@
+# 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
+
+from arkruntime._models import BaseModel
+
+
+class ThinkingTurnsParam(BaseModel):
+    type: Literal["thinking_turns"]
+    value: int

arkruntime/types/responses/thinking_turns_param_param.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 Literal
+
+from typing_extensions import Required, TypedDict
+
+
+class ThinkingTurnsParamParam(TypedDict, total=False):
+    type: Required[Literal["thinking_turns"]]
+
+    value: Required[int]

arkruntime/types/responses/tool.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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .doubao_app_tool import DoubaoAppTool
+from .function_tool import FunctionTool
+from .image_process_tool import ImageProcessTool
+from .knowledge_search_tool import KnowledgeSearchTool
+from .mcp_tool import McpTool
+from .web_search_tool import WebSearchTool
+
+Tool = TypeAliasType(
+    "Tool",
+    Annotated[
+        Union[
+            FunctionTool,
+            WebSearchTool,
+            ImageProcessTool,
+            McpTool,
+            KnowledgeSearchTool,
+            DoubaoAppTool,
+        ],
+        Field(discriminator="type"),
+    ],
+)

arkruntime/types/responses/tool_choice.py

@@ -0,0 +1,16 @@
+# 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 Union
+
+from typing_extensions import TypeAliasType
+
+from .tool_choice_options import ToolChoiceOptions
+from .typed_tool_choice import TypedToolChoice
+
+ToolChoice = TypeAliasType("ToolChoice", Union[ToolChoiceOptions, TypedToolChoice])

arkruntime/types/responses/tool_choice_function.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
+
+from arkruntime._models import BaseModel
+
+
+class ToolChoiceFunction(BaseModel):
+    name: str
+    """
+    The name of the function to call.
+    """
+    type: Literal["function"]
+    """
+    For function calling, the type is always `function`.
+    """

arkruntime/types/responses/tool_choice_function_param.py

@@ -0,0 +1,19 @@
+# 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
+
+from typing_extensions import Required, TypedDict
+
+
+class ToolChoiceFunctionParam(TypedDict, total=False):
+    name: Required[str]
+    """The name of the function to call."""
+
+    type: Required[Literal["function"]]
+    """For function calling, the type is always `function`."""

arkruntime/types/responses/tool_choice_knowledge_search.py

@@ -0,0 +1,15 @@
+# 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
+
+from arkruntime._models import BaseModel
+
+
+class ToolChoiceKnowledgeSearch(BaseModel):
+    type: Literal["knowledge_search"]

arkruntime/types/responses/tool_choice_knowledge_search_param.py

@@ -0,0 +1,15 @@
+# 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
+
+from typing_extensions import Required, TypedDict
+
+
+class ToolChoiceKnowledgeSearchParam(TypedDict, total=False):
+    type: Required[Literal["knowledge_search"]]

arkruntime/types/responses/tool_choice_mcp.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 arkruntime._models import BaseModel
+
+
+class ToolChoiceMcp(BaseModel):
+    type: Literal["mcp"]
+    """
+    For MCP tools, the type is always `mcp`.
+    """
+    server_label: str
+    """
+    The label of the MCP server to use.
+    """
+    name: Optional[str] = None
+    """
+    The name of the tool to call on the server.
+    """

arkruntime/types/responses/tool_choice_mcp_param.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 typing_extensions import Required, TypedDict
+
+
+class ToolChoiceMcpParam(TypedDict, total=False):
+    type: Required[Literal["mcp"]]
+    """For MCP tools, the type is always `mcp`."""
+
+    server_label: Required[str]
+    """The label of the MCP server to use."""
+
+    name: Optional[str]
+    """The name of the tool to call on the server."""

arkruntime/types/responses/tool_choice_options.py

@@ -0,0 +1,15 @@
+# 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 enum import Enum
+
+
+class ToolChoiceOptions(str, Enum):
+    auto = "auto"
+    none = "none"
+    required = "required"

arkruntime/types/responses/tool_choice_param.py

@@ -0,0 +1,14 @@
+# 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 .tool_choice_options import ToolChoiceOptions
+from .typed_tool_choice_param import TypedToolChoiceParam
+
+ToolChoiceParam: TypeAlias = Union[ToolChoiceOptions, TypedToolChoiceParam]

arkruntime/types/responses/tool_choice_web_search.py

@@ -0,0 +1,15 @@
+# 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
+
+from arkruntime._models import BaseModel
+
+
+class ToolChoiceWebSearch(BaseModel):
+    type: Literal["web_search"]

arkruntime/types/responses/tool_choice_web_search_param.py

@@ -0,0 +1,15 @@
+# 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
+
+from typing_extensions import Required, TypedDict
+
+
+class ToolChoiceWebSearchParam(TypedDict, total=False):
+    type: Required[Literal["web_search"]]

arkruntime/types/responses/tool_name_list.py

@@ -0,0 +1,15 @@
+# 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
+
+from arkruntime._models import BaseModel
+
+
+class ToolNameList(BaseModel):
+    clear_tool_names: List[str]

arkruntime/types/responses/tool_name_list_param.py

@@ -0,0 +1,15 @@
+# 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
+
+from typing_extensions import Required, TypedDict
+
+
+class ToolNameListParam(TypedDict, total=False):
+    clear_tool_names: Required[List[str]]

arkruntime/types/responses/tool_param.py

@@ -0,0 +1,25 @@
+# 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 .doubao_app_tool_param import DoubaoAppToolParam
+from .function_tool_param import FunctionToolParam
+from .image_process_tool_param import ImageProcessToolParam
+from .knowledge_search_tool_param import KnowledgeSearchToolParam
+from .mcp_tool_param import McpToolParam
+from .web_search_tool_param import WebSearchToolParam
+
+ToolParam: TypeAlias = Union[
+    FunctionToolParam,
+    WebSearchToolParam,
+    ImageProcessToolParam,
+    McpToolParam,
+    KnowledgeSearchToolParam,
+    DoubaoAppToolParam,
+]