Package org.springframework.ai.mistralai.api

Enum Class MistralAiApi.ChatCompletionFinishReason

java.lang.Object

java.lang.Enum<MistralAiApi.ChatCompletionFinishReason>

org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionFinishReason

All Implemented Interfaces:

Serializable, Comparable<MistralAiApi.ChatCompletionFinishReason>, Constable

Enclosing class:

MistralAiApi

public static enum MistralAiApi.ChatCompletionFinishReason
extends Enum<MistralAiApi.ChatCompletionFinishReason>

The reason the model stopped generating tokens.

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
ERROR
LENGTH	The maximum number of tokens specified in the request was reached.
MODEL_LENGTH	The content was omitted due to a flag from our content filters.
STOP	The model hit a natural stop point or a provided stop sequence.
TOOL_CALLS	The model requested a tool call.

Method Summary

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

STOP

public static final MistralAiApi.ChatCompletionFinishReason STOP

The model hit a natural stop point or a provided stop sequence.

LENGTH

public static final MistralAiApi.ChatCompletionFinishReason LENGTH

The maximum number of tokens specified in the request was reached.

MODEL_LENGTH

public static final MistralAiApi.ChatCompletionFinishReason MODEL_LENGTH

The content was omitted due to a flag from our content filters.

ERROR

public static final MistralAiApi.ChatCompletionFinishReason ERROR

TOOL_CALLS

public static final MistralAiApi.ChatCompletionFinishReason TOOL_CALLS

The model requested a tool call.

Method Details

values

public static MistralAiApi.ChatCompletionFinishReason[] 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 MistralAiApi.ChatCompletionFinishReason 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