com.oracle.bmc.generativeaiinference.model

Enum CohereChatResponse.FinishReason

java.lang.Object

java.lang.Enum<CohereChatResponse.FinishReason>

com.oracle.bmc.generativeaiinference.model.CohereChatResponse.FinishReason

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<CohereChatResponse.FinishReason>

Enclosing class:

CohereChatResponse

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

Why the generation stopped.

Enum Constant Summary

Enum Constants

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

Method Summary

Modifier and Type	Method and Description
static CohereChatResponse.FinishReason	create(String key)
String	getValue()
static CohereChatResponse.FinishReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static CohereChatResponse.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 CohereChatResponse.FinishReason Complete

ErrorToxic

public static final CohereChatResponse.FinishReason ErrorToxic

ErrorLimit

public static final CohereChatResponse.FinishReason ErrorLimit

Error

public static final CohereChatResponse.FinishReason Error

UserCancel

public static final CohereChatResponse.FinishReason UserCancel

MaxTokens

public static final CohereChatResponse.FinishReason MaxTokens

UnknownEnumValue

public static final CohereChatResponse.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 CohereChatResponse.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 (CohereChatResponse.FinishReason c : CohereChatResponse.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 CohereChatResponse.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 CohereChatResponse.FinishReason create(String key)