Package com.axelor.ai.provider.sync

Record Class ModelCandidate

java.lang.Object
java.lang.Record
com.axelor.ai.provider.sync.ModelCandidate
public record ModelCandidate(String modelId, String name, AiModelType type, boolean supportsTools, boolean supportsVision, Integer maxInputTokens, Integer embeddingDimensions) extends Record
A selected model with its values resolved, used only when creating one.

Carries the fields that describe the model itself. The deployment settings a family may also declare (reasoningEffort, rateLimit, …) are written straight from the rules, so they are deliberately absent here. Null token limits mean unknown, not zero.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModelCandidate(String modelId, String name, AiModelType type, boolean supportsTools, boolean supportsVision, Integer maxInputTokens, Integer embeddingDimensions)
    Creates an instance of a ModelCandidate record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Integer
    embeddingDimensions()
    Returns the value of the embeddingDimensions record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Integer
    maxInputTokens()
    Returns the value of the maxInputTokens record component.
    String
    modelId()
    Returns the value of the modelId record component.
    String
    name()
    Returns the value of the name record component.
    boolean
    supportsTools()
    Returns the value of the supportsTools record component.
    boolean
    supportsVision()
    Returns the value of the supportsVision record component.
    final String
    toString()
    Returns a string representation of this record class.
    AiModelType
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • ModelCandidate

      public ModelCandidate(String modelId, String name, AiModelType type, boolean supportsTools, boolean supportsVision, Integer maxInputTokens, Integer embeddingDimensions)
      Creates an instance of a ModelCandidate record class.
      Parameters:
      modelId - the value for the modelId record component
      name - the value for the name record component
      type - the value for the type record component
      supportsTools - the value for the supportsTools record component
      supportsVision - the value for the supportsVision record component
      maxInputTokens - the value for the maxInputTokens record component
      embeddingDimensions - the value for the embeddingDimensions record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • modelId

      public String modelId()
      Returns the value of the modelId record component.
      Returns:
      the value of the modelId record component

    • name

      public String name()
      Returns the value of the name record component.
      Returns:
      the value of the name record component

    • type

      public AiModelType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • supportsTools

      public boolean supportsTools()
      Returns the value of the supportsTools record component.
      Returns:
      the value of the supportsTools record component

    • supportsVision

      public boolean supportsVision()
      Returns the value of the supportsVision record component.
      Returns:
      the value of the supportsVision record component

    • maxInputTokens

      public Integer maxInputTokens()
      Returns the value of the maxInputTokens record component.
      Returns:
      the value of the maxInputTokens record component

    • embeddingDimensions

      public Integer embeddingDimensions()
      Returns the value of the embeddingDimensions record component.
      Returns:
      the value of the embeddingDimensions record component