Package org.freeplane.api.ai

Class AiTemperature

java.lang.Object
org.freeplane.api.ai.AiTemperature
public class AiTemperature extends Object
Immutable public temperature configuration for script-facing AI requests.

null temperature in AiModelConfiguration means inherit the surrounding configuration. modelDefault() is an explicit value meaning "ask the selected model to use its own default temperature". Numeric values are passed through as requested model temperature values.

Since:
1.13.3

  • Method Details

    • modelDefault

      public static AiTemperature modelDefault()
      Requests the selected model's default temperature explicitly.
      Returns:
      shared model-default temperature marker

    • of

      public static AiTemperature of(double value)
      Requests a numeric temperature.
      Parameters:
      value - finite temperature value
      Returns:
      numeric temperature configuration

    • isModelDefault

      public boolean isModelDefault()
      Returns whether this value requests the model default.
      Returns:
      true for modelDefault()

    • isNumeric

      public boolean isNumeric()
      Returns whether this value is numeric.
      Returns:
      true when getValue() is non-null

    • getValue

      public Double getValue()
      Returns the numeric temperature value, or null for modelDefault().
      Returns:
      numeric temperature, or null

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object