Package com.github.copilot.sdk.json

Class SystemMessageConfig

java.lang.Object

com.github.copilot.sdk.json.SystemMessageConfig

public class SystemMessageConfig
extends Object

Configuration for customizing the system message.

The system message controls the behavior and personality of the AI assistant. This configuration allows you to either append to, replace, or fine-tune the default system message.

Example - Append Mode

 var config = new SystemMessageConfig().setMode(SystemMessageMode.APPEND)
 		.setContent("Always respond in a formal tone.");
 

Example - Replace Mode

 var config = new SystemMessageConfig().setMode(SystemMessageMode.REPLACE)
 		.setContent("You are a helpful coding assistant.");
 

Example - Customize Mode

 var config = new SystemMessageConfig().setMode(SystemMessageMode.CUSTOMIZE)
 		.setSections(
 				Map.of(SystemPromptSections.TONE,
 						new SectionOverride().setAction(SectionOverrideAction.REPLACE)
 								.setContent("Be concise and formal."),
 						SystemPromptSections.CODE_CHANGE_RULES,
 						new SectionOverride().setAction(SectionOverrideAction.REMOVE)))
 		.setContent("Additional instructions appended after all sections.");
 

Since:

1.0.0

See Also:

• SessionConfig.setSystemMessage(SystemMessageConfig)
• SystemMessageMode
• SectionOverride
• SystemPromptSections

Constructor Summary

Constructors

Constructor	Description
SystemMessageConfig()

Method Summary

Modifier and Type	Method	Description
String	getContent()	Gets the system message content.
SystemMessageMode	getMode()	Gets the system message mode.
Map<String,SectionOverride>	getSections()	Gets the section-level overrides for SystemMessageMode.CUSTOMIZE mode.
SystemMessageConfig	setContent(String content)	Sets the system message content.
SystemMessageConfig	setMode(SystemMessageMode mode)	Sets the system message mode.
SystemMessageConfig	setSections(Map<String,SectionOverride> sections)	Sets section-level overrides for SystemMessageMode.CUSTOMIZE mode.

Methods inherited from class java.lang.Object

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

Constructor Details

SystemMessageConfig

public SystemMessageConfig()

Method Details

getMode

public SystemMessageMode getMode()

Gets the system message mode.

Returns:

the mode (APPEND, REPLACE, or CUSTOMIZE)

setMode

public SystemMessageConfig setMode(SystemMessageMode mode)

Sets the system message mode.

Use SystemMessageMode.APPEND to add to the default system message while preserving guardrails, SystemMessageMode.REPLACE to fully customize the system message, or SystemMessageMode.CUSTOMIZE to override individual sections.

Parameters:

mode - the mode (APPEND, REPLACE, or CUSTOMIZE)

Returns:

this config for method chaining

getContent

public String getContent()

Gets the system message content.

Returns:

the content to append or use as replacement

setContent

public SystemMessageConfig setContent(String content)

Sets the system message content.

For SystemMessageMode.APPEND and SystemMessageMode.REPLACE modes, this is the primary content. For SystemMessageMode.CUSTOMIZE mode, this is appended after all section overrides.

Parameters:

content - the system message content

Returns:

this config for method chaining

getSections

public Map<String,SectionOverride> getSections()

Gets the section-level overrides for SystemMessageMode.CUSTOMIZE mode.

Returns:

the sections map, or null

setSections

public SystemMessageConfig setSections(Map<String,SectionOverride> sections)

Sets section-level overrides for SystemMessageMode.CUSTOMIZE mode.

Keys are section identifiers from SystemPromptSections. Each value describes how that section should be modified. Sections with a transform callback are handled locally by the SDK via a systemMessage.transform RPC call; the rest are sent to the CLI as-is.

Parameters:

sections - a map of section identifier to override operation

Returns:

this config for method chaining

Since:

1.2.0