Package akka.javasdk.ledger

Enum Class InteractionMetadata.FinishReason

Object

Enum<InteractionMetadata.FinishReason>

akka.javasdk.ledger.InteractionMetadata.FinishReason

All Implemented Interfaces:

Serializable, Comparable<InteractionMetadata.FinishReason>, Constable

Enclosing class:

InteractionMetadata

public static enum InteractionMetadata.FinishReason
extends Enum<InteractionMetadata.FinishReason>

Why a model call finished. A later SDK version can add values.

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
LENGTH	The model stopped because it reached the maximum number of tokens.
STOP	The model stopped at a natural stopping point.
UNSPECIFIED	The runtime did not report the reason, or this version of the SDK does not know it.

Method Summary

Modifier and Type	Method	Description
static InteractionMetadata.FinishReason	valueOf(String name)	Returns the enum constant of this class with the specified name.
static InteractionMetadata.FinishReason[]	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

UNSPECIFIED

public static final InteractionMetadata.FinishReason UNSPECIFIED

The runtime did not report the reason, or this version of the SDK does not know it.

STOP

public static final InteractionMetadata.FinishReason STOP

The model stopped at a natural stopping point.

LENGTH

public static final InteractionMetadata.FinishReason LENGTH

The model stopped because it reached the maximum number of tokens.

Method Details

values

public static InteractionMetadata.FinishReason[] 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 InteractionMetadata.FinishReason 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