Enum Class MistralAiApi.FinishReason
java.lang.Object
java.lang.Enum<MistralAiApi.FinishReason>
org.springframework.ai.mistralai.api.MistralAiApi.FinishReason
- All Implemented Interfaces:
Serializable,Comparable<MistralAiApi.FinishReason>,Constable
- Enclosing class:
- MistralAiApi
The reason the model stopped generating tokens.
This enumeration is shared between streaming and blocking responses. The dedication of only one type of responses is documented in a note present in the Javadoc of the corresponding value.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionThe maximum number of tokens specified in the request was reached.The content was omitted due to a flag from our content filters.The model hit a natural stop point or a provided stop sequence.The model requested a tool call. -
Method Summary
Modifier and TypeMethodDescriptionstatic MistralAiApi.FinishReasonReturns the enum constant of this class with the specified name.static MistralAiApi.FinishReason[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
STOP
The model hit a natural stop point or a provided stop sequence. -
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. Note: Only applicable for blocking responses. -
ERROR
-
TOOL_CALLS
The model requested a tool call.
-
-
Method Details
-
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
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 nameNullPointerException- if the argument is null
-