arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/responses/order.py

@@ -0,0 +1,18 @@
+# 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 Order(str, Enum):
+    """
+    Sort order for list endpoints.
+    """
+
+    asc = "asc"
+    desc = "desc"

arkruntime/types/responses/output_content_item.py

@@ -0,0 +1,23 @@
+# 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 .output_content_item_reasoning_text import OutputContentItemReasoningText
+from .output_content_item_text import OutputContentItemText
+
+OutputContentItem = TypeAliasType(
+    "OutputContentItem",
+    Annotated[
+        Union[OutputContentItemText, OutputContentItemReasoningText],
+        Field(discriminator="type"),
+    ],
+)

arkruntime/types/responses/output_content_item_param.py

@@ -0,0 +1,18 @@
+# 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 .output_content_item_reasoning_text_param import (
+    OutputContentItemReasoningTextParam,
+)
+from .output_content_item_text_param import OutputContentItemTextParam
+
+OutputContentItemParam: TypeAlias = Union[
+    OutputContentItemTextParam, OutputContentItemReasoningTextParam
+]

arkruntime/types/responses/output_content_item_reasoning_text.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 List, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .annotation import Annotation
+
+
+class OutputContentItemReasoningText(BaseModel):
+    type: Literal["reasoning_text"]
+    text: Optional[str] = None
+    annotations: Optional[List[Annotation]] = None

arkruntime/types/responses/output_content_item_reasoning_text_param.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 typing_extensions import Required, TypedDict
+
+from .annotation_param import AnnotationParam
+
+
+class OutputContentItemReasoningTextParam(TypedDict, total=False):
+    type: Required[Literal["reasoning_text"]]
+
+    text: Optional[str]
+
+    annotations: Optional[List[AnnotationParam]]

arkruntime/types/responses/output_content_item_text.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 List, Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .annotation import Annotation
+
+
+class OutputContentItemText(BaseModel):
+    type: Literal["output_text"]
+    text: Optional[str] = None
+    annotations: Optional[List[Annotation]] = None

arkruntime/types/responses/output_content_item_text_param.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 typing_extensions import Required, TypedDict
+
+from .annotation_param import AnnotationParam
+
+
+class OutputContentItemTextParam(TypedDict, total=False):
+    type: Required[Literal["output_text"]]
+
+    text: Optional[str]
+
+    annotations: Optional[List[AnnotationParam]]

arkruntime/types/responses/output_item.py

@@ -0,0 +1,46 @@
+# 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 .item_agent_tool_call import ItemAgentToolCall
+from .item_doubao_app_call import ItemDoubaoAppCall
+from .item_function_image_process import ItemFunctionImageProcess
+from .item_function_knowledge_search import ItemFunctionKnowledgeSearch
+from .item_function_mcp_approval_request import ItemFunctionMcpApprovalRequest
+from .item_function_mcp_call import ItemFunctionMcpCall
+from .item_function_mcp_list_tools import ItemFunctionMcpListTools
+from .item_function_tool_call import ItemFunctionToolCall
+from .item_function_web_search import ItemFunctionWebSearch
+from .item_output_message import ItemOutputMessage
+from .item_reasoning import ItemReasoning
+from .item_transcription import ItemTranscription
+
+OutputItem = TypeAliasType(
+    "OutputItem",
+    Annotated[
+        Union[
+            ItemOutputMessage,
+            ItemFunctionToolCall,
+            ItemReasoning,
+            ItemTranscription,
+            ItemFunctionWebSearch,
+            ItemFunctionImageProcess,
+            ItemFunctionMcpApprovalRequest,
+            ItemFunctionMcpListTools,
+            ItemFunctionMcpCall,
+            ItemFunctionKnowledgeSearch,
+            ItemDoubaoAppCall,
+            ItemAgentToolCall,
+        ],
+        Field(discriminator="type"),
+    ],
+)

arkruntime/types/responses/output_tokens_details.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 OutputTokensDetails(BaseModel):
+    reasoning_tokens: int

arkruntime/types/responses/parsed_response_shim.py

