Package com.github.copilot.sdk.json

Enum Class SectionOverrideAction

java.lang.Object

java.lang.Enum<SectionOverrideAction>

com.github.copilot.sdk.json.SectionOverrideAction

All Implemented Interfaces:

Serializable, Comparable<SectionOverrideAction>, Constable

public enum SectionOverrideAction
extends Enum<SectionOverrideAction>

Specifies the operation to perform on a system prompt section in SystemMessageMode#CUSTOMIZE mode.

Since:

1.2.0

See Also:

• SectionOverride
• SystemMessageConfig

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPEND	Append content after the existing section.
PREPEND	Prepend content before the existing section.
REMOVE	Remove the section from the prompt.
REPLACE	Replace the section content entirely.
TRANSFORM	Transform the section content via a callback.

Method Summary

Modifier and Type	Method	Description
String	getValue()	Returns the JSON value for this action.
static SectionOverrideAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SectionOverrideAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REPLACE

public static final SectionOverrideAction REPLACE

Replace the section content entirely.

REMOVE

public static final SectionOverrideAction REMOVE

Remove the section from the prompt.

APPEND

public static final SectionOverrideAction APPEND

Append content after the existing section.

PREPEND

public static final SectionOverrideAction PREPEND

Prepend content before the existing section.

TRANSFORM

public static final SectionOverrideAction TRANSFORM

Transform the section content via a callback.

When this action is used, the SectionOverride.getTransform() callback must be set. The SDK will not serialize this action over the wire directly; instead it registers a systemMessage.transform RPC handler.

Method Details

values

public static SectionOverrideAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SectionOverrideAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Returns the JSON value for this action.

Returns:

the string value used in JSON serialization