AgentStudio(托管智能体)¶
dashscope.applications.agentstudio 是 AgentStudio 托管智能体 API 的
子 SDK:智能体、会话、事件、环境、部署、记忆、技能、密钥库、
安全与 Webhook。所有资源都通过它自己的客户端访问:
from dashscope.applications.agentstudio import Client
from dashscope.applications.agentstudio import user_message
client = Client(api_key="sk-xxx")
agent = client.agents.create(name="demo", model="qwen-plus")
session = client.sessions.create(agent=agent.id)
client.sessions.events.send(session.id, [user_message("你好!")])
with client.sessions.events.stream(session.id) as stream:
for event in stream:
print(event.type)
# session_status 也可能是 running,只在结束态退出
if event.session_status in ("idle", "terminated"):
break
会话状态与文本消费
session_status 事件既可能报告 running(运行中),也可能报告
idle / terminated 等结束态——不能把第一个 session_status
当作运行结束。只关心文本回复时,直接用 stream.text_stream:
它产出智能体消息的文本,并在会话到达结束态时自动停止。
若智能体使用需要审批的工具,会话会以 idle +
stop_reason.type == "requires_action" 暂停等待审批:用
user_tool_approval_response 提交审批结果后会话继续运行。
每个资源类都有异步孪生类(AsyncAgents、AsyncSessions……),
通过 AsyncClient 以相同方式使用。
客户端¶
Client
¶
Client(
*,
api_key: Optional[str] = None,
workspace: Optional[str] = None,
region: Optional[str] = None,
base_url: Optional[str] = None,
uid: Optional[str] = None,
timeout: Optional[
Union[float, Timeout, Tuple[float, float]]
] = None,
max_retries: int = AGENTSTUDIO_MAX_RETRIES,
http_client: Optional[Client] = None,
_exceptions_module: Any = _default_exceptions,
_api_key_resolver: Any = _default_api_key,
_transport_cls: Any = SyncTransport,
_event_stream_cls: Any = EventStream
)
Synchronous AgentStudio client.
Usage::
from dashscope.applications.agentstudio import Client, ModelConfig
client = Client(api_key="sk-xxx", workspace="my-ws")
agent = client.agents.create(
name="demo",
model=ModelConfig(
id="qwen-max",
temperature=0.7,
enable_thinking=True,
thinking_budget=2048,
),
)
session = client.sessions.create(agent=agent.id)
with client.sessions.events.stream(session.id) as stream:
for event in stream:
print(event.type)
Source code in dashscope/applications/agentstudio/client.py
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | |
transport
instance-attribute
¶
transport = _transport_cls(
base_url=resolved_base,
api_key=api_key or _api_key_resolver(),
workspace=resolved_workspace,
uid=uid or os.environ.get("DASHSCOPE_UID"),
user_agent=_user_agent(resolved_base),
timeout=timeout or AGENTSTUDIO_DEFAULT_TIMEOUT,
max_retries=max_retries,
http_client=http_client,
exceptions_module=_exceptions_module,
)
close
¶
close() -> None
Source code in dashscope/applications/agentstudio/client.py
222 223 | |
AsyncClient
¶
AsyncClient(
*,
api_key: Optional[str] = None,
workspace: Optional[str] = None,
region: Optional[str] = None,
base_url: Optional[str] = None,
uid: Optional[str] = None,
timeout: Optional[
Union[float, Timeout, Tuple[float, float]]
] = None,
max_retries: int = AGENTSTUDIO_MAX_RETRIES,
http_client: Optional[AsyncClient] = None,
_exceptions_module: Any = _default_exceptions,
_api_key_resolver: Any = _default_api_key,
_transport_cls: Any = AsyncTransport,
_event_stream_cls: Any = AsyncEventStream
)
Asynchronous AgentStudio client.
Usage::
from dashscope.applications.agentstudio import AsyncClient, ModelConfig
client = AsyncClient(api_key="sk-xxx", workspace="my-ws")
agent = await client.agents.create(
name="demo",
model=ModelConfig(id="qwen-max", max_tokens=4096),
)
session = await client.sessions.create(agent=agent.id)
async with client.sessions.events.stream(session.id) as stream:
async for event in stream:
print(event.type)
Source code in dashscope/applications/agentstudio/client.py
256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 | |
transport
instance-attribute
¶
transport = _transport_cls(
base_url=resolved_base,
api_key=api_key or _api_key_resolver(),
workspace=resolved_workspace,
uid=uid or os.environ.get("DASHSCOPE_UID"),
user_agent=_user_agent(resolved_base),
timeout=timeout or AGENTSTUDIO_DEFAULT_TIMEOUT,
max_retries=max_retries,
http_client=http_client,
exceptions_module=_exceptions_module,
)
aclose
async
¶
aclose() -> None
Source code in dashscope/applications/agentstudio/client.py
305 306 | |
智能体与会话¶
Agents
¶
Agents(client)
Agent CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/agents.py
36 37 | |
create
¶
create(
*,
name: str,
model: Union[str, ModelConfig],
description: Optional[str] = None,
system_prompt: Optional[str] = None,
tools: Optional[Sequence[Mapping[str, Any]]] = None,
mcp_servers: Optional[
Sequence[Mapping[str, Any]]
] = None,
skills: Optional[Sequence[Mapping[str, Any]]] = None,
multiagent: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Agent
Source code in dashscope/applications/agentstudio/resources/agents.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | |
retrieve
¶
retrieve(
agent_id: str, *, version: Optional[int] = None
) -> Agent
Source code in dashscope/applications/agentstudio/resources/agents.py
66 67 68 69 70 71 72 73 74 75 76 77 78 | |
update
¶
update(
agent_id: str,
*,
version: int,
name: Optional[str] = None,
model: Optional[Union[str, ModelConfig]] = None,
description: Optional[str] = None,
system_prompt: Optional[str] = None,
tools: Optional[Sequence[Mapping[str, Any]]] = None,
mcp_servers: Optional[
Sequence[Mapping[str, Any]]
] = None,
skills: Optional[Sequence[Mapping[str, Any]]] = None,
multiagent: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Agent
Update the latest version of an agent.
version must equal the server's current version;
the server rejects mismatches with HTTP 409.
Retrieve the agent first to obtain the current version.
name is required too (AGENT_005 without it).
Source code in dashscope/applications/agentstudio/resources/agents.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | |
archive
¶
archive(agent_id: str) -> Agent
Source code in dashscope/applications/agentstudio/resources/agents.py
127 128 129 130 131 132 | |
list
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
include_archived: Optional[bool] = None
) -> CursorPage[Agent]
Source code in dashscope/applications/agentstudio/resources/agents.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | |
list_versions
¶
list_versions(
agent_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[AgentVersion]
Source code in dashscope/applications/agentstudio/resources/agents.py
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 | |
AsyncAgents
¶
AsyncAgents(client)
Async Agent CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/agents.py
190 191 | |
create
async
¶
create(
*,
name: str,
model: Union[str, ModelConfig],
description: Optional[str] = None,
system_prompt: Optional[str] = None,
tools: Optional[Sequence[Mapping[str, Any]]] = None,
mcp_servers: Optional[
Sequence[Mapping[str, Any]]
] = None,
skills: Optional[Sequence[Mapping[str, Any]]] = None,
multiagent: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Agent
Source code in dashscope/applications/agentstudio/resources/agents.py
193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 | |
retrieve
async
¶
retrieve(
agent_id: str, *, version: Optional[int] = None
) -> Agent
Source code in dashscope/applications/agentstudio/resources/agents.py
224 225 226 227 228 229 230 231 232 233 234 235 236 | |
update
async
¶
update(
agent_id: str,
*,
version: int,
name: Optional[str] = None,
model: Optional[Union[str, ModelConfig]] = None,
description: Optional[str] = None,
system_prompt: Optional[str] = None,
tools: Optional[Sequence[Mapping[str, Any]]] = None,
mcp_servers: Optional[
Sequence[Mapping[str, Any]]
] = None,
skills: Optional[Sequence[Mapping[str, Any]]] = None,
multiagent: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Agent
Update the latest version of an agent.
version must equal the server's current version;
the server rejects mismatches with HTTP 409.
Retrieve the agent first to obtain the current version.
name is required too (AGENT_005 without it).
Source code in dashscope/applications/agentstudio/resources/agents.py
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | |
archive
async
¶
archive(agent_id: str) -> Agent
Source code in dashscope/applications/agentstudio/resources/agents.py
285 286 287 288 289 290 | |
list
async
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
include_archived: Optional[bool] = None
) -> AsyncCursorPage[Agent]
Source code in dashscope/applications/agentstudio/resources/agents.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 | |
list_versions
async
¶
list_versions(
agent_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[AgentVersion]
Source code in dashscope/applications/agentstudio/resources/agents.py
325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 | |
Sessions
¶
Sessions(client)
Session CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/sessions.py
47 48 49 50 51 | |
create
¶
create(
*,
agent: Any,
environment_id: Optional[str] = None,
title: Optional[str] = None,
resources: Optional[Sequence[ResourceInput]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
mcp_configs: Optional[
Sequence[Mapping[str, Any]]
] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Session
Create a session (POST /sessions).
agent is the Agent id string or an
{"type": "agent_with_overrides", ...} mapping. resources
entries are wire-format mappings (or
:class:~dashscope.agentstudio.types.Mount objects, which
serialize to the same mappings)::
client.sessions.create(
agent=agent_id,
resources=[
{"type": "memory_store", "memory_store_id": store_id,
"access": "read_write"},
{"type": "oss", "region": "cn-beijing", "bucket": "bkt",
"oss_path": "datasets/", "mount_path": "/data",
"access": "read_only"},
],
)
Source code in dashscope/applications/agentstudio/resources/sessions.py
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 | |
retrieve
¶
retrieve(session_id: str) -> Session
Source code in dashscope/applications/agentstudio/resources/sessions.py
101 102 103 104 105 106 | |
update
¶
update(
session_id: str,
*,
title: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
agent: Any = None,
mcp_configs: Optional[
Sequence[Mapping[str, Any]]
] = None
) -> Session
Source code in dashscope/applications/agentstudio/resources/sessions.py
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | |
list
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
agent_id: Optional[str] = None,
statuses: Optional[Sequence[str]] = None,
created_at_gt: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lt: Optional[str] = None,
created_at_lte: Optional[str] = None
) -> CursorPage[Session]
Source code in dashscope/applications/agentstudio/resources/sessions.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 | |
archive
¶
archive(session_id: str) -> Session
Source code in dashscope/applications/agentstudio/resources/sessions.py
187 188 189 190 191 192 | |
delete
¶
delete(session_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/sessions.py
194 195 196 197 198 199 | |
AsyncSessions
¶
AsyncSessions(client)
Async Session CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/sessions.py
205 206 207 208 209 | |
create
async
¶
create(
*,
agent: Any,
environment_id: Optional[str] = None,
title: Optional[str] = None,
resources: Optional[Sequence[ResourceInput]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
mcp_configs: Optional[
Sequence[Mapping[str, Any]]
] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Session
Create a session (POST /sessions).
agent is the Agent id string or an
{"type": "agent_with_overrides", ...} mapping. resources
entries are wire-format mappings (or
:class:~dashscope.agentstudio.types.Mount objects, which
serialize to the same mappings)::
client.sessions.create(
agent=agent_id,
resources=[
{"type": "memory_store", "memory_store_id": store_id,
"access": "read_write"},
{"type": "oss", "region": "cn-beijing", "bucket": "bkt",
"oss_path": "datasets/", "mount_path": "/data",
"access": "read_only"},
],
)
Source code in dashscope/applications/agentstudio/resources/sessions.py
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | |
retrieve
async
¶
retrieve(session_id: str) -> Session
Source code in dashscope/applications/agentstudio/resources/sessions.py
259 260 261 262 263 264 | |
update
async
¶
update(
session_id: str,
*,
title: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
agent: Any = None,
mcp_configs: Optional[
Sequence[Mapping[str, Any]]
] = None
) -> Session
Source code in dashscope/applications/agentstudio/resources/sessions.py
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 | |
list
async
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
agent_id: Optional[str] = None,
statuses: Optional[Sequence[str]] = None,
created_at_gt: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lt: Optional[str] = None,
created_at_lte: Optional[str] = None
) -> AsyncCursorPage[Session]
Source code in dashscope/applications/agentstudio/resources/sessions.py
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 | |
archive
async
¶
archive(session_id: str) -> Session
Source code in dashscope/applications/agentstudio/resources/sessions.py
346 347 348 349 350 351 | |
delete
async
¶
delete(session_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/sessions.py
353 354 355 356 357 358 | |
SessionEvents
¶
SessionEvents(client)
Session event send / list / stream.
Source code in dashscope/applications/agentstudio/resources/session_events.py
66 67 | |
send
¶
send(
session_id: str, events: Sequence[Mapping[str, Any]]
) -> Dict[str, Any]
Send events to a session.
Source code in dashscope/applications/agentstudio/resources/session_events.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | |
list
¶
list(
session_id: str,
*,
types: Optional[Sequence[str]] = None,
created_at_gt: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lt: Optional[str] = None,
created_at_lte: Optional[str] = None,
limit: Optional[int] = None,
order: Optional[str] = None,
page: Optional[str] = None
) -> CursorPage[ServerEvent]
Source code in dashscope/applications/agentstudio/resources/session_events.py
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | |
stream
¶
stream(
session_id: str,
*,
event_deltas: Optional[Sequence[str]] = None,
timeout: Optional[float] = None
) -> "_TypedEventStream"
Open the SSE stream and return an iterator of typed events.
event_deltas opts into incremental streaming for the given event
types ("message" and/or "reasoning"; aliases "agent.message"
/ "agent.thinking"); anything else the server rejects. The stream is
read once, so text_deltas can be taken from it only; a second pass
raises rather than returning nothing. A chunk stream is not a reliable
source for final text: a reconnect replays only persisted events, so use
text_stream.
Source code in dashscope/applications/agentstudio/resources/session_events.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
AsyncSessionEvents
¶
AsyncSessionEvents(client)
Async session event operations.
Source code in dashscope/applications/agentstudio/resources/session_events.py
265 266 | |
send
async
¶
send(
session_id: str, events: Sequence[Mapping[str, Any]]
) -> Dict[str, Any]
Source code in dashscope/applications/agentstudio/resources/session_events.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 | |
list
async
¶
list(
session_id: str,
*,
types: Optional[Sequence[str]] = None,
created_at_gt: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lt: Optional[str] = None,
created_at_lte: Optional[str] = None,
limit: Optional[int] = None,
order: Optional[str] = None,
page: Optional[str] = None
) -> AsyncCursorPage[ServerEvent]
Source code in dashscope/applications/agentstudio/resources/session_events.py
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | |
stream
async
¶
stream(
session_id: str,
*,
event_deltas: Optional[Sequence[str]] = None,
timeout: Optional[float] = None
) -> "_AioTypedEventStream"
Source code in dashscope/applications/agentstudio/resources/session_events.py
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 | |
SessionThreads
¶
SessionThreads(client)
Sub-agent threads within a session.
Source code in dashscope/applications/agentstudio/resources/session_threads.py
153 154 155 | |
list
¶
list(
session_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[SessionThread]
Source code in dashscope/applications/agentstudio/resources/session_threads.py
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 | |
retrieve
¶
retrieve(session_id: str, thread_id: str) -> SessionThread
Source code in dashscope/applications/agentstudio/resources/session_threads.py
181 182 183 184 185 186 | |
archive
¶
archive(session_id: str, thread_id: str) -> SessionThread
Source code in dashscope/applications/agentstudio/resources/session_threads.py
191 192 193 194 195 196 | |
AsyncSessionThreads
¶
AsyncSessionThreads(client)
Async sub-agent threads within a session.
Source code in dashscope/applications/agentstudio/resources/session_threads.py
202 203 204 | |
list
async
¶
list(
session_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[SessionThread]
Source code in dashscope/applications/agentstudio/resources/session_threads.py
206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 | |
retrieve
async
¶
retrieve(session_id: str, thread_id: str) -> SessionThread
Source code in dashscope/applications/agentstudio/resources/session_threads.py
231 232 233 234 235 236 237 238 239 240 | |
archive
async
¶
archive(session_id: str, thread_id: str) -> SessionThread
Source code in dashscope/applications/agentstudio/resources/session_threads.py
245 246 247 248 249 250 | |
SessionThreadEvents
¶
SessionThreadEvents(client)
Events scoped to a single sub-agent thread (list only).
Source code in dashscope/applications/agentstudio/resources/session_threads.py
36 37 | |
list
¶
list(
session_id: str,
thread_id: str,
*,
types: Optional[Sequence[str]] = None,
created_at_gt: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lt: Optional[str] = None,
created_at_lte: Optional[str] = None,
limit: Optional[int] = None,
order: Optional[str] = None,
page: Optional[str] = None
) -> CursorPage[ServerEvent]
Source code in dashscope/applications/agentstudio/resources/session_threads.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 | |
AsyncSessionThreadEvents
¶
AsyncSessionThreadEvents(client)
Async events scoped to a single sub-agent thread (list only).
Source code in dashscope/applications/agentstudio/resources/session_threads.py
94 95 | |
list
async
¶
list(
session_id: str,
thread_id: str,
*,
types: Optional[Sequence[str]] = None,
created_at_gt: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lt: Optional[str] = None,
created_at_lte: Optional[str] = None,
limit: Optional[int] = None,
order: Optional[str] = None,
page: Optional[str] = None
) -> AsyncCursorPage[ServerEvent]
Source code in dashscope/applications/agentstudio/resources/session_threads.py
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 | |
SessionResources
¶
SessionResources(client)
Runtime resource mount/unmount on a session.
Source code in dashscope/applications/agentstudio/resources/session_resources.py
36 37 | |
add
¶
add(
session_id: str,
*,
resource_type: str = "file",
file_id: str,
mount_path: Optional[str] = None
) -> SessionResource
Mount a file into a running session (POST /sessions/{id}/resources).
mount_path must be an absolute path under /uploads/. The
returned file_id is the session-scoped copy id and may differ
from the source file_id passed in.
Source code in dashscope/applications/agentstudio/resources/session_resources.py
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
retrieve
¶
retrieve(
session_id: str, resource_id: str
) -> SessionResource
Source code in dashscope/applications/agentstudio/resources/session_resources.py
65 66 67 68 69 70 71 72 73 74 | |
list
¶
list(
session_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[SessionResource]
Source code in dashscope/applications/agentstudio/resources/session_resources.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 | |
delete
¶
delete(session_id: str, resource_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/session_resources.py
103 104 105 106 107 108 109 110 111 112 | |
AsyncSessionResources
¶
AsyncSessionResources(client)
Async runtime resource mount/unmount on a session.
Source code in dashscope/applications/agentstudio/resources/session_resources.py
118 119 | |
add
async
¶
add(
session_id: str,
*,
resource_type: str = "file",
file_id: str,
mount_path: Optional[str] = None
) -> SessionResource
Source code in dashscope/applications/agentstudio/resources/session_resources.py
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | |
retrieve
async
¶
retrieve(
session_id: str, resource_id: str
) -> SessionResource
Source code in dashscope/applications/agentstudio/resources/session_resources.py
141 142 143 144 145 146 147 148 149 150 | |
list
async
¶
list(
session_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[SessionResource]
Source code in dashscope/applications/agentstudio/resources/session_resources.py
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
delete
async
¶
delete(session_id: str, resource_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/session_resources.py
180 181 182 183 184 185 186 187 188 189 | |
环境与部署¶
Environments
¶
Environments(client)
Environment CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/environments.py
34 35 | |
create
¶
create(
*,
name: str,
config: Mapping[str, Any],
description: Optional[str] = None,
scope: Optional[str] = "organization",
metadata: Optional[Mapping[str, Any]] = None,
extra_headers: Optional[Mapping[str, str]] = None
) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 | |
retrieve
¶
retrieve(environment_id: str) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
62 63 64 65 66 67 | |
update
¶
update(
environment_id: str,
*,
name: Optional[str] = None,
description: Optional[str] = None,
config: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 | |
list
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
include_archived: Optional[bool] = None
) -> CursorPage[Environment]
Source code in dashscope/applications/agentstudio/resources/environments.py
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 | |
archive
¶
archive(environment_id: str) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
122 123 124 125 126 127 | |
delete
¶
delete(environment_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/environments.py
129 130 131 132 133 134 | |
AsyncEnvironments
¶
AsyncEnvironments(client)
Async Environment CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/environments.py
140 141 | |
create
async
¶
create(
*,
name: str,
config: Mapping[str, Any],
description: Optional[str] = None,
scope: Optional[str] = "organization",
metadata: Optional[Mapping[str, Any]] = None,
extra_headers: Optional[Mapping[str, str]] = None
) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | |
retrieve
async
¶
retrieve(environment_id: str) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
168 169 170 171 172 173 | |
update
async
¶
update(
environment_id: str,
*,
name: Optional[str] = None,
description: Optional[str] = None,
config: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | |
list
async
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
include_archived: Optional[bool] = None
) -> AsyncCursorPage[Environment]
Source code in dashscope/applications/agentstudio/resources/environments.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 | |
archive
async
¶
archive(environment_id: str) -> Environment
Source code in dashscope/applications/agentstudio/resources/environments.py
233 234 235 236 237 238 | |
delete
async
¶
delete(environment_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/environments.py
240 241 242 243 244 245 | |
Deployments
¶
Deployments(client)
Managed Agent deployment lifecycle and execution.
Source code in dashscope/applications/agentstudio/resources/deployments.py
34 35 | |
create
¶
create(
*,
name: str,
agent: Any,
initial_events: Sequence[Mapping[str, Any]],
description: Optional[str] = None,
environment_id: Optional[str] = None,
schedule: Any = None,
resources: Optional[Sequence[Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
metadata: Optional[Mapping[str, str]] = None
) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 | |
retrieve
¶
retrieve(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
70 71 72 73 74 75 | |
update
¶
update(
deployment_id: str,
*,
name: Optional[str] = None,
description: Optional[str] = None,
agent: Any = None,
environment_id: Any = _NOT_GIVEN,
schedule: Any = _NOT_GIVEN,
initial_events: Optional[
Sequence[Mapping[str, Any]]
] = None,
resources: Optional[Sequence[Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
metadata: Optional[Mapping[str, str]] = None
) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
list
¶
list(
*,
agent_id: Optional[str] = None,
keyword: Optional[str] = None,
status: Optional[str] = None,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lte: Optional[str] = None
) -> CursorPage[Deployment]
Source code in dashscope/applications/agentstudio/resources/deployments.py
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | |
pause
¶
pause(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
156 157 | |
unpause
¶
unpause(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
159 160 | |
archive
¶
archive(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
162 163 | |
run
¶
run(deployment_id: str) -> DeploymentRun
Source code in dashscope/applications/agentstudio/resources/deployments.py
172 173 174 175 176 177 | |
list_runs
¶
list_runs(
deployment_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[DeploymentRun]
Source code in dashscope/applications/agentstudio/resources/deployments.py
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | |
AsyncDeployments
¶
AsyncDeployments(client)
Asynchronous Managed Agent deployment lifecycle and execution.
Source code in dashscope/applications/agentstudio/resources/deployments.py
242 243 | |
create
async
¶
create(
*,
name: str,
agent: Any,
initial_events: Sequence[Mapping[str, Any]],
description: Optional[str] = None,
environment_id: Optional[str] = None,
schedule: Any = None,
resources: Optional[Sequence[Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
metadata: Optional[Mapping[str, str]] = None
) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 | |
retrieve
async
¶
retrieve(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
278 279 280 281 282 283 | |
update
async
¶
update(
deployment_id: str,
*,
name: Optional[str] = None,
description: Optional[str] = None,
agent: Any = None,
environment_id: Any = _NOT_GIVEN,
schedule: Any = _NOT_GIVEN,
initial_events: Optional[
Sequence[Mapping[str, Any]]
] = None,
resources: Optional[Sequence[Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
metadata: Optional[Mapping[str, str]] = None
) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | |
list
async
¶
list(
*,
agent_id: Optional[str] = None,
keyword: Optional[str] = None,
status: Optional[str] = None,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lte: Optional[str] = None
) -> AsyncCursorPage[Deployment]
Source code in dashscope/applications/agentstudio/resources/deployments.py
321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 | |
pause
async
¶
pause(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
369 370 | |
unpause
async
¶
unpause(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
372 373 | |
archive
async
¶
archive(deployment_id: str) -> Deployment
Source code in dashscope/applications/agentstudio/resources/deployments.py
375 376 | |
run
async
¶
run(deployment_id: str) -> DeploymentRun
Source code in dashscope/applications/agentstudio/resources/deployments.py
389 390 391 392 393 394 | |
list_runs
async
¶
list_runs(
deployment_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[DeploymentRun]
Source code in dashscope/applications/agentstudio/resources/deployments.py
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | |
DeploymentRuns
¶
DeploymentRuns(client)
Workspace-wide deployment run history.
Source code in dashscope/applications/agentstudio/resources/deployments.py
207 208 | |
retrieve
¶
retrieve(deployment_run_id: str) -> DeploymentRun
Source code in dashscope/applications/agentstudio/resources/deployments.py
210 211 212 213 214 215 | |
list
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[DeploymentRun]
Source code in dashscope/applications/agentstudio/resources/deployments.py
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | |
AsyncDeploymentRuns
¶
AsyncDeploymentRuns(client)
Asynchronous workspace-wide deployment run history.
Source code in dashscope/applications/agentstudio/resources/deployments.py
429 430 | |
retrieve
async
¶
retrieve(deployment_run_id: str) -> DeploymentRun
Source code in dashscope/applications/agentstudio/resources/deployments.py
432 433 434 435 436 437 | |
list
async
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[DeploymentRun]
Source code in dashscope/applications/agentstudio/resources/deployments.py
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 | |
文件¶
Files
¶
Files(client)
File upload / download / list / delete.
Source code in dashscope/applications/agentstudio/resources/files.py
137 138 | |
upload
¶
upload(
file: Union[
str,
"os.PathLike[str]",
BinaryIO,
Tuple[str, BinaryIO],
],
*,
mime_type: Optional[str] = None,
progress: Optional[ProgressCallback] = None,
extra_headers: Optional[Mapping[str, str]] = None
) -> File
Source code in dashscope/applications/agentstudio/resources/files.py
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
retrieve
¶
retrieve(file_id: str) -> File
Source code in dashscope/applications/agentstudio/resources/files.py
180 181 182 183 184 185 | |
download
¶
download(
file_id: str, *, timeout: Optional[float] = None
) -> FileContent
Return the file content as a :class:FileContent.
Only files whose downloadable flag is true can be fetched; the
service answers 403 otherwise. Use :meth:FileContent.write_to_file
to persist the bytes to disk.
content = client.files.download("file_xxx")
content.write_to_file("output.txt")
Source code in dashscope/applications/agentstudio/resources/files.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | |
list
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
scope_id: Optional[str] = None
) -> CursorPage[File]
Source code in dashscope/applications/agentstudio/resources/files.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 | |
delete
¶
delete(file_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/files.py
255 256 257 258 259 260 | |
AsyncFiles
¶
AsyncFiles(client)
Async file upload / download / list / delete.
Source code in dashscope/applications/agentstudio/resources/files.py
266 267 | |
upload
async
¶
upload(
file: Union[
str,
"os.PathLike[str]",
BinaryIO,
Tuple[str, BinaryIO],
],
*,
mime_type: Optional[str] = None,
progress: Optional[ProgressCallback] = None,
extra_headers: Optional[Mapping[str, str]] = None
) -> File
Source code in dashscope/applications/agentstudio/resources/files.py
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 | |
retrieve
async
¶
retrieve(file_id: str) -> File
Source code in dashscope/applications/agentstudio/resources/files.py
309 310 311 312 313 314 | |
download
async
¶
download(
file_id: str, *, timeout: Optional[float] = None
) -> FileContent
Return the file content as a :class:FileContent.
Only files whose downloadable flag is true can be fetched; the
service answers 403 otherwise. Use :meth:FileContent.write_to_file
to persist the bytes to disk.
content = await client.files.download("file_xxx")
content.write_to_file("output.txt")
Source code in dashscope/applications/agentstudio/resources/files.py
329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | |
list
async
¶
list(
*,
limit: Optional[int] = None,
page: Optional[str] = None,
scope_id: Optional[str] = None
) -> AsyncCursorPage[File]
Source code in dashscope/applications/agentstudio/resources/files.py
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 | |
delete
async
¶
delete(file_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/files.py
384 385 386 387 388 389 | |
记忆¶
MemoryStores
¶
MemoryStores(client)
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
359 360 361 362 | |
create
¶
create(
*,
name: str,
description: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> MemoryStore
Create a memory store (POST /memory_stores).
description is passed to the agent so it knows what the
store contains — write it for the model, not for humans.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 | |
retrieve
¶
retrieve(store_id: str) -> MemoryStore
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
388 389 390 391 392 393 | |
update
¶
update(
store_id: str,
*,
name: Optional[str] = None,
description: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> MemoryStore
Update a store (POST /memory_stores/{store_id}).
Mutate name / description / metadata — at least one
must be given. metadata is replaced wholesale (unlike
CMA's merge-patch): keys not included in the request are
dropped; a key set to null deletes it.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 | |
list
¶
list(
*,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[MemoryStore]
List stores (GET /memory_stores).
The public API has no keyword filter (that is a
console-only capability).
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 | |
delete
¶
delete(store_id: str) -> DeleteResponse
Delete a store (DELETE /memory_stores/{id}).
Accepted immediately; items are removed asynchronously. The
response is a marker (type="memory_store_deleted").
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
462 463 464 465 466 467 468 469 470 471 472 | |
archive
¶
archive(store_id: str) -> MemoryStore
Archive a store (POST /memory_stores/{id}/archive).
Read-only afterwards: existing session attachments continue, new sessions cannot reference it. Irreversible.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
474 475 476 477 478 479 480 481 482 483 484 | |
AsyncMemoryStores
¶
AsyncMemoryStores(client)
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
687 688 689 690 | |
create
async
¶
create(
*,
name: str,
description: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> MemoryStore
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 | |
retrieve
async
¶
retrieve(store_id: str) -> MemoryStore
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
711 712 713 714 715 716 | |
update
async
¶
update(
store_id: str,
*,
name: Optional[str] = None,
description: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> MemoryStore
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 | |
list
async
¶
list(
*,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[MemoryStore]
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 | |
delete
async
¶
delete(store_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
778 779 780 781 782 783 | |
archive
async
¶
archive(store_id: str) -> MemoryStore
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
785 786 787 788 789 790 | |
Memories
¶
Memories(client)
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
120 121 | |
create
¶
create(store_id: str, *, path: str, content: str) -> Memory
Create a memory at path (POST .../memories).
A memory already existing at path returns 409
memory_path_conflict_error.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | |
list
¶
list(
store_id: str,
*,
path_prefix: Optional[str] = None,
depth: Optional[int] = None,
view: Optional[str] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[Memory]
List memories (GET .../memories).
path_prefix scopes the listing (server-validated: must
start and end with / — segment-aligned, so /notes/
matches /notes/a.md but not /notes_backup/old.md; a
bare "/" lists the whole store). File items land in
data; directory nodes come back as page.prefixes
(per page; merge across pages manually for a full tree).
view="full" includes content per item but caps
limit at 20 — the backend rejects higher values with
400 (CMA silently clamps); the default "basic" returns
metadata only with limit up to 100.
depth bounds the tree walk below path_prefix; the
backend implements 0/1 natively and larger values are derived
client-side (see _MAX_WIRE_DEPTH). With view="full" the
derivation still transfers the content of files the depth cut
discards — prefer view="basic" for deep walks.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | |
retrieve
¶
retrieve(store_id: str, memory_id: str) -> Memory
Retrieve a memory with content (GET .../memories/{id}).
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
203 204 205 206 207 208 209 210 211 212 213 | |
update
¶
update(
store_id: str,
memory_id: str,
*,
path: Optional[str] = None,
content: Optional[str] = None,
content_sha256: Optional[str] = None
) -> Memory
Update a memory (POST .../memories/{id}).
Mutate content, rename via path, or both — at least one
must be given. Pass the sha from the previously retrieved
memory as content_sha256 for optimistic concurrency; a
mismatch returns 409 memory_precondition_failed_error.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 | |
delete
¶
delete(store_id: str, memory_id: str) -> DeleteResponse
Delete a memory (DELETE .../memories/{id}).
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
250 251 252 253 254 255 256 257 258 259 260 | |
AsyncMemories
¶
AsyncMemories(client)
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
493 494 | |
create
async
¶
create(store_id: str, *, path: str, content: str) -> Memory
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
496 497 498 499 500 501 502 503 504 505 506 507 508 509 | |
list
async
¶
list(
store_id: str,
*,
path_prefix: Optional[str] = None,
depth: Optional[int] = None,
view: Optional[str] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[Memory]
Async variant of :meth:Memories.list (depth >= 2 is
emulated client-side the same way).
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 | |
retrieve
async
¶
retrieve(store_id: str, memory_id: str) -> Memory
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
559 560 561 562 563 564 565 566 567 568 | |
update
async
¶
update(
store_id: str,
memory_id: str,
*,
path: Optional[str] = None,
content: Optional[str] = None,
content_sha256: Optional[str] = None
) -> Memory
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 | |
delete
async
¶
delete(store_id: str, memory_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
598 599 600 601 602 603 604 605 606 607 | |
MemoryVersions
¶
MemoryVersions(client)
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
269 270 | |
list
¶
list(
store_id: str,
*,
memory_id: Optional[str] = None,
operation: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lte: Optional[str] = None,
view: Optional[str] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[MemoryVersion]
List versions, newest-first (GET .../memory_versions).
Filters: memory_id, operation (created / modified
/ deleted), created_at_gte / created_at_lte (ISO-8601
timestamps; sent on the wire as created_at.gte /
created_at.lte), and view (basic / full).
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | |
retrieve
¶
retrieve(store_id: str, version_id: str) -> MemoryVersion
Retrieve a version snapshot (GET .../memory_versions/{id}).
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
321 322 323 324 325 326 327 328 329 330 331 | |
redact
¶
redact(store_id: str, version_id: str) -> MemoryVersion
Redact a version (POST .../memory_versions/{id}/redact).
Scrubs path / content / content_sha256 /
content_size_bytes while preserving the audit trail
(created_at, ids). Idempotent and irreversible.
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 | |
AsyncMemoryVersions
¶
AsyncMemoryVersions(client)
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
611 612 | |
list
async
¶
list(
store_id: str,
*,
memory_id: Optional[str] = None,
operation: Optional[str] = None,
created_at_gte: Optional[str] = None,
created_at_lte: Optional[str] = None,
view: Optional[str] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[MemoryVersion]
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 | |
retrieve
async
¶
retrieve(store_id: str, version_id: str) -> MemoryVersion
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
661 662 663 664 665 666 667 668 669 670 | |
redact
async
¶
redact(store_id: str, version_id: str) -> MemoryVersion
Source code in dashscope/applications/agentstudio/resources/memory_stores.py
674 675 676 677 678 679 680 681 682 683 | |
技能¶
Skills
¶
Skills(client)
Skill CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/skills.py
40 41 42 | |
create
¶
create(
*,
file_id: Optional[str] = None,
file: Optional[FileSource] = None,
mime_type: Optional[str] = None
) -> Skill
Source code in dashscope/applications/agentstudio/resources/skills.py
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
retrieve
¶
retrieve(skill_id: str) -> Skill
Source code in dashscope/applications/agentstudio/resources/skills.py
61 62 63 64 65 66 | |
list
¶
list(
*,
source: Optional[str] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[Skill]
Source code in dashscope/applications/agentstudio/resources/skills.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 | |
delete
¶
delete(skill_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/skills.py
102 103 104 105 106 107 | |
AsyncSkills
¶
AsyncSkills(client)
Async Skill CRUD — instance methods backed by a shared client.
Source code in dashscope/applications/agentstudio/resources/skills.py
183 184 185 | |
create
async
¶
create(
*,
file_id: Optional[str] = None,
file: Optional[FileSource] = None,
mime_type: Optional[str] = None
) -> Skill
Source code in dashscope/applications/agentstudio/resources/skills.py
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 | |
retrieve
async
¶
retrieve(skill_id: str) -> Skill
Source code in dashscope/applications/agentstudio/resources/skills.py
208 209 210 211 212 213 | |
list
async
¶
list(
*,
source: Optional[str] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[Skill]
Source code in dashscope/applications/agentstudio/resources/skills.py
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | |
delete
async
¶
delete(skill_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/skills.py
254 255 256 257 258 259 | |
SkillVersions
¶
SkillVersions(client)
Skill version sub-resource.
Source code in dashscope/applications/agentstudio/resources/skills.py
113 114 | |
create
¶
create(
skill_id: str,
*,
file_id: Optional[str] = None,
file: Optional[FileSource] = None,
mime_type: Optional[str] = None
) -> SkillVersion
Source code in dashscope/applications/agentstudio/resources/skills.py
116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 | |
list
¶
list(
skill_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[SkillVersion]
Source code in dashscope/applications/agentstudio/resources/skills.py
138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 | |
retrieve
¶
retrieve(skill_id: str, version: str) -> SkillVersion
Source code in dashscope/applications/agentstudio/resources/skills.py
162 163 164 165 166 167 | |
download
¶
download(skill_id: str, version: str) -> Dict[str, Any]
Source code in dashscope/applications/agentstudio/resources/skills.py
172 173 174 175 176 177 | |
AsyncSkillVersions
¶
AsyncSkillVersions(client)
Async skill version sub-resource.
Source code in dashscope/applications/agentstudio/resources/skills.py
265 266 | |
create
async
¶
create(
skill_id: str,
*,
file_id: Optional[str] = None,
file: Optional[FileSource] = None,
mime_type: Optional[str] = None
) -> SkillVersion
Source code in dashscope/applications/agentstudio/resources/skills.py
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 | |
list
async
¶
list(
skill_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[SkillVersion]
Source code in dashscope/applications/agentstudio/resources/skills.py
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 | |
retrieve
async
¶
retrieve(skill_id: str, version: str) -> SkillVersion
Source code in dashscope/applications/agentstudio/resources/skills.py
319 320 321 322 323 324 | |
download
async
¶
download(skill_id: str, version: str) -> Dict[str, Any]
Source code in dashscope/applications/agentstudio/resources/skills.py
329 330 331 332 333 334 | |
密钥库与凭证¶
Vaults
¶
Vaults(client)
Source code in dashscope/applications/agentstudio/resources/vaults.py
159 160 161 | |
create
¶
create(
*,
display_name: str,
metadata: Optional[Mapping[str, Any]] = None
) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
retrieve
¶
retrieve(vault_id: str) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
180 181 182 183 184 185 | |
update
¶
update(
vault_id: str,
*,
display_name: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 | |
list
¶
list(
*,
keyword: Optional[str] = None,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[Vault]
Source code in dashscope/applications/agentstudio/resources/vaults.py
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | |
delete
¶
delete(vault_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/vaults.py
238 239 240 241 242 243 | |
archive
¶
archive(vault_id: str) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
245 246 247 248 249 250 | |
AsyncVaults
¶
AsyncVaults(client)
Source code in dashscope/applications/agentstudio/resources/vaults.py
378 379 380 | |
create
async
¶
create(
*,
display_name: str,
metadata: Optional[Mapping[str, Any]] = None
) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 | |
retrieve
async
¶
retrieve(vault_id: str) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
399 400 401 402 403 404 | |
update
async
¶
update(
vault_id: str,
*,
display_name: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 | |
list
async
¶
list(
*,
keyword: Optional[str] = None,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[Vault]
Source code in dashscope/applications/agentstudio/resources/vaults.py
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 | |
delete
async
¶
delete(vault_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/vaults.py
464 465 466 467 468 469 | |
archive
async
¶
archive(vault_id: str) -> Vault
Source code in dashscope/applications/agentstudio/resources/vaults.py
471 472 473 474 475 476 | |
Credentials
¶
Credentials(client)
Source code in dashscope/applications/agentstudio/resources/vaults.py
42 43 | |
create
¶
create(
vault_id: str,
*,
auth: Any,
display_name: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
retrieve
¶
retrieve(vault_id: str, credential_id: str) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
65 66 67 68 69 70 71 72 73 74 | |
update
¶
update(
vault_id: str,
credential_id: str,
*,
auth: Any = None,
display_name: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 | |
list
¶
list(
vault_id: str,
*,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[Credential]
Source code in dashscope/applications/agentstudio/resources/vaults.py
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
delete
¶
delete(vault_id: str, credential_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/vaults.py
129 130 131 132 133 134 135 136 137 138 | |
archive
¶
archive(vault_id: str, credential_id: str) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
140 141 142 143 144 145 146 147 148 149 150 | |
AsyncCredentials
¶
AsyncCredentials(client)
Source code in dashscope/applications/agentstudio/resources/vaults.py
259 260 | |
create
async
¶
create(
vault_id: str,
*,
auth: Any,
display_name: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | |
retrieve
async
¶
retrieve(vault_id: str, credential_id: str) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
282 283 284 285 286 287 288 289 290 291 | |
update
async
¶
update(
vault_id: str,
credential_id: str,
*,
auth: Any = None,
display_name: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 | |
list
async
¶
list(
vault_id: str,
*,
include_archived: Optional[bool] = None,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[Credential]
Source code in dashscope/applications/agentstudio/resources/vaults.py
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 | |
delete
async
¶
delete(vault_id: str, credential_id: str) -> DeleteResponse
Source code in dashscope/applications/agentstudio/resources/vaults.py
353 354 355 356 357 358 359 360 361 362 | |
archive
async
¶
archive(vault_id: str, credential_id: str) -> Credential
Source code in dashscope/applications/agentstudio/resources/vaults.py
364 365 366 367 368 369 370 371 372 373 374 | |
安全与 Webhook¶
Security
¶
Security(client)
Security center read interface (overview + agent logs).
Source code in dashscope/applications/agentstudio/resources/security.py
38 39 | |
overview
¶
overview() -> SecurityOverview
24h protection dashboard (GET /security/overview).
Source code in dashscope/applications/agentstudio/resources/security.py
41 42 43 44 45 46 47 | |
list_agent_logs
¶
list_agent_logs(
*,
current_page: Optional[int] = None,
page_size: Optional[int] = None,
risk_level: Optional[str] = None,
status: Optional[str] = None,
risk_name: Optional[str] = None,
app_name: Optional[str] = None,
asset_type: Optional[str] = None,
vendor: Optional[str] = None,
order_by: Optional[str] = None,
order: Optional[str] = None,
lang: Optional[str] = None,
status_list: Optional[Sequence[str]] = None
) -> SecurityAlertList
Alert list (GET /security/agent_logs).
Page-number pagination: pass current_page + 1 for the next
page, or use the returned next_page cursor if non-null.
check_time / handle_time on rows are millisecond strings.
Source code in dashscope/applications/agentstudio/resources/security.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | |
AsyncSecurity
¶
AsyncSecurity(client)
Async security center read interface.
Source code in dashscope/applications/agentstudio/resources/security.py
96 97 | |
overview
async
¶
overview() -> SecurityOverview
Source code in dashscope/applications/agentstudio/resources/security.py
99 100 101 102 103 104 | |
list_agent_logs
async
¶
list_agent_logs(
*,
current_page: Optional[int] = None,
page_size: Optional[int] = None,
risk_level: Optional[str] = None,
status: Optional[str] = None,
risk_name: Optional[str] = None,
app_name: Optional[str] = None,
asset_type: Optional[str] = None,
vendor: Optional[str] = None,
order_by: Optional[str] = None,
order: Optional[str] = None,
lang: Optional[str] = None,
status_list: Optional[Sequence[str]] = None
) -> SecurityAlertList
Source code in dashscope/applications/agentstudio/resources/security.py
106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 | |
WebhookEndpoints
¶
WebhookEndpoints(client)
Synchronous Managed Agent webhook endpoint APIs.
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
39 40 | |
create
¶
create(
*,
url: str,
events: Sequence[str],
description: Optional[str] = None
) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | |
retrieve
¶
retrieve(webhook_id: str) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
61 62 63 64 65 66 | |
list
¶
list() -> WebhookEndpointList
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
70 71 72 73 74 75 | |
update
¶
update(
webhook_id: str,
*,
description: Optional[str] = None,
url: Optional[str] = None,
events: Optional[Sequence[str]] = None
) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 | |
delete
¶
delete(webhook_id: str) -> Dict[str, Any]
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
97 98 99 100 101 102 | |
enable
¶
enable(webhook_id: str) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
104 105 106 107 108 109 | |
disable
¶
disable(webhook_id: str) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
111 112 113 114 115 116 | |
test
¶
test(webhook_id: str) -> WebhookEvent
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
118 119 120 121 122 123 | |
reset_secret
¶
reset_secret(webhook_id: str) -> WebhookSecretReset
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
125 126 127 128 129 130 | |
list_events
¶
list_events(
webhook_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> CursorPage[WebhookEvent]
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 | |
AsyncWebhookEndpoints
¶
AsyncWebhookEndpoints(client)
Asynchronous Managed Agent webhook endpoint APIs.
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
160 161 | |
create
async
¶
create(
*,
url: str,
events: Sequence[str],
description: Optional[str] = None
) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 | |
retrieve
async
¶
retrieve(webhook_id: str) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
182 183 184 185 186 187 | |
list
async
¶
list() -> WebhookEndpointList
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
191 192 193 194 195 196 | |
update
async
¶
update(
webhook_id: str,
*,
description: Optional[str] = None,
url: Optional[str] = None,
events: Optional[Sequence[str]] = None
) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | |
delete
async
¶
delete(webhook_id: str) -> Dict[str, Any]
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
218 219 220 221 222 223 | |
enable
async
¶
enable(webhook_id: str) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
225 226 227 228 229 230 | |
disable
async
¶
disable(webhook_id: str) -> WebhookEndpoint
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
232 233 234 235 236 237 | |
test
async
¶
test(webhook_id: str) -> WebhookEvent
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
239 240 241 242 243 244 | |
reset_secret
async
¶
reset_secret(webhook_id: str) -> WebhookSecretReset
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
246 247 248 249 250 251 | |
list_events
async
¶
list_events(
webhook_id: str,
*,
limit: Optional[int] = None,
page: Optional[str] = None
) -> AsyncCursorPage[WebhookEvent]
Source code in dashscope/applications/agentstudio/resources/webhook_endpoints.py
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 | |
客户端事件辅助函数¶
user_message
¶
user_message(
text_or_blocks: Any,
*,
session_thread_id: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Dict[str, Any]
Build a message client event (AGENTSTUDIO wire format).
text_or_blocks may be a plain string (wrapped as a text block)
or a list of pre-built content block dicts.
Source code in dashscope/applications/agentstudio/types/models.py
1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 | |
user_interrupt
¶
user_interrupt(
*,
session_thread_id: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
) -> Dict[str, Any]
Cancel the agent's current turn (best-effort).
Source code in dashscope/applications/agentstudio/types/models.py
1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 | |
user_tool_result
¶
user_tool_result(
*,
tool_use_id: str,
content: Any,
is_error: bool = False,
session_thread_id: Optional[str] = None
) -> Dict[str, Any]
Self-hosted tool result (advanced; mirrors built-in tool execution).
Emits a tool_call_output event in the AGENTSTUDIO wire format.
Source code in dashscope/applications/agentstudio/types/models.py
1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 | |
user_custom_tool_result
¶
user_custom_tool_result(
*,
custom_tool_use_id: str,
content: Any,
is_error: bool = False,
session_thread_id: Optional[str] = None
) -> Dict[str, Any]
Reply to an :class:AgentCustomToolUseEvent with a tool result.
Emits a function_call_output event in the AGENTSTUDIO wire format.
Source code in dashscope/applications/agentstudio/types/models.py
1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 | |
user_tool_approval_response
¶
user_tool_approval_response(
*,
batch_id: str,
call_id: str,
result: str,
deny_message: Optional[str] = None
) -> Dict[str, Any]
Submit a tool approval ruling for an always_ask tool call.
result must be "allow" or "deny"; deny_message is
optional and only meaningful when denying. The approval identity is the
(batch_id, call_id) composite key — call_id may be reused across
turns, so never match on call_id alone. Approval responses target
the primary thread only (no session_thread_id); the legacy
tool_confirmation type is rejected by the server (HTTP 400
bma_invalid_event).
Source code in dashscope/applications/agentstudio/types/models.py
1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 | |
user_define_outcome
¶
user_define_outcome(
*,
description: str,
rubric: Optional[str] = None,
max_iterations: Optional[int] = None,
session_thread_id: Optional[str] = None
) -> Dict[str, Any]
Steer the agent towards a measurable outcome.
Source code in dashscope/applications/agentstudio/types/models.py
1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 | |
核心类型¶
Message
¶
Message(**kwargs: Any)
Bases: BaseModel
Unified event/message model corresponding to the AgentStudio API protocol Message structure.
All SSE stream events and history events share this structure.
The type field discriminates between event kinds::
message, tool_call, tool_call_output, function_call,
function_call_output, mcp_call, mcp_call_output, reasoning,
session_status, error, session_updated, thread_created,
thread_status, thread_message_sent, thread_message_received,
thread_context_compacted, model_request_start, model_request_end,
outcome_evaluation, interrupt, tool_confirmation, define_outcome
Legacy agent.* / session.* / span.* type strings are also
accepted transparently for backward compatibility.
Source code in dashscope/applications/agentstudio/types/models.py
1062 1063 1064 1065 1066 | |
stop_reason
property
¶
stop_reason: Optional[Dict[str, Any]]
stop_reason carried by session_status idle events.
The server puts stop_reason inside the session_status event's
data block (not in session.retrieve()). Returns a dict like
{"type": "end_turn"} or None for non-session_status events.
session_status
property
¶
session_status: Optional[str]
session_status value from session_status events.
Returns "idle", "running", "rescheduled",
"terminated", "deleted" or None for non-session_status
events.
tool_approval_request
property
¶
tool_approval_request: Optional[Dict[str, Any]]
tool_approval_request payload: batch_id / call_id /
name / arguments (JSON string) / tool_type /
server_label (MCP only).
Returns None for non-tool_approval_request events. The
approval identity is the (batch_id, call_id) composite key —
call_id may be reused across turns, so never match on
call_id alone.
error
property
¶
error: Optional[Dict[str, Any]]
{"code", "message"} from type: error events, else None.
Approval failures surface in the event stream as type: error
events (not as HTTP exceptions). Use :attr:pending_tool_approvals
to read the suspend signal alongside this.
pending_tool_approvals
property
¶
pending_tool_approvals: Optional[Dict[str, Any]]
Suspend signal {"batch_id", "call_ids"} carried in the
metadata of an error / response frame while the approval
barrier is up. None when the barrier is not up.
This is the reliable way to tell pending state — do NOT derive it from request/response event diffs (the server emits it only while the barrier stands).
event_start
property
¶
event_start: Optional[Dict[str, Any]]
{"id", "type"} from an event_start delta frame (a preview
of an upcoming message/reasoning event; carries no content).
None for other frames.
event_delta
property
¶
event_delta: Optional[Dict[str, Any]]
{"event_id", "delta": {"type", "index", "content"}} from an
event_delta frame. None for other frames.
delta_text
property
¶
delta_text: Optional[str]
Incremental text chunk from an event_delta frame (the
delta.content.text of a content_delta), else None.
Use the :attr:text_deltas iterator on the stream for the full
sequence.
data
property
¶
data: Optional[Dict[str, Any]]
The first content block's data payload, for events that carry
one (tool_call / tool_call_output / mcp_call /
mcp_call_output / session_status / tool_approval_request
/ model_request_end / outcome_evaluation / thread_status
/ thread_created / session_updated). None otherwise.
outcome_evaluation
property
¶
outcome_evaluation: Optional[Dict[str, Any]]
outcome_evaluation payload: outcome_id, iteration,
phase (start/ongoing/end), result, explanation,
token usage, speed. None for other events.
thread_status
property
¶
thread_status: Optional[Dict[str, Any]]
thread_status payload: session_thread_id, agent_name,
thread_status (running/idle/terminated/rescheduled), and
stop_reason when idle. None for other events.
thread_created
property
¶
thread_created: Optional[Dict[str, Any]]
thread_created payload: session_thread_id, agent_name.
None for other events.
session_updated
property
¶
session_updated: Optional[Dict[str, Any]]
session_updated payload: title, session_metadata,
agent (only the changed fields, present when changed).
None for other events.
thread_message_routing
property
¶
thread_message_routing: Optional[Dict[str, str]]
Sub-agent routing from thread_message_sent / thread_message_received
metadata: to_session_thread_id / to_agent_name on sent,
from_session_thread_id / from_agent_name on received.
None for other events.
SessionResource
¶
SessionResource(**kwargs: Any)
Bases: BaseModel
A resource mounted into a session (file / memory_store / oss).
file: file_id is the session-scoped copy id (not the source
file id); mount_path resolves under /uploads/. Memory and
OSS mounts are create-only — sessions.resources.add accepts
files only.
memory_store: access (read_write default) and
instructions; name/description are server-snapshotted
for built-in (provider="default") mounts, which also carry the
server-generated mount_path (/mnt/memory/<name>);
agentstudio_memory (Bailian) mounts echo entity_id and the
configured project_ids/profile_schema/description, with
no mount_path.
oss: echoes region/bucket/oss_path and the
user-supplied logical mount_path (the sandbox resolves it under
/mnt/oss/).
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
StopReason
¶
StopReason(**kwargs: Any)
Bases: BaseModel
Carried by session_status idle events (and Session.stop_reason).
A running Session's stop_reason is null. requires_action
carries pending_batch_id + pending_call_ids (only the calls not
yet adjudicated); do not derive pending from request/response diffs.
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
Memory
¶
Memory(**kwargs: Any)
Bases: BaseModel
One text document inside a memory store, addressed by path.
content appears only in retrieve responses and in list
responses with view="full"; create and update never return it.
content_sha256 identifies the content revision — pass it back
to memories.update for optimistic concurrency (a mismatch
returns 409 memory_precondition_failed_error).
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
MemoryStore
¶
MemoryStore(**kwargs: Any)
Bases: BaseModel
A workspace-scoped store of small text documents.
Stores persist across sessions and are mounted into a session
container at /mnt/memory/<name>/ when attached via the session
resources[] array. archived_at is set once the store is
archived: read-only afterwards, existing session attachments keep
working, but new sessions cannot reference it.
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
MemoryVersion
¶
MemoryVersion(**kwargs: Any)
Bases: BaseModel
Immutable snapshot produced by every memory mutation; versions are returned newest-first.
operation is created / modified / deleted. After
redact, path, content, content_sha256 and
content_size_bytes are cleared; the audit trail is preserved.
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
PermissionPolicy
¶
PermissionPolicy(**kwargs: Any)
Bases: BaseModel
Tool approval policy (permission_policy on tool configs).
Must be the object form {"type": "always_allow" | "always_ask"};
the string form is rejected (the server rejects it as well). Defaults
to always_allow when omitted.
Source code in dashscope/applications/agentstudio/types/models.py
242 243 244 245 246 247 248 249 250 251 | |
SecurityAlert
¶
SecurityAlert(**kwargs: Any)
Bases: BaseModel
A single security alert row. check_time / handle_time are
millisecond-string timestamps (not ISO 8601).
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
SecurityAlertList
¶
SecurityAlertList(**kwargs: Any)
Bases: BaseModel
Response of GET /security/agent_logs (page-number + cursor).
Source code in dashscope/applications/agentstudio/types/models.py
795 796 797 798 799 800 801 802 803 804 805 | |
SecurityOverview
¶
SecurityOverview(**kwargs: Any)
Bases: BaseModel
Response of GET /security/overview (last-24h dashboard).
Source code in dashscope/applications/agentstudio/types/models.py
745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 | |
请求参数类型¶
AgentCreateParams
¶
AgentCreateParams(
*,
name: str,
model: Union[str, ModelConfig],
description: Optional[str] = None,
system_prompt: Optional[str] = None,
tools: Optional[Sequence[Mapping[str, Any]]] = None,
mcp_servers: Optional[
Sequence[Mapping[str, Any]]
] = None,
skills: Optional[Sequence[Mapping[str, Any]]] = None,
multiagent: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
)
Bases: BaseModel
Request body for POST /agents.
Maps to :meth:Agents.create. The SDK method exposes model as a
:class:ModelConfig or a bare model id, and system_prompt as a
keyword arg; the wire format uses model: {"id": "…", …} and
system.
Source code in dashscope/applications/agentstudio/types/params.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | |
AgentUpdateParams
¶
AgentUpdateParams(
*,
version: int,
name: Optional[str] = None,
model: Optional[Union[str, ModelConfig]] = None,
description: Optional[str] = None,
system_prompt: Optional[str] = None,
tools: Optional[Sequence[Mapping[str, Any]]] = None,
mcp_servers: Optional[
Sequence[Mapping[str, Any]]
] = None,
skills: Optional[Sequence[Mapping[str, Any]]] = None,
multiagent: Optional[Mapping[str, Any]] = None,
metadata: Optional[Mapping[str, Any]] = None
)
Bases: BaseModel
Request body for POST /agents/{id} (update latest version).
Source code in dashscope/applications/agentstudio/types/params.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 | |
SessionCreateParams
¶
SessionCreateParams(
*,
agent: Any,
environment_id: Optional[str] = None,
title: Optional[str] = None,
resources: Optional[Sequence[ResourceInput]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
mcp_configs: Optional[
Sequence[Mapping[str, Any]]
] = None,
metadata: Optional[Mapping[str, Any]] = None
)
Bases: BaseModel
Request body for POST /sessions.
agent accepts the Agent ID string (backward compatible) or an
Agent reference/override object (a mapping with
type="agent_with_overrides") that establishes Session-level
overrides for system/tools/mcp_servers/skills.
environment_variables and mcp_configs are Session-level
settings independent of the agent. resources is create-only — it
cannot be modified via updateSession; each item is a mapping or
a :class:~dashscope.applications.agentstudio.types.models.Mount
(file / memory_store — built-in or Bailian
provider="agentstudio_memory" — / oss).
Source code in dashscope/applications/agentstudio/types/params.py
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 | |
SessionUpdateParams
¶
SessionUpdateParams(
*,
title: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
agent: Any = None,
mcp_configs: Optional[
Sequence[Mapping[str, Any]]
] = None
)
Bases: BaseModel
Request body for POST /sessions/{id}.
Omitted (None) fields are not sent — the existing value is kept;
[] / {} explicitly clear the value. agent is a Session-level
Agent config patch (a plain mapping carrying only system/tools/
mcp_servers/skills); the mapping is passed through verbatim so
an explicit None sub-field serializes to JSON null (delete the
override and re-inherit), an omitted sub-field stays absent (keep the
override), and [] / "" override to empty. The server enforces
the override principle; the SDK does not read or merge the agent source.
Source code in dashscope/applications/agentstudio/types/params.py
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 | |
SessionEventSendParams
¶
SessionEventSendParams(
*, input: Sequence[Mapping[str, Any]]
)
Bases: BaseModel
Request body for POST /sessions/{id}/events.
The input array must contain at least one event.
Source code in dashscope/applications/agentstudio/types/params.py
459 460 461 462 463 464 465 466 467 468 | |
EnvironmentCreateParams
¶
EnvironmentCreateParams(
*,
name: str,
config: Mapping[str, Any],
description: Optional[str] = None,
scope: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
)
Bases: BaseModel
Request body for POST /environments.
Source code in dashscope/applications/agentstudio/types/params.py
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 | |
EnvironmentUpdateParams
¶
EnvironmentUpdateParams(
*,
name: Optional[str] = None,
description: Optional[str] = None,
config: Optional[Mapping[str, Any]] = None,
scope: Optional[str] = None,
metadata: Optional[Mapping[str, Any]] = None
)
Bases: BaseModel
Request body for POST /environments/{id}.
Source code in dashscope/applications/agentstudio/types/params.py
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 | |
DeploymentCreateParams
¶
DeploymentCreateParams(
*,
name: str,
agent: Any,
initial_events: Sequence[Mapping[str, Any]],
description: Optional[str] = None,
environment_id: Optional[str] = None,
schedule: Any = None,
resources: Optional[Sequence[Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
metadata: Optional[Mapping[str, str]] = None
)
Bases: BaseModel
Request body for POST /deployments.
Source code in dashscope/applications/agentstudio/types/params.py
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 | |
DeploymentUpdateParams
¶
DeploymentUpdateParams(
*,
name: Optional[str] = None,
description: Optional[str] = None,
agent: Any = None,
environment_id: Any = _NOT_GIVEN,
schedule: Any = _NOT_GIVEN,
initial_events: Optional[
Sequence[Mapping[str, Any]]
] = None,
resources: Optional[Sequence[Any]] = None,
vault_ids: Optional[Sequence[str]] = None,
environment_variables: Optional[
Mapping[str, str]
] = None,
metadata: Optional[Mapping[str, str]] = None
)
Bases: BaseModel
Request body for POST /deployments/{deployment_id}.
environment_id and schedule preserve the distinction between an
omitted argument and an explicit None. Explicit None is emitted as
JSON null to clear the field.
Source code in dashscope/applications/agentstudio/types/params.py
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 | |
to_dict
¶
to_dict() -> dict
Source code in dashscope/applications/agentstudio/types/params.py
738 739 740 741 742 743 744 | |
WebhookEndpointCreateParams
¶
WebhookEndpointCreateParams(**kwargs: Any)
Bases: BaseModel
Request body for POST /webhook_endpoints.
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
WebhookEndpointUpdateParams
¶
WebhookEndpointUpdateParams(**kwargs: Any)
Bases: BaseModel
Request body for PUT /webhook_endpoints/{id}.
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
WebhookEventListParams
¶
WebhookEventListParams(**kwargs: Any)
Bases: BaseModel
Query parameters for endpoint-specific webhook events.
Source code in dashscope/applications/agentstudio/types/models.py
53 54 55 56 57 58 59 | |
常量与枚举¶
SessionStatus
¶
Bases: StrEnum
Session run-status values (session_status).
Top-level Session.status ∈ {idle, running, terminated, rescheduled};
the session_status event data.session_status value set is the
same plus deleted (a delete returns a tombstone, not a Session with
status=deleted). idle also covers waiting for tool approval,
signalled by stop_reason.type=requires_action.
SSEEventType
¶
Bases: StrEnum
Server-sent event types (the value of event.type in SSE payloads).
Client-sendable: MESSAGE, INTERRUPT, TOOL_APPROVAL_RESPONSE, FUNCTION_CALL_OUTPUT, TOOL_CALL_OUTPUT, DEFINE_OUTCOME. Server-emitted: all types (23 total).
TOOL_APPROVAL_RESPONSE
class-attribute
instance-attribute
¶
TOOL_APPROVAL_RESPONSE = 'tool_approval_response'
FUNCTION_CALL_OUTPUT
class-attribute
instance-attribute
¶
FUNCTION_CALL_OUTPUT = 'function_call_output'
TOOL_APPROVAL_REQUEST
class-attribute
instance-attribute
¶
TOOL_APPROVAL_REQUEST = 'tool_approval_request'
THREAD_MESSAGE_SENT
class-attribute
instance-attribute
¶
THREAD_MESSAGE_SENT = 'thread_message_sent'
THREAD_MESSAGE_RECEIVED
class-attribute
instance-attribute
¶
THREAD_MESSAGE_RECEIVED = 'thread_message_received'
THREAD_CONTEXT_COMPACTED
class-attribute
instance-attribute
¶
THREAD_CONTEXT_COMPACTED = 'thread_context_compacted'
MODEL_REQUEST_START
class-attribute
instance-attribute
¶
MODEL_REQUEST_START = 'model_request_start'
StopReasonType
¶
Bases: StrEnum
stop_reason.type carried by session_status idle events.
Only idle carries stop_reason; a running Session's
stop_reason is null.
PermissionPolicyType
¶
Bases: StrEnum
Tool approval policy (permission_policy.type).
always_allow (default) executes the tool without asking;
always_ask produces a tool_approval_request per call.
Subagent/subthread always_ask degrades to always_allow.
WebhookStatus
¶
WebhookEventType
¶
Bases: StrEnum
Event types accepted by webhook endpoint subscriptions.
SESSION_STATUS_RUN_STARTED
class-attribute
instance-attribute
¶
SESSION_STATUS_RUN_STARTED = 'session.status_run_started'
SESSION_STATUS_IDLED
class-attribute
instance-attribute
¶
SESSION_STATUS_IDLED = 'session.status_idled'
SESSION_STATUS_TERMINATED
class-attribute
instance-attribute
¶
SESSION_STATUS_TERMINATED = 'session.status_terminated'
SESSION_THREAD_CREATED
class-attribute
instance-attribute
¶
SESSION_THREAD_CREATED = 'session.thread_created'
SESSION_THREAD_RUN_STARTED
class-attribute
instance-attribute
¶
SESSION_THREAD_RUN_STARTED = 'session.thread_run_started'
SESSION_THREAD_IDLED
class-attribute
instance-attribute
¶
SESSION_THREAD_IDLED = 'session.thread_idled'
SESSION_THREAD_TERMINATED
class-attribute
instance-attribute
¶
SESSION_THREAD_TERMINATED = 'session.thread_terminated'
DEPLOYMENT_ARCHIVED
class-attribute
instance-attribute
¶
DEPLOYMENT_ARCHIVED = 'deployment.archived'
DEPLOYMENT_UNPAUSED
class-attribute
instance-attribute
¶
DEPLOYMENT_UNPAUSED = 'deployment.unpaused'
DEPLOYMENT_RUN_STARTED
class-attribute
instance-attribute
¶
DEPLOYMENT_RUN_STARTED = 'deployment_run.started'
DEPLOYMENT_RUN_FAILED
class-attribute
instance-attribute
¶
DEPLOYMENT_RUN_FAILED = 'deployment_run.failed'
DEPLOYMENT_RUN_SUCCEEDED
class-attribute
instance-attribute
¶
DEPLOYMENT_RUN_SUCCEEDED = 'deployment_run.succeeded'
ENVIRONMENT_CREATED
class-attribute
instance-attribute
¶
ENVIRONMENT_CREATED = 'environment.created'
ENVIRONMENT_UPDATED
class-attribute
instance-attribute
¶
ENVIRONMENT_UPDATED = 'environment.updated'
ENVIRONMENT_ARCHIVED
class-attribute
instance-attribute
¶
ENVIRONMENT_ARCHIVED = 'environment.archived'
ENVIRONMENT_DELETED
class-attribute
instance-attribute
¶
ENVIRONMENT_DELETED = 'environment.deleted'
VAULT_CREDENTIAL_CREATED
class-attribute
instance-attribute
¶
VAULT_CREDENTIAL_CREATED = 'vault_credential.created'
VAULT_CREDENTIAL_ARCHIVED
class-attribute
instance-attribute
¶
VAULT_CREDENTIAL_ARCHIVED = 'vault_credential.archived'
VAULT_CREDENTIAL_DELETED
class-attribute
instance-attribute
¶
VAULT_CREDENTIAL_DELETED = 'vault_credential.deleted'
WebhookDeliveryStatus
¶
Bases: StrEnum
Webhook delivery status.
WebhookDisabledReason
¶
Bases: StrEnum
Reason why a webhook endpoint was disabled.
CONSECUTIVE_DELIVERY_FAILURES
class-attribute
instance-attribute
¶
CONSECUTIVE_DELIVERY_FAILURES = (
"CONSECUTIVE_DELIVERY_FAILURES"
)
SSRF_VALIDATION_FAILED
class-attribute
instance-attribute
¶
SSRF_VALIDATION_FAILED = 'SSRF_VALIDATION_FAILED'
TLS_VALIDATION_FAILED
class-attribute
instance-attribute
¶
TLS_VALIDATION_FAILED = 'TLS_VALIDATION_FAILED'
分页、传输与异常¶
CursorPage
¶
CursorPage(
*,
data: List[T],
next_page: Optional[str],
request_id: Optional[str],
fetch_next: Optional[
Callable[[str], "CursorPage[T]"]
] = None,
extra: Optional[Dict[str, Any]] = None
)
Bases: Generic[T]
Synchronous page over an opaque page cursor.
extra preserves any additional top-level fields the list
envelope carried beyond data / next_page (forward
compatibility when the server adds fields); extra is per page
and does not participate in auto-pagination.
Source code in dashscope/applications/agentstudio/pagination.py
36 37 38 39 40 41 42 43 44 45 46 47 48 49 | |
has_next
¶
has_next() -> bool
Source code in dashscope/applications/agentstudio/pagination.py
51 52 | |
get_next
¶
get_next() -> Optional['CursorPage[T]']
Source code in dashscope/applications/agentstudio/pagination.py
54 55 56 57 58 | |
AsyncCursorPage
¶
AsyncCursorPage(
*,
data: List[T],
next_page: Optional[str],
request_id: Optional[str],
fetch_next: Optional[
Callable[[str], "AsyncCursorPage[T]"]
] = None,
extra: Optional[Dict[str, Any]] = None
)
Bases: Generic[T]
Asynchronous page over an opaque page cursor.
See :class:CursorPage for the extra forward-compatibility
bag.
Source code in dashscope/applications/agentstudio/pagination.py
92 93 94 95 96 97 98 99 100 101 102 103 104 105 | |
has_next
¶
has_next() -> bool
Source code in dashscope/applications/agentstudio/pagination.py
107 108 | |
get_next
async
¶
get_next() -> Optional['AsyncCursorPage[T]']
Source code in dashscope/applications/agentstudio/pagination.py
110 111 112 113 114 115 116 117 | |
RequestOptions
dataclass
¶
RequestOptions(
method: str,
path: str,
json: Optional[Dict[str, Any]] = None,
params: Optional[Dict[str, Any]] = None,
data: Optional[Union[bytes, IO]] = None,
files: Optional[Dict[str, Any]] = None,
headers: Optional[Dict[str, str]] = None,
timeout: Optional[float] = None,
max_retries: Optional[int] = None,
stream: bool = False,
)
APIResponse
dataclass
¶
APIResponse(
data: Dict[str, Any],
request_id: Optional[str] = None,
status_code: int = 200,
)
from_http_response
classmethod
¶
from_http_response(response, exceptions_module)
Source code in dashscope/applications/agentstudio/transport.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 | |
APIConnectionError
¶
APIConnectionError(
message: Optional[str] = None,
*,
detail: Optional[str] = None,
**kwargs: Any
)
Bases: _CatalogSdkError
Network-level failure (connection refused, DNS, TLS...).
Backed by the catalog's sdk.ConnectionError entry: code /
solution / allow_retry default from it, so every raise site
is catalog-identical without repeating the wiring. Pass detail
instead of message to use the entry's message template.
Source code in dashscope/errors.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 | |
APITimeoutError
¶
APITimeoutError(
message: Optional[str] = None,
*,
detail: Optional[str] = None,
**kwargs: Any
)
Bases: APIConnectionError
Request timed out; backed by the catalog's sdk.Timeout entry.
Source code in dashscope/errors.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 | |
APIStatusError
¶
APIStatusError(
message: str,
*,
code: Optional[str] = None,
status_code: Optional[int] = None,
request_id: Optional[str] = None,
body: Any = None,
headers: Optional[Mapping[str, str]] = None
)
Bases: DashScopeError
A failure the gateway declared, on either layer of the model.
Both a non-2xx HTTP status and an HTTP 200 whose body carries a
business code land here; the instance's status_code says
which one it was.
Source code in dashscope/errors.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
AuthenticationError
¶
AuthenticationError(
message: str,
*,
code: Optional[str] = None,
status_code: Optional[int] = None,
request_id: Optional[str] = None,
body: Any = None,
headers: Optional[Mapping[str, str]] = None
)
Bases: APIStatusError
Source code in dashscope/errors.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
status_code
class-attribute
instance-attribute
¶
status_code = _CATALOG_STATUS['AuthenticationError']
PermissionDeniedError
¶
PermissionDeniedError(
message: str,
*,
code: Optional[str] = None,
status_code: Optional[int] = None,
request_id: Optional[str] = None,
body: Any = None,
headers: Optional[Mapping[str, str]] = None
)
Bases: APIStatusError
Source code in dashscope/errors.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
status_code
class-attribute
instance-attribute
¶
status_code = _CATALOG_STATUS['PermissionDeniedError']
NotFoundError
¶
NotFoundError(
message: str,
*,
code: Optional[str] = None,
status_code: Optional[int] = None,
request_id: Optional[str] = None,
body: Any = None,
headers: Optional[Mapping[str, str]] = None
)
Bases: APIStatusError
Source code in dashscope/errors.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
RateLimitError
¶
RateLimitError(
message: str,
*,
code: Optional[str] = None,
status_code: Optional[int] = None,
request_id: Optional[str] = None,
body: Any = None,
headers: Optional[Mapping[str, str]] = None
)
Bases: APIStatusError
Source code in dashscope/errors.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
InternalServerError
¶
InternalServerError(
message: str,
*,
code: Optional[str] = None,
status_code: Optional[int] = None,
request_id: Optional[str] = None,
body: Any = None,
headers: Optional[Mapping[str, str]] = None
)
Bases: APIStatusError
Source code in dashscope/errors.py
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 | |
status_code
class-attribute
instance-attribute
¶
status_code = _CATALOG_STATUS['InternalServerError']
StreamError
¶
StreamError(
message: Optional[str] = None,
*,
detail: Optional[str] = None,
**kwargs: Any
)
Bases: _CatalogSdkError
The SSE stream encountered a fatal protocol error.
Backed by the catalog's sdk.agentstudio.StreamError entry:
code / solution / allow_retry default from it.
Source code in dashscope/errors.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 | |
StreamClosedError
¶
StreamClosedError(
message: Optional[str] = None,
*,
detail: Optional[str] = None,
**kwargs: Any
)
Bases: StreamError
Attempted I/O on an already-closed stream.
Backed by the catalog's sdk.agentstudio.StreamClosedError entry.
Source code in dashscope/errors.py
176 177 178 179 180 181 182 183 184 185 186 187 188 189 | |