arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/chat/chat_completion_content_part_param.py

@@ -0,0 +1,29 @@
+# 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 .chat_completion_content_part_audio_param import (
+    ChatCompletionContentPartAudioParam,
+)
+from .chat_completion_content_part_file_param import ChatCompletionContentPartFileParam
+from .chat_completion_content_part_image_param import (
+    ChatCompletionContentPartImageParam,
+)
+from .chat_completion_content_part_text_param import ChatCompletionContentPartTextParam
+from .chat_completion_content_part_video_param import (
+    ChatCompletionContentPartVideoParam,
+)
+
+ChatCompletionContentPartParam: TypeAlias = Union[
+    ChatCompletionContentPartTextParam,
+    ChatCompletionContentPartImageParam,
+    ChatCompletionContentPartVideoParam,
+    ChatCompletionContentPartAudioParam,
+    ChatCompletionContentPartFileParam,
+]

arkruntime/types/chat/chat_completion_content_part_text.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 ChatCompletionContentPartText(BaseModel):
+    type: Literal["text"]
+    """
+    The type of the content part. Always `text`.
+    """
+    text: str
+    """
+    The text content.
+    """

arkruntime/types/chat/chat_completion_content_part_text_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 ChatCompletionContentPartTextParam(TypedDict, total=False):
+    type: Required[Literal["text"]]
+    """The type of the content part. Always `text`."""
+
+    text: Required[str]
+    """The text content."""

arkruntime/types/chat/chat_completion_content_part_video.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 Literal
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_content_part_video_video_url import (
+    ChatCompletionContentPartVideoVideoUrl,
+)
+
+
+class ChatCompletionContentPartVideo(BaseModel):
+    type: Literal["video_url"]
+    """
+    The type of the content part. Always `video_url`.
+    """
+    video_url: ChatCompletionContentPartVideoVideoUrl

arkruntime/types/chat/chat_completion_content_part_video_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
+
+from typing_extensions import Required, TypedDict
+
+from .chat_completion_content_part_video_video_url_param import (
+    ChatCompletionContentPartVideoVideoUrlParam,
+)
+
+
+class ChatCompletionContentPartVideoParam(TypedDict, total=False):
+    type: Required[Literal["video_url"]]
+    """The type of the content part. Always `video_url`."""
+
+    video_url: Required[ChatCompletionContentPartVideoVideoUrlParam]

arkruntime/types/chat/chat_completion_content_part_video_video_url.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 Optional
+
+from arkruntime._models import BaseModel
+
+from .video_image_pixel_limit import VideoImagePixelLimit
+
+
+class ChatCompletionContentPartVideoVideoUrl(BaseModel):
+    url: Optional[str] = None
+    """
+    Either a URL of the video or the base64 encoded video data.
+    """
+    fps: Optional[float] = None
+    """
+    Frames-per-second sampling rate for the video.
+    """
+    detail: Optional[str] = None
+    """
+    Specifies the detail level of frames extracted from the video.
+    """
+    image_pixel_limit: Optional[VideoImagePixelLimit] = None
+    """
+    Optional pixel-size limits applied to extracted frames.
+    """
+    file_id: Optional[str] = None
+    """
+    The blob id of the video, when uploaded out-of-band.
+    """

arkruntime/types/chat/chat_completion_content_part_video_video_url_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 Optional
+
+from typing_extensions import TypedDict
+
+from .video_image_pixel_limit_param import VideoImagePixelLimitParam
+
+
+class ChatCompletionContentPartVideoVideoUrlParam(TypedDict, total=False):
+    url: Optional[str]
+    """Either a URL of the video or the base64 encoded video data."""
+
+    fps: Optional[float]
+    """Frames-per-second sampling rate for the video."""
+
+    detail: Optional[str]
+    """Specifies the detail level of frames extracted from the video."""
+
+    image_pixel_limit: Optional[VideoImagePixelLimitParam]
+    """Optional pixel-size limits applied to extracted frames."""
+
+    file_id: Optional[str]
+    """The blob id of the video, when uploaded out-of-band."""

