Package com.oracle.bmc.generativeaiinference.model

Enum CohereChatResponseV2.FinishReason

java.lang.Object

java.lang.Enum<CohereChatResponseV2.FinishReason>

com.oracle.bmc.generativeaiinference.model.CohereChatResponseV2.FinishReason

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<CohereChatResponseV2.FinishReason>

Enclosing class:

CohereChatResponseV2

public static enum CohereChatResponseV2.FinishReason
extends Enum<CohereChatResponseV2.FinishReason>
implements BmcEnum

Why the generation stopped.

Enum Constant Summary

Enum Constants

Enum Constant	Description
Complete
Error
MaxTokens
StopSequence
ToolCall
UnknownEnumValue	This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Complete

public static final CohereChatResponseV2.FinishReason Complete

StopSequence

public static final CohereChatResponseV2.FinishReason StopSequence

MaxTokens

public static final CohereChatResponseV2.FinishReason MaxTokens

ToolCall

public static final CohereChatResponseV2.FinishReason ToolCall

Error

public static final CohereChatResponseV2.FinishReason Error

UnknownEnumValue

public static final CohereChatResponseV2.FinishReason UnknownEnumValue

This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Detail

values

public static CohereChatResponseV2.FinishReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CohereChatResponseV2.FinishReason c : CohereChatResponseV2.FinishReason.values())
    System.out.println(c);

Returns:

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

valueOf

public static CohereChatResponseV2.FinishReason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Specified by:

getValue in interface BmcEnum

create

public static CohereChatResponseV2.FinishReason create(String key)