Skip to content

Commit 64ae030

Browse files
chore: sync from ark-apis d20f0d68da
Auto-generated SDK sync from ark-apis at d20f0d68da2100d87a660921aedc9b72d75c6a34. Generated files are overwritten by the sync pipeline and should not be edited by hand. Sync-Source-Commit: 49c3974c74c71949bddedab29bcd594c319301e6 Ark-APIs-Commit: d20f0d68da2100d87a660921aedc9b72d75c6a34 Release-Version: 0.6.0
1 parent c2eaf2b commit 64ae030

15 files changed

Lines changed: 296 additions & 18 deletions

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.5.0
1+
0.6.0

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "arkruntime"
7-
version = "0.5.0"
7+
version = "0.6.0"
88
description = "Ark runtime SDK for Python"
99
readme = "README.md"
1010
requires-python = ">=3.8"

src/arkruntime/resources/images/images.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from __future__ import annotations
66

7-
from typing import List, Optional
7+
from typing import List, Optional, Union
88

99
import httpx
1010

@@ -14,6 +14,7 @@
1414
from ..._types import Body, Headers, Query
1515

1616
# AUTOGEN-START create-imports
17+
from ...types.images.background import Background
1718
from ...types.images.image_generation_response import ImageGenerationResponse
1819
from ...types.images.image_generation_stream_event import ImageGenerationStreamEvent
1920
from ...types.images.optimize_prompt_options_param import OptimizePromptOptionsParam
@@ -36,8 +37,8 @@ def generate(
3637
*,
3738
# AUTOGEN-START create-kwargs
3839
model: str,
39-
prompt: str,
40-
image: Optional[List[str]] = None,
40+
prompt: Optional[str] = None,
41+
image: Optional[Union[str, List[str]]] = None,
4142
stream: Optional[bool] = None,
4243
response_format: Optional[ResponseFormat] = None,
4344
seed: Optional[int] = None,
@@ -50,6 +51,7 @@ def generate(
5051
optimize_prompt_options: Optional[OptimizePromptOptionsParam] = None,
5152
tools: Optional[List[ToolParam]] = None,
5253
output_format: Optional[OutputFormat] = None,
54+
background: Optional[Background] = None,
5355
layer_decomposition: Optional[bool] = None,
5456
# AUTOGEN-END create-kwargs
5557
extra_headers: Headers | None = None,
@@ -76,6 +78,7 @@ def generate(
7678
"optimize_prompt_options": optimize_prompt_options,
7779
"tools": tools,
7880
"output_format": output_format,
81+
"background": background,
7982
"layer_decomposition": layer_decomposition,
8083
# AUTOGEN-END create-body
8184
},
@@ -97,8 +100,8 @@ async def generate(
97100
*,
98101
# AUTOGEN-START create-kwargs
99102
model: str,
100-
prompt: str,
101-
image: Optional[List[str]] = None,
103+
prompt: Optional[str] = None,
104+
image: Optional[Union[str, List[str]]] = None,
102105
stream: Optional[bool] = None,
103106
response_format: Optional[ResponseFormat] = None,
104107
seed: Optional[int] = None,
@@ -111,6 +114,7 @@ async def generate(
111114
optimize_prompt_options: Optional[OptimizePromptOptionsParam] = None,
112115
tools: Optional[List[ToolParam]] = None,
113116
output_format: Optional[OutputFormat] = None,
117+
background: Optional[Background] = None,
114118
layer_decomposition: Optional[bool] = None,
115119
# AUTOGEN-END create-kwargs
116120
extra_headers: Headers | None = None,
@@ -137,6 +141,7 @@ async def generate(
137141
"optimize_prompt_options": optimize_prompt_options,
138142
"tools": tools,
139143
"output_format": output_format,
144+
"background": background,
140145
"layer_decomposition": layer_decomposition,
141146
# AUTOGEN-END create-body
142147
},

src/arkruntime/types/images/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
from __future__ import annotations
88

9+
from .background import Background
910
from .bounding_box import BoundingBox
1011
from .create_image_generation_request import CreateImageGenerationRequest
1112
from .image_data_item import ImageDataItem
@@ -25,6 +26,7 @@
2526
from .usage import Usage
2627

2728
__all__ = [
29+
"Background",
2830
"BoundingBox",
2931
"CreateImageGenerationRequest",
3032
"ImageDataItem",
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Generated by datamodel-code-generator from ark-apis typespec/openapi.
2+
# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
3+
#
4+
# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
from __future__ import annotations
8+
9+
from enum import Enum
10+
11+
12+
class Background(str, Enum):
13+
"""
14+
Background of the generated image.
15+
"""
16+
17+
opaque = "opaque"
18+
transparent = "transparent"

src/arkruntime/types/images/create_image_generation_request.py

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@
66

77
from __future__ import annotations
88

9-
from typing import List, Optional
9+
from typing import List, Optional, Union
1010

1111
from arkruntime._models import BaseModel
1212

13+
from .background import Background
1314
from .optimize_prompt_options import OptimizePromptOptions
1415
from .output_format import OutputFormat
1516
from .response_format import ResponseFormat
@@ -23,13 +24,13 @@ class CreateImageGenerationRequest(BaseModel):
2324
"""
2425
The model identifier to use.
2526
"""
26-
prompt: str
27+
prompt: Optional[str] = None
2728
"""
28-
Text prompt describing the desired image.
29+
Text prompt describing the desired image. Required for standard generation; may be omitted for automatic layer decomposition when `layer_decomposition=true`.
2930
"""
30-
image: Optional[List[str]] = None
31+
image: Optional[Union[str, List[str]]] = None
3132
"""
32-
Reference / edit images. Each entry is a URL or a `data:` URI.
33+
Reference / edit images, as a single URL or `data:` URI, or an array of them.
3334
"""
3435
stream: Optional[bool] = None
3536
"""
@@ -81,6 +82,10 @@ class CreateImageGenerationRequest(BaseModel):
8182
"""
8283
Container/codec for the generated image bytes.
8384
"""
85+
background: Optional[Background] = None
86+
"""
87+
Output background. Defaults to `opaque`. `transparent` requires exactly one PNG reference image with an alpha channel and PNG output.
88+
"""
8489
layer_decomposition: Optional[bool] = None
8590
"""
8691
Decompose one reference image into a base image and independently

src/arkruntime/types/images/create_image_generation_request_param.py

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@
66

77
from __future__ import annotations
88

9-
from typing import List, Optional
9+
from typing import List, Optional, Union
1010

1111
from typing_extensions import Required, TypedDict
1212

13+
from .background import Background
1314
from .optimize_prompt_options_param import OptimizePromptOptionsParam
1415
from .output_format import OutputFormat
1516
from .response_format import ResponseFormat
@@ -24,11 +25,11 @@ class CreateImageGenerationRequestParam(TypedDict, total=False):
2425
model: Required[str]
2526
"""The model identifier to use."""
2627

27-
prompt: Required[str]
28-
"""Text prompt describing the desired image."""
28+
prompt: Optional[str]
29+
"""Text prompt describing the desired image. Required for standard generation; may be omitted for automatic layer decomposition when `layer_decomposition=true`."""
2930

30-
image: Optional[List[str]]
31-
"""Reference / edit images. Each entry is a URL or a `data:` URI."""
31+
image: Optional[Union[str, List[str]]]
32+
"""Reference / edit images, as a single URL or `data:` URI, or an array of them."""
3233

3334
stream: Optional[bool]
3435
"""Stream partial images as they are generated (server-sent events)."""
@@ -66,6 +67,9 @@ class CreateImageGenerationRequestParam(TypedDict, total=False):
6667
output_format: Optional[OutputFormat]
6768
"""Container/codec for the generated image bytes."""
6869

70+
background: Optional[Background]
71+
"""Output background. Defaults to `opaque`. `transparent` requires exactly one PNG reference image with an alpha channel and PNG output."""
72+
6973
layer_decomposition: Optional[bool]
7074
"""
7175
Decompose one reference image into a base image and independently

src/arkruntime/types/session/__init__.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,21 @@
88

99
from .agent_identifier import AgentIdentifier
1010
from .agent_ref import AgentRef
11+
from .agent_with_upgrades import AgentWithUpgrades
1112
from .base64_document_source import Base64DocumentSource
1213
from .base64_image_source import Base64ImageSource
1314
from .cache_creation import CacheCreation
1415
from .create_session_request import CreateSessionRequest
1516
from .create_session_resource_request import CreateSessionResourceRequest
17+
from .create_session_upgrade_request import CreateSessionUpgradeRequest
1618
from .delete_session_response import DeleteSessionResponse
1719
from .document_source import DocumentSource
1820
from .environment_config_override import EnvironmentConfigOverride
1921
from .environment_networking_config import EnvironmentNetworkingConfig
2022
from .environment_packages_config import EnvironmentPackagesConfig
2123
from .environment_tos_config import EnvironmentTosConfig
2224
from .environment_with_overrides import EnvironmentWithOverrides
25+
from .environment_with_upgrades import EnvironmentWithUpgrades
2326
from .file_document_source import FileDocumentSource
2427
from .file_image_source import FileImageSource
2528
from .image_source import ImageSource
@@ -72,6 +75,7 @@
7275
ManagedAgentsUserToolResultEventParams,
7376
)
7477
from .model_overrides import ModelOverrides
78+
from .model_upgrades import ModelUpgrades
7579
from .plain_text_document_source import PlainTextDocumentSource
7680
from .search_result_citations import SearchResultCitations
7781
from .search_result_content import SearchResultContent
@@ -94,18 +98,21 @@
9498
__all__ = [
9599
"AgentIdentifier",
96100
"AgentRef",
101+
"AgentWithUpgrades",
97102
"Base64DocumentSource",
98103
"Base64ImageSource",
99104
"CacheCreation",
100105
"CreateSessionRequest",
101106
"CreateSessionResourceRequest",
107+
"CreateSessionUpgradeRequest",
102108
"DeleteSessionResponse",
103109
"DocumentSource",
104110
"EnvironmentConfigOverride",
105111
"EnvironmentNetworkingConfig",
106112
"EnvironmentPackagesConfig",
107113
"EnvironmentTosConfig",
108114
"EnvironmentWithOverrides",
115+
"EnvironmentWithUpgrades",
109116
"FileDocumentSource",
110117
"FileImageSource",
111118
"ImageSource",
@@ -142,6 +149,7 @@
142149
"ManagedAgentsUserToolConfirmationEventParams",
143150
"ManagedAgentsUserToolResultEventParams",
144151
"ModelOverrides",
152+
"ModelUpgrades",
145153
"PlainTextDocumentSource",
146154
"SearchResultCitations",
147155
"SearchResultContent",
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# Generated by datamodel-code-generator from ark-apis typespec/openapi.
2+
# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
3+
#
4+
# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
from __future__ import annotations
8+
9+
from typing import Dict, List, Literal, Optional
10+
11+
from arkruntime._models import BaseModel
12+
13+
from .model_upgrades import ModelUpgrades
14+
15+
16+
class AgentWithUpgrades(BaseModel):
17+
"""
18+
Session upgrade 的目标 Agent 运行配置。
19+
20+
`id` 必须等于当前 Session 的 Agent ID —— upgrade 不支持换绑到另一个
21+
Agent,不一致返回 403 `AgentMismatch`。
22+
23+
数组字段(`tools` / `mcp_servers` / `skills`)是**整组替换**语义:省略
24+
表示保留原值,显式传 `[]` 表示清空。两者在 wire 上必须可区分,SDK 不能
25+
把空数组优化成省略字段。
26+
"""
27+
28+
type: Literal["agent_with_upgrades"]
29+
"""
30+
固定 `"agent_with_upgrades"`。
31+
"""
32+
id: str
33+
"""
34+
Agent ID;必须与当前 Session 的 Agent ID 一致。
35+
"""
36+
version: Optional[int] = None
37+
"""
38+
目标 Agent 版本号。
39+
40+
省略或传 `0` 表示**不锁版本、沿用 Session 当前的 Agent 快照**(注意与创建
41+
期不同:这里不是"走最新版")。传正整数则以该版本的 payload 为基线物化
42+
——`system` / `tools` / `mcp_servers` / `skills` / `multiagent` / `model`
43+
整组跟着版本走,本次请求里的同名字段再叠加其上;版本不存在返回 404。
44+
传负数返回 400。
45+
"""
46+
model: Optional[ModelUpgrades] = None
47+
"""
48+
模型运行参数升级。
49+
"""
50+
system: Optional[str] = None
51+
"""
52+
System prompt。
53+
"""
54+
tools: Optional[List[Dict[str, object]]] = None
55+
"""
56+
工具配置(整组替换)。
57+
"""
58+
mcp_servers: Optional[List[Dict[str, object]]] = None
59+
"""
60+
MCP server 配置(整组替换)。
61+
"""
62+
skills: Optional[List[Dict[str, object]]] = None
63+
"""
64+
Skill 配置(整组替换)。
65+
"""
66+
multiagent: Optional[Dict[str, object]] = None
67+
"""
68+
多 Agent 配置。
69+
"""
70+
display_name: Optional[str] = None
71+
"""
72+
Agent 展示名。
73+
"""
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Generated by datamodel-code-generator from ark-apis typespec/openapi.
2+
# DO NOT EDIT — regenerate with `make gen-py-<api>` in ark-apis.
3+
#
4+
# Copyright (c) 2026 ByteDance Ltd. and/or its affiliates.
5+
# SPDX-License-Identifier: Apache-2.0
6+
7+
from __future__ import annotations
8+
9+
from typing import List, Optional
10+
11+
from arkruntime._models import BaseModel
12+
13+
from .agent_with_upgrades import AgentWithUpgrades
14+
from .environment_with_upgrades import EnvironmentWithUpgrades
15+
from .managed_agents_event_params import ManagedAgentsEventParams
16+
17+
18+
class CreateSessionUpgradeRequest(BaseModel):
19+
"""
20+
发起一次已有 Session 的运行配置升级。
21+
22+
`agent` / `environment` / `vault_ids` 至少提供一个作为升级目标,全部省略
23+
返回 400 `MissingUpgradeTarget`(只传 `initial_events` 不算升级目标)。
24+
Session 必须处于 `idle` 且上一轮 turn 以 `end_turn` 收尾,否则返回 403
25+
`SessionNotIdle` / `SessionNotEndTurn`;同一 Session 上一次升级尚未收敛时
26+
返回 403 `UpgradeInProgress`。
27+
"""
28+
29+
agent: Optional[AgentWithUpgrades] = None
30+
"""
31+
目标 Agent 运行配置。
32+
"""
33+
environment: Optional[EnvironmentWithUpgrades] = None
34+
"""
35+
目标 Environment 运行配置。
36+
"""
37+
vault_ids: Optional[List[str]] = None
38+
"""
39+
Session 绑定的 Vault 列表。
40+
41+
只能用来**刷新已绑定 Vault 的内容**,不能改变绑定集合:传入集合必须与
42+
当前 Session 的 `vault_ids` 相等(忽略顺序与重复),否则返回 403
43+
`VaultMismatch`。显式传 `[]` 表示声明空集,仅当当前 Session 本身没有
44+
Vault 绑定时通过 —— 因此省略与 `[]` 在 wire 上必须可区分,SDK 不能把
45+
空数组优化成省略字段。
46+
"""
47+
initial_events: Optional[List[ManagedAgentsEventParams]] = None
48+
"""
49+
配置切换收敛后由服务端补投的事件。当前只接受**恰好一个** `user.message`
50+
事件,且 content 为单个 text block、内容是 `/compact` 命令 XML;不满足
51+
返回 400 `InvalidInitialEvents` / `InvalidCompactCommand`。省略或传 `[]`
52+
表示本次不投递事件。
53+
"""

0 commit comments

Comments
 (0)