Class SessionAgentApi

java.lang.Object

com.github.copilot.generated.rpc.SessionAgentApi

@Generated("copilot-sdk-codegen")
public final class SessionAgentApi
extends Object

API methods for the agent namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	deselect()	Identifies the target session.
CompletableFuture<SessionAgentGetCurrentResult>	getCurrent()	Identifies the target session.
CompletableFuture<SessionAgentListResult>	list()	Controls whether built-in agents and authored prompt text are included.
CompletableFuture<SessionAgentListResult>	list(SessionAgentListParams params)	Controls whether built-in agents and authored prompt text are included.
CompletableFuture<SessionAgentReloadResult>	reload()	Identifies the target session.
CompletableFuture<SessionAgentSelectResult>	select(SessionAgentSelectParams params)	Name of the custom agent to select for subsequent turns.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

list

@CopilotExperimental
public CompletableFuture<SessionAgentListResult> list()

Controls whether built-in agents and authored prompt text are included.

Invokes the method with no params, applying the runtime defaults.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionAgentListResult> list(SessionAgentListParams params)

Controls whether built-in agents and authored prompt text are included.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

getCurrent

@CopilotExperimental
public CompletableFuture<SessionAgentGetCurrentResult> getCurrent()

Identifies the target session.

Since:

1.0.0

select

@CopilotExperimental
public CompletableFuture<SessionAgentSelectResult> select(SessionAgentSelectParams params)

Name of the custom agent to select for subsequent turns.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

deselect

@CopilotExperimental
public CompletableFuture<Void> deselect()

Identifies the target session.

Since:

1.0.0

reload

@CopilotExperimental
public CompletableFuture<SessionAgentReloadResult> reload()

Identifies the target session.

Since:

1.0.0