Class ServerInstructionsApi

java.lang.Object

com.github.copilot.generated.rpc.ServerInstructionsApi

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

API methods for the instructions namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<InstructionsDiscoverResult>	discover(InstructionsDiscoverParams params)	Discovers instruction sources across user, repository, and plugin sources.
CompletableFuture<InstructionsDiscoverResult>	discover(InstructionsDiscoverRequest request)	Discovers instruction sources across user, repository, and plugin sources.
CompletableFuture<InstructionsGetDiscoveryPathsResult>	getDiscoveryPaths(InstructionsGetDiscoveryPathsParams params)	Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet.
CompletableFuture<InstructionsGetDiscoveryPathsResult>	getDiscoveryPaths(InstructionsGetDiscoveryPathsRequest request)	Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet.

Methods inherited from class Object

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

Method Details

discover

@CopilotExperimental
public CompletableFuture<InstructionsDiscoverResult> discover(InstructionsDiscoverParams params)

Discovers instruction sources across user, repository, and plugin sources.

Since:

1.0.0

discover

@CopilotExperimental
public CompletableFuture<InstructionsDiscoverResult> discover(InstructionsDiscoverRequest request)

Discovers instruction sources across user, repository, and plugin sources.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0

getDiscoveryPaths

@CopilotExperimental
public CompletableFuture<InstructionsGetDiscoveryPathsResult> getDiscoveryPaths(InstructionsGetDiscoveryPathsParams params)

Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet. Repository targets become active once created.

Since:

1.0.0

getDiscoveryPaths

@CopilotExperimental
public CompletableFuture<InstructionsGetDiscoveryPathsResult> getDiscoveryPaths(InstructionsGetDiscoveryPathsRequest request)

Returns the canonical files and directories where a client may create custom instructions that the runtime will recognize, including ones that do not exist yet. Repository targets become active once created.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0