arkruntime/types/chat/chat_completion_message_content.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 List, Union
+
+from typing_extensions import TypeAliasType
+
+from .chat_completion_content_part import ChatCompletionContentPart
+
+ChatCompletionMessageContent = TypeAliasType(
+    "ChatCompletionMessageContent", Union[str, List[ChatCompletionContentPart]]
+)

arkruntime/types/chat/chat_completion_message_content_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, TypeAlias, Union
+
+from .chat_completion_content_part_param import ChatCompletionContentPartParam
+
+ChatCompletionMessageContentParam: TypeAlias = Union[
+    str, List[ChatCompletionContentPartParam]
+]

arkruntime/types/chat/chat_completion_message_tool_call.py

@@ -0,0 +1,29 @@
+# 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
+
+from .chat_completion_message_tool_call_function import (
+    ChatCompletionMessageToolCallFunction,
+)
+from .tool_type import ToolType
+
+
+class ChatCompletionMessageToolCall(BaseModel):
+    id: str
+    """
+    The ID of the tool call.
+    """
+    type: ToolType
+    """
+    The type of the tool. Currently, only `function` is supported.
+    """
+    function: ChatCompletionMessageToolCallFunction
+    """
+    The function that the model called.
+    """

arkruntime/types/chat/chat_completion_message_tool_call_chunk.py

@@ -0,0 +1,31 @@
+# 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 .chat_completion_message_tool_call_chunk_function import (
+    ChatCompletionMessageToolCallChunkFunction,
+)
+
+
+class ChatCompletionMessageToolCallChunk(BaseModel):
+    index: int
+    """
+    Index of the tool call in the array of tool calls.
+    """
+    id: Optional[str] = None
+    """
+    The ID of the tool call.
+    """
+    type: Optional[str] = None
+    """
+    The type of the tool.
+    """
+    function: Optional[ChatCompletionMessageToolCallChunkFunction] = None

arkruntime/types/chat/chat_completion_message_tool_call_chunk_function.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 Optional
+
+from arkruntime._models import BaseModel
+
+
+class ChatCompletionMessageToolCallChunkFunction(BaseModel):
+    name: Optional[str] = None
+    arguments: Optional[str] = None

arkruntime/types/chat/chat_completion_message_tool_call_function.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 arkruntime._models import BaseModel
+
+
+class ChatCompletionMessageToolCallFunction(BaseModel):
+    name: str
+    """
+    The name of the function to call.
+    """
+    arguments: str
+    """
+    The arguments to call the function with, as generated by the model in
+    JSON format. Note that the model does not always generate valid JSON,
+    and may hallucinate parameters not defined by your function schema.
+    Validate the arguments in your code before calling your function.
+    """

arkruntime/types/chat/chat_completion_message_tool_call_function_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_extensions import Required, TypedDict
+
+
+class ChatCompletionMessageToolCallFunctionParam(TypedDict, total=False):
+    name: Required[str]
+    """The name of the function to call."""
+
+    arguments: Required[str]
+    """
+    The arguments to call the function with, as generated by the model in
+    JSON format. Note that the model does not always generate valid JSON,
+    and may hallucinate parameters not defined by your function schema.
+    Validate the arguments in your code before calling your function.
+    """

arkruntime/types/chat/chat_completion_message_tool_call_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_extensions import Required, TypedDict
+
+
+from .chat_completion_message_tool_call_function_param import (
+    ChatCompletionMessageToolCallFunctionParam,
+)
+from .tool_type_param import ToolTypeParam
+
+
+class ChatCompletionMessageToolCallParam(TypedDict, total=False):
+    id: Required[str]
+    """The ID of the tool call."""
+
+    type: Required[ToolTypeParam]
+    """The type of the tool. Currently, only `function` is supported."""
+
+    function: Required[ChatCompletionMessageToolCallFunctionParam]
+    """The function that the model called."""

