Package dev.langchain4j.model.output

Enum FinishReason

  • All Implemented Interfaces:
    
public enum FinishReason

    The reason why a model call finished.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      STOP

      The model call finished because the model decided the request was done.
      LENGTH

      The call finished because the token length was reached.
      TOOL_EXECUTION

      The call finished signalling a need for tool execution.
      CONTENT_FILTER

      The call finished signalling a need for content filtering.
      OTHER

      The call finished for some other reason.

    • Method Summary

      Modifier and Type Method Description
      static Array<FinishReason> values() Returns an array containing the constants of this enum type, in the order they're declared.
      static FinishReason valueOf(String name) Returns the enum constant of this type with the specified name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

    • Method Detail

      • values

         static Array<FinishReason> values()

        Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants.

        Returns:

        an array containing the constants of this enum type, in the order they're declared

      • valueOf

         static 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.)

        Returns:

        the enum constant with the specified name