Package org.springframework.ai.openai.api

Enum Class OpenAiApi.ChatCompletionFinishReason

java.lang.Object

java.lang.Enum<OpenAiApi.ChatCompletionFinishReason>

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionFinishReason

All Implemented Interfaces:

Serializable, Comparable<OpenAiApi.ChatCompletionFinishReason>, Constable

Enclosing class:

OpenAiApi

public static enum OpenAiApi.ChatCompletionFinishReason
extends Enum<OpenAiApi.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
CONTENT_FILTER	The content was omitted due to a flag from our content filters.
LENGTH	The maximum number of tokens specified in the request was reached.
STOP	The model hit a natural stop point or a provided stop sequence.
TOOL_CALL	Only for compatibility with Mistral AI API.
TOOL_CALLS	The model called a tool.

Method Summary

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

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

LENGTH

public static final OpenAiApi.ChatCompletionFinishReason LENGTH

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

CONTENT_FILTER

public static final OpenAiApi.ChatCompletionFinishReason CONTENT_FILTER

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

TOOL_CALLS

public static final OpenAiApi.ChatCompletionFinishReason TOOL_CALLS

The model called a tool.

TOOL_CALL

public static final OpenAiApi.ChatCompletionFinishReason TOOL_CALL

Only for compatibility with Mistral AI API.

Method Details

values

public static OpenAiApi.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 OpenAiApi.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