arkruntime/types/chat/chat_completion_named_tool_choice.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 .chat_completion_tool_choice_function import ChatCompletionToolChoiceFunction
+
+
+class ChatCompletionNamedToolChoice(BaseModel):
+    type: Literal["function"]
+    """
+    For function calling, the type is always `function`.
+    """
+    function: ChatCompletionToolChoiceFunction

arkruntime/types/chat/chat_completion_named_tool_choice_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
+
+from typing_extensions import Required, TypedDict
+
+from .chat_completion_tool_choice_function_param import (
+    ChatCompletionToolChoiceFunctionParam,
+)
+
+
+class ChatCompletionNamedToolChoiceParam(TypedDict, total=False):
+    type: Required[Literal["function"]]
+    """For function calling, the type is always `function`."""
+
+    function: Required[ChatCompletionToolChoiceFunctionParam]

arkruntime/types/chat/chat_completion_request.py

@@ -0,0 +1,129 @@
+# 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, List, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_request_message import ChatCompletionRequestMessage
+from .chat_completion_response_format import ChatCompletionResponseFormat
+from .chat_completion_stop import ChatCompletionStop
+from .chat_completion_stream_options import ChatCompletionStreamOptions
+from .chat_completion_tool import ChatCompletionTool
+from .chat_completion_tool_choice import ChatCompletionToolChoice
+from .reasoning_effort import ReasoningEffort
+from .request_service_tier import RequestServiceTier
+from .thinking import Thinking
+
+
+class ChatCompletionRequest(BaseModel):
+    messages: List[ChatCompletionRequestMessage]
+    """
+    A list of messages comprising the conversation so far.
+    """
+    model: str
+    """
+    ID of the model to use.
+    """
+    frequency_penalty: Optional[float] = None
+    """
+    Number between -2.0 and 2.0. Positive values penalize new tokens
+    based on their existing frequency in the text so far.
+    """
+    presence_penalty: Optional[float] = None
+    """
+    Number between -2.0 and 2.0. Positive values penalize new tokens
+    based on whether they appear in the text so far.
+    """
+    repetition_penalty: Optional[float] = None
+    """
+    Number between 0.0 and 2.0. Penalizes repetition independently of
+    frequency.
+    """
+    logit_bias: Optional[Dict[str, float]] = None
+    """
+    Modify the likelihood of specified tokens appearing in the
+    completion. Maps token IDs (as strings) to a bias from -100 to 100.
+    """
+    logprobs: Optional[bool] = None
+    """
+    Whether to return log probabilities of the output tokens.
+    """
+    top_logprobs: Optional[int] = None
+    """
+    Number of most-likely tokens to return at each position when
+    `logprobs` is true. Range 0-20.
+    """
+    max_tokens: Optional[int] = None
+    """
+    The maximum number of tokens that can be generated in the
+    completion.
+    """
+    max_completion_tokens: Optional[int] = None
+    """
+    Upper bound on completion tokens, including reasoning tokens.
+    """
+    n: Optional[int] = None
+    """
+    How many chat completion choices to generate for each input
+    message. Range 1-5.
+    """
+    response_format: Optional[ChatCompletionResponseFormat] = None
+    """
+    An object specifying the format that the model must output.
+    """
+    stop: Optional[ChatCompletionStop] = None
+    """
+    Up to 4 sequences where the API will stop generating further
+    tokens.
+    """
+    stream: Optional[bool] = None
+    """
+    If set, partial message deltas will be sent as data-only
+    server-sent events.
+    """
+    stream_options: Optional[ChatCompletionStreamOptions] = None
+    """
+    Options for streaming responses.
+    """
+    temperature: Optional[float] = None
+    """
+    What sampling temperature to use, between 0 and 2.
+    """
+    top_p: Optional[float] = None
+    """
+    Nucleus sampling: between 0 and 1.
+    """
+    tool_choice: Optional[ChatCompletionToolChoice] = None
+    """
+    Controls which (if any) tool is called by the model.
+    """
+    tools: Optional[List[ChatCompletionTool]] = None
+    """
+    A list of tools the model may call.
+    """
+    parallel_tool_calls: Optional[bool] = None
+    """
+    Whether to enable parallel function calling during tool use.
+    """
+    user: Optional[str] = None
+    """
+    A unique identifier representing your end-user.
+    """
+    service_tier: Optional[RequestServiceTier] = None
+    """
+    The service tier to use for the request.
+    """
+    reasoning_effort: Optional[ReasoningEffort] = None
+    """
+    Constrains effort on reasoning.
+    """
+    thinking: Optional[Thinking] = None
+    """
+    Configuration for thinking-mode models.
+    """