@@ -0,0 +1,106 @@
+# 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
+
+"""Parsed Responses-API sibling models.
+
+Adapted from an upstream SDK ``types/responses/parsed_response.py``
+to the ark-apis-generated type names:
+
+  upstream                     -> ark-apis
+  ResponseOutputText           -> OutputContentItemText
+  ResponseOutputMessage        -> ItemOutputMessage
+  ResponseFunctionToolCall     -> ItemFunctionToolCall
+  Response                     -> Response
+
+The ark-apis Responses API does not expose a refusal content type, so
+``ParsedContent`` is just the parsed-text variant rather than a union.
+"""
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, List, Generic, Optional, TypeVar
+from typing_extensions import TypeAlias
+
+from arkruntime._models import GenericModel
+from .response import Response
+from .item_output_message import ItemOutputMessage
+from .output_content_item_text import OutputContentItemText
+from .item_function_tool_call import ItemFunctionToolCall
+
+__all__ = [
+    "ParsedContent",
+    "ParsedResponse",
+    "ParsedResponseOutputItem",
+    "ParsedResponseOutputMessage",
+    "ParsedResponseOutputText",
+    "ParsedResponseFunctionToolCall",
+]
+
+ContentType = TypeVar("ContentType")
+
+# pyright: reportIncompatibleVariableOverride=false
+
+
+class ParsedResponseOutputText(
+    OutputContentItemText, GenericModel, Generic[ContentType]
+):
+    """``output_text`` content item augmented with a typed ``parsed`` slot
+    populated when the caller provided a ``text_format`` to
+    :func:`arkruntime.common._parsing._responses.parse_response`."""
+
+    parsed: Optional[ContentType] = None
+
+
+# Upstream implementations use a discriminated union here to fold in refusal
+# content. ark-apis doesn't expose refusal in this API, so the union
+# collapses to a single arm.
+ParsedContent: TypeAlias = ParsedResponseOutputText[ContentType]
+
+
+class ParsedResponseOutputMessage(
+    ItemOutputMessage, GenericModel, Generic[ContentType]
+):
+    if TYPE_CHECKING:
+        content: Optional[List[ParsedContent[ContentType]]]  # type: ignore[assignment]
+    else:
+        content: Optional[List[ParsedContent]] = None
+
+
+class ParsedResponseFunctionToolCall(ItemFunctionToolCall):
+    """``function_call`` output augmented with deserialised
+    ``parsed_arguments`` (populated when the matching tool was strict or
+    a :class:`ResponsesPydanticFunctionTool`)."""
+
+    parsed_arguments: object = None
+
+    __api_exclude__ = {"parsed_arguments"}
+
+
+# ark-apis only models message / function_call / reasoning /
+# computer_call / file_search_call / web_search_call output items. The
+# parser passes the latter four through untouched, so the typed
+# Parsed-output union only needs the two augmented variants. Other
+# items remain typed as their original `OutputItem` and arrive on the
+# list as-is.
+ParsedResponseOutputItem: TypeAlias = (
+    "ParsedResponseOutputMessage[ContentType] | ParsedResponseFunctionToolCall | object"
+)
+
+
+class ParsedResponse(Response, GenericModel, Generic[ContentType]):
+    if TYPE_CHECKING:
+        output: List["ParsedResponseOutputItem[ContentType]"]  # type: ignore[assignment]
+    else:
+        output: List[object] = []  # type: ignore[assignment]
+
+    @property
+    def output_parsed(self) -> Optional[ContentType]:
+        for output in self.output:
+            if getattr(output, "type", None) == "message":
+                for content in (getattr(output, "content", None) or []):
+                    if (
+                        getattr(content, "type", None) == "output_text"
+                        and getattr(content, "parsed", None)
+                    ):
+                        return content.parsed
+        return None

arkruntime/types/responses/reasoning.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 .reasoning_effort import ReasoningEffort
+
+
+class Reasoning(BaseModel):
+    effort: Optional[ReasoningEffort] = None

arkruntime/types/responses/reasoning_effort.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 enum import Enum
+
+
+class ReasoningEffort(str, Enum):
+    none = "none"
+    minimal = "minimal"
+    low = "low"
+    medium = "medium"
+    high = "high"
+    xhigh = "xhigh"
+    max = "max"

arkruntime/types/responses/reasoning_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 .reasoning_effort import ReasoningEffort
+
+
+class ReasoningParam(TypedDict, total=False):
+    effort: Optional[ReasoningEffort]

arkruntime/types/responses/reasoning_summary_part.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, Optional
+
+from arkruntime._models import BaseModel
+
+
+class ReasoningSummaryPart(BaseModel):
+    type: Literal["summary_text"]
+    text: Optional[str] = None

arkruntime/types/responses/reasoning_summary_part_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, Optional
+
+from typing_extensions import Required, TypedDict
+
+
+class ReasoningSummaryPartParam(TypedDict, total=False):
+    type: Required[Literal["summary_text"]]
+
+    text: Optional[str]

arkruntime/types/responses/response.py

