Package com.veeva.vault.sdk.api.agent

Enum Class AgentActionStopReason

java.lang.Object

java.lang.Enum<AgentActionStopReason>

com.veeva.vault.sdk.api.agent.AgentActionStopReason

All Implemented Interfaces:

Serializable, Comparable<AgentActionStopReason>, Constable

public enum AgentActionStopReason
extends Enum<AgentActionStopReason>

Defines reasons why an agent action has stopped.

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
END_TURN	Indicates the agent action is complete.
MAX_OUTPUT_TOKENS	Indicates the agent action response has exceeded the maximum configured output tokens and may be incomplete.
STOP_SEQUENCE	Indicates the agent action response stopped due to matching with a specified stop sequence.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

END_TURN

public static final AgentActionStopReason END_TURN

Indicates the agent action is complete.

MAX_OUTPUT_TOKENS

public static final AgentActionStopReason MAX_OUTPUT_TOKENS

Indicates the agent action response has exceeded the maximum configured output tokens and may be incomplete.

STOP_SEQUENCE

public static final AgentActionStopReason STOP_SEQUENCE

Indicates the agent action response stopped due to matching with a specified stop sequence.

Method Details

values

public static AgentActionStopReason[] 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 AgentActionStopReason 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