arkruntime 0.1.0__py3-none-any.whl

arkruntime/types/chat/chat_completion_request_message_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_request_assistant_message_param import (
+    ChatCompletionRequestAssistantMessageParam,
+)
+from .chat_completion_request_system_message_param import (
+    ChatCompletionRequestSystemMessageParam,
+)
+from .chat_completion_request_tool_message_param import (
+    ChatCompletionRequestToolMessageParam,
+)
+from .chat_completion_request_user_message_param import (
+    ChatCompletionRequestUserMessageParam,
+)
+
+ChatCompletionRequestMessageParam: TypeAlias = Union[
+    ChatCompletionRequestUserMessageParam,
+    ChatCompletionRequestSystemMessageParam,
+    ChatCompletionRequestAssistantMessageParam,
+    ChatCompletionRequestToolMessageParam,
+]

arkruntime/types/chat/chat_completion_request_param.py

@@ -0,0 +1,122 @@
+# 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 typing_extensions import Required, TypedDict
+
+from .chat_completion_request_message_param import ChatCompletionRequestMessageParam
+from .chat_completion_response_format_param import ChatCompletionResponseFormatParam
+from .chat_completion_stop_param import ChatCompletionStopParam
+from .chat_completion_stream_options_param import ChatCompletionStreamOptionsParam
+from .chat_completion_tool_choice_param import ChatCompletionToolChoiceParam
+from .chat_completion_tool_param import ChatCompletionToolParam
+from .reasoning_effort import ReasoningEffort
+from .request_service_tier import RequestServiceTier
+from .thinking_param import ThinkingParam
+
+
+class ChatCompletionRequestParam(TypedDict, total=False):
+    messages: Required[List[ChatCompletionRequestMessageParam]]
+    """A list of messages comprising the conversation so far."""
+
+    model: Required[str]
+    """ID of the model to use."""
+
+    frequency_penalty: Optional[float]
+    """
+    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]
+    """
+    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]
+    """
+    Number between 0.0 and 2.0. Penalizes repetition independently of
+    frequency.
+    """
+
+    logit_bias: Optional[Dict[str, float]]
+    """
+    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]
+    """Whether to return log probabilities of the output tokens."""
+
+    top_logprobs: Optional[int]
+    """
+    Number of most-likely tokens to return at each position when
+    `logprobs` is true. Range 0-20.
+    """
+
+    max_tokens: Optional[int]
+    """
+    The maximum number of tokens that can be generated in the
+    completion.
+    """
+
+    max_completion_tokens: Optional[int]
+    """Upper bound on completion tokens, including reasoning tokens."""
+
+    n: Optional[int]
+    """
+    How many chat completion choices to generate for each input
+    message. Range 1-5.
+    """
+
+    response_format: Optional[ChatCompletionResponseFormatParam]
+    """An object specifying the format that the model must output."""
+
+    stop: Optional[ChatCompletionStopParam]
+    """
+    Up to 4 sequences where the API will stop generating further
+    tokens.
+    """
+
+    stream: Optional[bool]
+    """
+    If set, partial message deltas will be sent as data-only
+    server-sent events.
+    """
+
+    stream_options: Optional[ChatCompletionStreamOptionsParam]
+    """Options for streaming responses."""
+
+    temperature: Optional[float]
+    """What sampling temperature to use, between 0 and 2."""
+
+    top_p: Optional[float]
+    """Nucleus sampling: between 0 and 1."""
+
+    tool_choice: Optional[ChatCompletionToolChoiceParam]
+    """Controls which (if any) tool is called by the model."""
+
+    tools: Optional[List[ChatCompletionToolParam]]
+    """A list of tools the model may call."""
+
+    parallel_tool_calls: Optional[bool]
+    """Whether to enable parallel function calling during tool use."""
+
+    user: Optional[str]
+    """A unique identifier representing your end-user."""
+
+    service_tier: Optional[RequestServiceTier]
+    """The service tier to use for the request."""
+
+    reasoning_effort: Optional[ReasoningEffort]
+    """Constrains effort on reasoning."""
+
+    thinking: Optional[ThinkingParam]
+    """Configuration for thinking-mode models."""

arkruntime/types/chat/chat_completion_request_system_message.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 Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_message_content import ChatCompletionMessageContent
+
+
+class ChatCompletionRequestSystemMessage(BaseModel):
+    role: Literal["system"]
+    """
+    The role of the messages author. Always `system`.
+    """
+    content: ChatCompletionMessageContent
+    """
+    The contents of the system message.
+    """
+    name: Optional[str] = None

arkruntime/types/chat/chat_completion_request_system_message_param.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, Optional
+
+from typing_extensions import Required, TypedDict
+
+from .chat_completion_message_content_param import ChatCompletionMessageContentParam
+
+
+class ChatCompletionRequestSystemMessageParam(TypedDict, total=False):
+    role: Required[Literal["system"]]
+    """The role of the messages author. Always `system`."""
+
+    content: Required[ChatCompletionMessageContentParam]
+    """The contents of the system message."""
+
+    name: Optional[str]

arkruntime/types/chat/chat_completion_request_tool_message.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 Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_message_content import ChatCompletionMessageContent
+
+
+class ChatCompletionRequestToolMessage(BaseModel):
+    role: Literal["tool"]
+    """
+    The role of the messages author. Always `tool`.
+    """
+    content: ChatCompletionMessageContent
+    """
+    The contents of the tool message.
+    """
+    tool_call_id: str
+    """
+    Tool call that this message is responding to.
+    """
+    name: Optional[str] = None

arkruntime/types/chat/chat_completion_request_tool_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 .chat_completion_message_content_param import ChatCompletionMessageContentParam
+
+
+class ChatCompletionRequestToolMessageParam(TypedDict, total=False):
+    role: Required[Literal["tool"]]
+    """The role of the messages author. Always `tool`."""
+
+    content: Required[ChatCompletionMessageContentParam]
+    """The contents of the tool message."""
+
+    tool_call_id: Required[str]
+    """Tool call that this message is responding to."""
+
+    name: Optional[str]

arkruntime/types/chat/chat_completion_request_user_message.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 Literal, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_message_content import ChatCompletionMessageContent
+
+
+class ChatCompletionRequestUserMessage(BaseModel):
+    role: Literal["user"]
+    """
+    The role of the messages author. Always `user`.
+    """
+    content: ChatCompletionMessageContent
+    """
+    The contents of the user message.
+    """
+    name: Optional[str] = None
+    """
+    An optional name for the participant. Provides the model information
+    to differentiate between participants of the same role.
+    """

arkruntime/types/chat/chat_completion_request_user_message_param.py

@@ -0,0 +1,27 @@
+# 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 .chat_completion_message_content_param import ChatCompletionMessageContentParam
+
+
+class ChatCompletionRequestUserMessageParam(TypedDict, total=False):
+    role: Required[Literal["user"]]
+    """The role of the messages author. Always `user`."""
+
+    content: Required[ChatCompletionMessageContentParam]
+    """The contents of the user message."""
+
+    name: Optional[str]
+    """
+    An optional name for the participant. Provides the model information
+    to differentiate between participants of the same role.
+    """

arkruntime/types/chat/chat_completion_response.py

@@ -0,0 +1,52 @@
+# 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_response_choice import ChatCompletionResponseChoice
+from .chat_completion_service_status import ChatCompletionServiceStatus
+from .completion_usage import CompletionUsage
+from .response_service_tier import ResponseServiceTier
+
+
+class ChatCompletionResponse(BaseModel):
+    id: str
+    """
+    A unique identifier for the chat completion.
+    """
+    model: str
+    """
+    The model used for the chat completion.
+    """
+    created: int
+    """
+    The Unix timestamp (in seconds) of when the chat completion was
+    created.
+    """
+    object: Literal["chat.completion"]
+    """
+    The object type. Always `chat.completion`.
+    """
+    choices: List[ChatCompletionResponseChoice]
+    """
+    A list of chat completion choices.
+    """
+    usage: Optional[CompletionUsage] = None
+    """
+    Usage statistics for the completion request.
+    """
+    service_tier: Optional[ResponseServiceTier] = None
+    """
+    The service tier used to process the request.
+    """
+    service_status: Optional[ChatCompletionServiceStatus] = None
+    """
+    Service status information attached to the response.
+    """

arkruntime/types/chat/chat_completion_response_choice.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 .chat_completion_choice_logprobs import ChatCompletionChoiceLogprobs
+from .chat_completion_response_message import ChatCompletionResponseMessage
+from .finish_reason import FinishReason
+from .moderation_hit_type import ModerationHitType
+
+
+class ChatCompletionResponseChoice(BaseModel):
+    index: int
+    """
+    The index of the choice in the list of choices.
+    """
+    message: ChatCompletionResponseMessage
+    finish_reason: FinishReason
+    """
+    The reason the model stopped generating tokens.
+    """
+    moderation_hit_type: Optional[ModerationHitType] = None
+    """
+    When set, the type of moderation that was triggered.
+    """
+    logprobs: Optional[ChatCompletionChoiceLogprobs]
+    """
+    Log probability information for the choice.
+    """

arkruntime/types/chat/chat_completion_response_format.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 Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_response_format_json_schema import (
+    ChatCompletionResponseFormatJsonSchema,
+)
+from .response_format_type import ResponseFormatType
+
+
+class ChatCompletionResponseFormat(BaseModel):
+    type: Optional[ResponseFormatType] = None
+    """
+    The type of the response format.
+    """
+    json_schema: Optional[ChatCompletionResponseFormatJsonSchema] = None
+    """
+    Structured Outputs configuration; required when `type` is
+    `json_schema`.
+    """

arkruntime/types/chat/chat_completion_response_format_json_schema.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 Annotated, Dict, Optional
+
+from arkruntime._models import BaseModel
+from pydantic import Field
+
+
+class ChatCompletionResponseFormatJsonSchema(BaseModel):
+    name: str
+    """
+    The name of the response format.
+    """
+    description: Optional[str] = None
+    """
+    A description of what the response format is for.
+    """
+    schema_: Annotated[Optional[Dict[str, object]], Field(alias="schema")] = None
+    """
+    The schema for the response format, described as a JSON Schema
+    object.
+    """
+    strict: Optional[bool] = None
+    """
+    Whether to enable strict schema adherence when generating the
+    output.
+    """

arkruntime/types/chat/chat_completion_response_format_json_schema_param.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 Dict, Optional
+
+from typing_extensions import Required, TypedDict
+
+
+class ChatCompletionResponseFormatJsonSchemaParam(TypedDict, total=False):
+    name: Required[str]
+    """The name of the response format."""
+
+    description: Optional[str]
+    """A description of what the response format is for."""
+
+    schema: Optional[Dict[str, object]]
+    """
+    The schema for the response format, described as a JSON Schema
+    object.
+    """
+
+    strict: Optional[bool]
+    """
+    Whether to enable strict schema adherence when generating the
+    output.
+    """

arkruntime/types/chat/chat_completion_response_format_param.py

@@ -0,0 +1,27 @@
+# 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 .chat_completion_response_format_json_schema_param import (
+    ChatCompletionResponseFormatJsonSchemaParam,
+)
+from .response_format_type import ResponseFormatType
+
+
+class ChatCompletionResponseFormatParam(TypedDict, total=False):
+    type: Optional[ResponseFormatType]
+    """The type of the response format."""
+
+    json_schema: Optional[ChatCompletionResponseFormatJsonSchemaParam]
+    """
+    Structured Outputs configuration; required when `type` is
+    `json_schema`.
+    """

arkruntime/types/chat/chat_completion_response_message.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 List, Optional
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_message_tool_call import ChatCompletionMessageToolCall
+from .chat_completion_role import ChatCompletionRole
+
+
+class ChatCompletionResponseMessage(BaseModel):
+    role: ChatCompletionRole
+    """
+    The role of the author of this message.
+    """
+    content: str
+    """
+    The contents of the message.
+    """
+    reasoning_content: Optional[str] = None
+    """
+    The reasoning content emitted by the model alongside `content`.
+    """
+    encrypted_content: Optional[str] = None
+    """
+    Encrypted form of the reasoning content.
+    """
+    tool_calls: Optional[List[ChatCompletionMessageToolCall]] = None
+    """
+    The tool calls generated by the model.
+    """

arkruntime/types/chat/chat_completion_role.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 enum import Enum
+
+
+class ChatCompletionRole(str, Enum):
+    user = "user"
+    system = "system"
+    assistant = "assistant"
+    tool = "tool"

arkruntime/types/chat/chat_completion_service_status.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 .model_fallback_status import ModelFallbackStatus
+
+
+class ChatCompletionServiceStatus(BaseModel):
+    model_fallback: Optional[ModelFallbackStatus] = None

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

arkruntime/types/chat/chat_completion_stop_param.py

@@ -0,0 +1,11 @@
+# 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
+
+ChatCompletionStopParam: TypeAlias = Union[str, List[str]]

arkruntime/types/chat/chat_completion_stream_choice_logprobs.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
+
+from arkruntime._models import BaseModel
+
+from .chat_completion_token_logprob import ChatCompletionTokenLogprob
+
+
+class ChatCompletionStreamChoiceLogprobs(BaseModel):
+    content: List[ChatCompletionTokenLogprob]

arkruntime/types/chat/chat_completion_stream_options.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 Optional
+
+from arkruntime._models import BaseModel
+
+
+class ChatCompletionStreamOptions(BaseModel):
+    include_usage: Optional[bool] = None
+    """
+    Whether to include token usage info in the final stream chunk.
+    """
+    chunk_include_usage: Optional[bool] = None
+    """
+    Whether to include token usage info in every stream chunk.
+    """