@@ -0,0 +1,58 @@
+# 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 .context_management_response import ContextManagementResponse
+from .incomplete_details import IncompleteDetails
+from .output_item import OutputItem
+from .reasoning import Reasoning
+from .response_caching import ResponseCaching
+from .response_error import ResponseError
+from .response_status import ResponseStatus
+from .response_text_config import ResponseTextConfig
+from .response_usage import ResponseUsage
+from .service_tier import ServiceTier
+from .session import Session
+from .thinking import Thinking
+from .tool import Tool
+from .tool_choice import ToolChoice
+
+
+class Response(BaseModel):
+    created_at: int
+    error: Optional[ResponseError] = None
+    id: str
+    incomplete_details: Optional[IncompleteDetails] = None
+    max_output_tokens: Optional[int] = None
+    model: str
+    object: Literal["response"]
+    output: Optional[List[OutputItem]] = None
+    previous_response_id: Optional[str] = None
+    thinking: Optional[Thinking] = None
+    service_tier: Optional[ServiceTier] = None
+    status: Optional[ResponseStatus] = None
+    temperature: Optional[float] = None
+    tools: Optional[List[Tool]] = None
+    top_p: Optional[float] = None
+    usage: Optional[ResponseUsage] = None
+    caching: Optional[ResponseCaching] = None
+    text: Optional[ResponseTextConfig] = None
+    instructions: Optional[str] = None
+    store: Optional[bool] = 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[ContextManagementResponse] = None
+    session: Optional[Session] = None
+    safety_identifier: Optional[str] = None
+    prompt_cache_key: Optional[str] = None

arkruntime/types/responses/response_agent_tool_call_completed_event.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 arkruntime._models import BaseModel
+
+
+class ResponseAgentToolCallCompletedEvent(BaseModel):
+    type: Literal["response.agent_tool_call.completed"]
+    item_id: str
+    output_index: int
+    name: str
+    sequence_number: int

arkruntime/types/responses/response_agent_tool_call_in_progress_event.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 arkruntime._models import BaseModel
+
+
+class ResponseAgentToolCallInProgressEvent(BaseModel):
+    type: Literal["response.agent_tool_call.in_progress"]
+    item_id: str
+    output_index: int
+    name: str
+    sequence_number: int

arkruntime/types/responses/response_caching.py

@@ -0,0 +1,18 @@
+# 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 .cache_mode import CacheMode
+
+
+class ResponseCaching(BaseModel):
+    type: Optional[CacheMode] = None
+    prefix: Optional[bool] = None

arkruntime/types/responses/response_caching_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 Optional
+
+from typing_extensions import TypedDict
+
+from .cache_mode import CacheMode
+
+
+class ResponseCachingParam(TypedDict, total=False):
+    type: Optional[CacheMode]
+
+    prefix: Optional[bool]

arkruntime/types/responses/response_completed_event.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
+
+from arkruntime._models import BaseModel
+
+from .response import Response
+
+
+class ResponseCompletedEvent(BaseModel):
+    type: Literal["response.completed"]
+    """
+    The type of the event. Always `response.completed`.
+    """
+    response: Response
+    """
+    Properties of the completed response.
+    """
+    sequence_number: int
+    """
+    The sequence number of this event.
+    """

arkruntime/types/responses/response_content_part_added_event.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
+
+from .output_content_item import OutputContentItem
+
+
+class ResponseContentPartAddedEvent(BaseModel):
+    type: Literal["response.content_part.added"]
+    content_index: int
+    item_id: str
+    output_index: int
+    part: OutputContentItem
+    sequence_number: int

arkruntime/types/responses/response_content_part_done_event.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
+
+from .output_content_item import OutputContentItem
+
+
+class ResponseContentPartDoneEvent(BaseModel):
+    type: Literal["response.content_part.done"]
+    content_index: int
+    item_id: str
+    output_index: int
+    part: OutputContentItem
+    sequence_number: int

arkruntime/types/responses/response_created_event.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
+
+from arkruntime._models import BaseModel
+
+from .response import Response
+
+
+class ResponseCreatedEvent(BaseModel):
+    type: Literal["response.created"]
+    """
+    The type of the event. Always `response.created`.
+    """
+    response: Response
+    """
+    The response that was created.
+    """
+    sequence_number: int
+    """
+    The sequence number of this event.
+    """

arkruntime/types/responses/response_doubao_app_call_block_added_event.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
+
+from arkruntime._models import BaseModel
+
+from .doubao_app_call_block import DoubaoAppCallBlock
+
+
+class ResponseDoubaoAppCallBlockAddedEvent(BaseModel):
+    type: Literal["response.doubao_app_call_block.added"]
+    item_id: str
+    output_index: int
+    sequence_number: int
+    block: DoubaoAppCallBlock