AS AgentScopeAPI 手册 / API Reference

OrchestrationClient

public final class OrchestrationClient
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:30–165

Orchestration 客户端,封装与远端服务的连接和调用。位于 io.agentscope.extensions.controlplane.transport 包。核心成员包括 definitions、definition、createDefinition、updateDefinition、validateDefinition、publishDefinition。

Operator client for orchestration definitions, runs, attempts, and runtime policies.

构造器摘要Constructor Summary

构造器Constructor说明Description
public OrchestrationClient(ControlPlaneHttpClient http, String tenant, String namespace)
初始化 `OrchestrationClient` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public JsonNode definitions()
返回定义。
Returns the definitions.
public JsonNode definition(String id)
设置定义。
Performs the definition operation.
public JsonNode createDefinition(Object body)
创建定义。
Creates the definition.
public JsonNode updateDefinition(String id, Object body)
更新定义。
Updates the definition.
public JsonNode validateDefinition(String id, Object spec)
校验定义。
Validates the definition.
public JsonNode publishDefinition(String id)
发布定义。
Performs the publish definition operation.
public JsonNode revisions(String id)
设置该参数。
Performs the revisions operation.
public JsonNode start(String id, Object request)
执行启动相关操作。
Performs the start operation.
public JsonNode runs()
返回 `runs` 结果。
Returns the runs.
public JsonNode run(String id)
设置运行。
Performs the run operation.
public JsonNode graph(String id)
设置图。
Performs the graph operation.
public JsonNode events(String id)
设置事件。
Performs the events operation.
public JsonNode control(String id, String action)
执行 `control` 方法。
Performs the control operation.
public JsonNode rerun(String id, String idempotencyKey, Object input)
执行 `rerun` 方法。
Performs the rerun operation.
public JsonNode signal(String id, String name, String idempotencyKey, Object payload)
执行 `signal` 方法。
Performs the signal operation.
public JsonNode attempts()
返回尝试次数。
Returns the attempts.
public JsonNode attempt(String id)
设置尝试。
Performs the attempt operation.
public JsonNode runtimePolicy(String agentRef)
设置运行时策略。
Performs the runtime policy operation.
public JsonNode putRuntimePolicy(String agentRef, Object policy)
执行 `putRuntimePolicy` 方法。
Performs the put runtime policy operation.

构造器详情Constructor Detail

OrchestrationClient

public OrchestrationClient(ControlPlaneHttpClient http, String tenant, String namespace)

初始化 OrchestrationClient 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
httpControlPlaneHttpClientHTTP(类型 `ControlPlaneHttpClient`)。The http.
tenantString租户(类型 `String`)。The tenant.
namespaceString命名空间(类型 `String`)。The namespace.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:36–40

方法详情Method Detail

definitions

public JsonNode definitions()

返回定义。

Returns the definitions.

返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:42–44

definition

public JsonNode definition(String id)

设置定义。

Performs the definition operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:46–48

createDefinition

public JsonNode createDefinition(Object body)

创建定义。

Creates the definition.

参数Parameters
名称Name类型Type说明Description
bodyObject正文(类型 `Object`)。The body.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:50–52

updateDefinition

public JsonNode updateDefinition(String id, Object body)

更新定义。

Updates the definition.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
bodyObject正文(类型 `Object`)。The body.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:54–56

validateDefinition

public JsonNode validateDefinition(String id, Object spec)

校验定义。

Validates the definition.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
specObject规格(类型 `Object`)。The spec.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:58–63

publishDefinition

public JsonNode publishDefinition(String id)

发布定义。

Performs the publish definition operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:65–67

revisions

public JsonNode revisions(String id)

设置该参数。

Performs the revisions operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:69–71

start

public JsonNode start(String id, Object request)

执行启动相关操作。

Performs the start operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
requestObject请求(类型 `Object`)。The request.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:73–75

runs

public JsonNode runs()

返回 runs 结果。

Returns the runs.

返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:77–79

run

public JsonNode run(String id)

设置运行。

Performs the run operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:81–83

graph

public JsonNode graph(String id)

设置图。

Performs the graph operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:85–87

events

public JsonNode events(String id)

设置事件。

Performs the events operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:89–91

control

public JsonNode control(String id, String action)

执行 control 方法。

Performs the control operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
actionString动作(类型 `String`)。The action.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:93–97

rerun

public JsonNode rerun(String id, String idempotencyKey, Object input)

执行 rerun 方法。

Performs the rerun operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
idempotencyKeyStringidempotency 键(类型 `String`)。The idempotency key.
inputObject输入消息(类型 `Object`)。The input.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:99–105

signal

public JsonNode signal(String id, String name, String idempotencyKey, Object payload)

执行 signal 方法。

Performs the signal operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
nameString名称(类型 `String`)。The name.
idempotencyKeyStringidempotency 键(类型 `String`)。The idempotency key.
payloadObject负载(类型 `Object`)。The payload.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:107–116

attempts

public JsonNode attempts()

返回尝试次数。

Returns the attempts.

返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:118–120

attempt

public JsonNode attempt(String id)

设置尝试。

Performs the attempt operation.

参数Parameters
名称Name类型Type说明Description
idString标识(类型 `String`)。The id.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:122–124

runtimePolicy

public JsonNode runtimePolicy(String agentRef)

设置运行时策略。

Performs the runtime policy operation.

参数Parameters
名称Name类型Type说明Description
agentRefString智能体引用(类型 `String`)。The agent ref.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:126–128

putRuntimePolicy

public JsonNode putRuntimePolicy(String agentRef, Object policy)

执行 putRuntimePolicy 方法。

Performs the put runtime policy operation.

参数Parameters
名称Name类型Type说明Description
agentRefString智能体引用(类型 `String`)。The agent ref.
policyObject策略(类型 `Object`)。The policy.
返回Returns JsonNode
返回JsonNode。Returns json node.
源码Source io/agentscope/extensions/controlplane/transport/OrchestrationClient.java:130–132
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.