arkruntime/types/chat/chat_completion_request_assistant_message.py

@@ -0,0 +1,39 @@
+# 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 .chat_completion_message_content import ChatCompletionMessageContent
+from .chat_completion_message_tool_call import ChatCompletionMessageToolCall
+
+
+class ChatCompletionRequestAssistantMessage(BaseModel):
+    role: Literal["assistant"]
+    """
+    The role of the messages author. Always `assistant`.
+    """
+    content: Optional[ChatCompletionMessageContent] = None
+    """
+    The contents of the assistant message. Required unless `tool_calls`
+    is specified.
+    """
+    reasoning_content: Optional[ChatCompletionMessageContent] = None
+    """
+    The reasoning content emitted by the assistant alongside `content`.
+    """
+    encrypted_content: Optional[str] = None
+    """
+    Encrypted form of the reasoning content, when redaction is enabled.
+    """
+    tool_calls: Optional[List[ChatCompletionMessageToolCall]] = None
+    """
+    The tool calls generated by the model, such as function calls.
+    """
+    name: Optional[str] = None

arkruntime/types/chat/chat_completion_request_assistant_message_param.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 typing_extensions import Required, TypedDict
+
+from .chat_completion_message_content_param import ChatCompletionMessageContentParam
+from .chat_completion_message_tool_call_param import ChatCompletionMessageToolCallParam
+
+
+class ChatCompletionRequestAssistantMessageParam(TypedDict, total=False):
+    role: Required[Literal["assistant"]]
+    """The role of the messages author. Always `assistant`."""
+
+    content: Optional[ChatCompletionMessageContentParam]
+    """
+    The contents of the assistant message. Required unless `tool_calls`
+    is specified.
+    """
+
+    reasoning_content: Optional[ChatCompletionMessageContentParam]
+    """The reasoning content emitted by the assistant alongside `content`."""
+
+    encrypted_content: Optional[str]
+    """Encrypted form of the reasoning content, when redaction is enabled."""
+
+    tool_calls: Optional[List[ChatCompletionMessageToolCallParam]]
+    """The tool calls generated by the model, such as function calls."""
+
+    name: Optional[str]

arkruntime/types/chat/chat_completion_request_message.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 Annotated, Union
+
+from pydantic import Field
+from typing_extensions import TypeAliasType
+
+from .chat_completion_request_assistant_message import (
+    ChatCompletionRequestAssistantMessage,
+)
+from .chat_completion_request_system_message import ChatCompletionRequestSystemMessage
+from .chat_completion_request_tool_message import ChatCompletionRequestToolMessage
+from .chat_completion_request_user_message import ChatCompletionRequestUserMessage
+
+ChatCompletionRequestMessage = TypeAliasType(
+    "ChatCompletionRequestMessage",
+    Annotated[
+        Union[
+            ChatCompletionRequestUserMessage,
+            ChatCompletionRequestSystemMessage,
+            ChatCompletionRequestAssistantMessage,
+            ChatCompletionRequestToolMessage,
+        ],
+        Field(discriminator="role"),
+    ],
+)