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

public static enum MistralAiApi.FinishReason extends Enum<MistralAiApi.FinishReason>
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.

  • Enum Constant Details

  • Method Details

    • values

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