Package com.sap.ai.sdk.core.model

Class AiModelVersion

java.lang.Object
com.sap.ai.sdk.core.model.AiModelVersion
public class AiModelVersion extends Object
Model version information including whether it is latest version, its deprecation status and optional retirement date

  • Constructor Details

    • AiModelVersion

      protected AiModelVersion()
      Default constructor for AiModelVersion.

  • Method Details

    • name

      @Nonnull public AiModelVersion name(@Nonnull String name)
      Set the name of this AiModelVersion instance and return the same instance.
      Parameters:
      name - Name of model version
      Returns:
      The same instance of this AiModelVersion class

    • getName

      @Nonnull public String getName()
      Name of model version
      Returns:
      name The name of this AiModelVersion instance.

    • setName

      public void setName(@Nonnull String name)
      Set the name of this AiModelVersion instance.
      Parameters:
      name - Name of model version

    • isLatest

      @Nonnull public AiModelVersion isLatest(@Nonnull Boolean isLatest)
      Set the isLatest of this AiModelVersion instance and return the same instance.
      Parameters:
      isLatest - Displays whether it is the latest version offered for the model
      Returns:
      The same instance of this AiModelVersion class

    • isIsLatest

      @Nonnull public Boolean isIsLatest()
      Displays whether it is the latest version offered for the model
      Returns:
      isLatest The isLatest of this AiModelVersion instance.

    • setIsLatest

      public void setIsLatest(@Nonnull Boolean isLatest)
      Set the isLatest of this AiModelVersion instance.
      Parameters:
      isLatest - Displays whether it is the latest version offered for the model

    • deprecated

      @Nonnull public AiModelVersion deprecated(@Nonnull Boolean deprecated)
      Set the deprecated of this AiModelVersion instance and return the same instance.
      Parameters:
      deprecated - Deprecation status of model
      Returns:
      The same instance of this AiModelVersion class

    • isDeprecated

      @Nonnull public Boolean isDeprecated()
      Deprecation status of model
      Returns:
      deprecated The deprecated of this AiModelVersion instance.

    • setDeprecated

      public void setDeprecated(@Nonnull Boolean deprecated)
      Set the deprecated of this AiModelVersion instance.
      Parameters:
      deprecated - Deprecation status of model

    • retirementDate

      @Nonnull public AiModelVersion retirementDate(@Nullable String retirementDate)
      Set the retirementDate of this AiModelVersion instance and return the same instance.
      Parameters:
      retirementDate - Retirement date of model in ISO 8601 timestamp
      Returns:
      The same instance of this AiModelVersion class

    • getRetirementDate

      @Nonnull public String getRetirementDate()
      Retirement date of model in ISO 8601 timestamp
      Returns:
      retirementDate The retirementDate of this AiModelVersion instance.

    • setRetirementDate

      public void setRetirementDate(@Nullable String retirementDate)
      Set the retirementDate of this AiModelVersion instance.
      Parameters:
      retirementDate - Retirement date of model in ISO 8601 timestamp

    • contextLength

      @Nonnull public AiModelVersion contextLength(@Nullable Integer contextLength)
      Set the contextLength of this AiModelVersion instance and return the same instance.
      Parameters:
      contextLength - Context length of the model
      Returns:
      The same instance of this AiModelVersion class

    • getContextLength

      @Nonnull public Integer getContextLength()
      Context length of the model
      Returns:
      contextLength The contextLength of this AiModelVersion instance.

    • setContextLength

      public void setContextLength(@Nullable Integer contextLength)
      Set the contextLength of this AiModelVersion instance.
      Parameters:
      contextLength - Context length of the model

    • inputTypes

      @Nonnull public AiModelVersion inputTypes(@Nullable List<String> inputTypes)
      Set the inputTypes of this AiModelVersion instance and return the same instance.
      Parameters:
      inputTypes - List of input types supported by the model
      Returns:
      The same instance of this AiModelVersion class

    • addInputTypesItem

      @Nonnull public AiModelVersion addInputTypesItem(@Nonnull String inputTypesItem)
      Add one inputTypes instance to this AiModelVersion.
      Parameters:
      inputTypesItem - The inputTypes that should be added
      Returns:
      The same instance of type AiModelVersion

    • getInputTypes

      @Nonnull public List<String> getInputTypes()
      List of input types supported by the model
      Returns:
      inputTypes The inputTypes of this AiModelVersion instance.

    • setInputTypes

      public void setInputTypes(@Nullable List<String> inputTypes)
      Set the inputTypes of this AiModelVersion instance.
      Parameters:
      inputTypes - List of input types supported by the model

    • capabilities

      @Nonnull public AiModelVersion capabilities(@Nullable List<String> capabilities)
      Set the capabilities of this AiModelVersion instance and return the same instance.
      Parameters:
      capabilities - List of capabilities supported by the model
      Returns:
      The same instance of this AiModelVersion class

    • addCapabilitiesItem

      @Nonnull public AiModelVersion addCapabilitiesItem(@Nonnull String capabilitiesItem)
      Add one capabilities instance to this AiModelVersion.
      Parameters:
      capabilitiesItem - The capabilities that should be added
      Returns:
      The same instance of type AiModelVersion

    • getCapabilities

      @Nonnull public List<String> getCapabilities()
      List of capabilities supported by the model
      Returns:
      capabilities The capabilities of this AiModelVersion instance.

    • setCapabilities

      public void setCapabilities(@Nullable List<String> capabilities)
      Set the capabilities of this AiModelVersion instance.
      Parameters:
      capabilities - List of capabilities supported by the model

    • metadata

      @Nonnull public AiModelVersion metadata(@Nullable List<Map<String,String>> metadata)
      Set the metadata of this AiModelVersion instance and return the same instance.
      Parameters:
      metadata - List of metadata supported by the model
      Returns:
      The same instance of this AiModelVersion class

    • addMetadataItem

      @Nonnull public AiModelVersion addMetadataItem(@Nonnull Map<String,String> metadataItem)
      Add one metadata instance to this AiModelVersion.
      Parameters:
      metadataItem - The metadata that should be added
      Returns:
      The same instance of type AiModelVersion

    • getMetadata

      @Nonnull public List<Map<String,String>> getMetadata()
      List of metadata supported by the model
      Returns:
      metadata The metadata of this AiModelVersion instance.

    • setMetadata

      public void setMetadata(@Nullable List<Map<String,String>> metadata)
      Set the metadata of this AiModelVersion instance.
      Parameters:
      metadata - List of metadata supported by the model

    • cost

      @Nonnull public AiModelVersion cost(@Nullable List<Map<String,String>> cost)
      Set the cost of this AiModelVersion instance and return the same instance.
      Parameters:
      cost - List of costs associated with the model
      Returns:
      The same instance of this AiModelVersion class

    • addCostItem

      @Nonnull public AiModelVersion addCostItem(@Nonnull Map<String,String> costItem)
      Add one cost instance to this AiModelVersion.
      Parameters:
      costItem - The cost that should be added
      Returns:
      The same instance of type AiModelVersion

    • getCost

      @Nonnull public List<Map<String,String>> getCost()
      List of costs associated with the model
      Returns:
      cost The cost of this AiModelVersion instance.

    • setCost

      public void setCost(@Nullable List<Map<String,String>> cost)
      Set the cost of this AiModelVersion instance.
      Parameters:
      cost - List of costs associated with the model

    • suggestedReplacements

      @Nonnull public AiModelVersion suggestedReplacements(@Nullable List<String> suggestedReplacements)
      Set the suggestedReplacements of this AiModelVersion instance and return the same instance.
      Parameters:
      suggestedReplacements - List of suggested replacements for the model
      Returns:
      The same instance of this AiModelVersion class

    • addSuggestedReplacementsItem

      @Nonnull public AiModelVersion addSuggestedReplacementsItem(@Nonnull String suggestedReplacementsItem)
      Add one suggestedReplacements instance to this AiModelVersion.
      Parameters:
      suggestedReplacementsItem - The suggestedReplacements that should be added
      Returns:
      The same instance of type AiModelVersion

    • getSuggestedReplacements

      @Nonnull public List<String> getSuggestedReplacements()
      List of suggested replacements for the model
      Returns:
      suggestedReplacements The suggestedReplacements of this AiModelVersion instance.

    • setSuggestedReplacements

      public void setSuggestedReplacements(@Nullable List<String> suggestedReplacements)
      Set the suggestedReplacements of this AiModelVersion instance.
      Parameters:
      suggestedReplacements - List of suggested replacements for the model

    • streamingSupported

      @Nonnull public AiModelVersion streamingSupported(@Nullable Boolean streamingSupported)
      Set the streamingSupported of this AiModelVersion instance and return the same instance.
      Parameters:
      streamingSupported - Streaming support status of the model
      Returns:
      The same instance of this AiModelVersion class

    • isStreamingSupported

      @Nonnull public Boolean isStreamingSupported()
      Streaming support status of the model
      Returns:
      streamingSupported The streamingSupported of this AiModelVersion instance.

    • setStreamingSupported

      public void setStreamingSupported(@Nullable Boolean streamingSupported)
      Set the streamingSupported of this AiModelVersion instance.
      Parameters:
      streamingSupported - Streaming support status of the model

    • orchestrationCapabilities

      @Nonnull public AiModelVersion orchestrationCapabilities(@Nullable List<String> orchestrationCapabilities)
      Set the orchestrationCapabilities of this AiModelVersion instance and return the same instance.
      Parameters:
      orchestrationCapabilities - List of model capabilities supported by orchestration service
      Returns:
      The same instance of this AiModelVersion class

    • addOrchestrationCapabilitiesItem

      @Nonnull public AiModelVersion addOrchestrationCapabilitiesItem(@Nonnull String orchestrationCapabilitiesItem)
      Add one orchestrationCapabilities instance to this AiModelVersion.
      Parameters:
      orchestrationCapabilitiesItem - The orchestrationCapabilities that should be added
      Returns:
      The same instance of type AiModelVersion

    • getOrchestrationCapabilities

      @Nonnull public List<String> getOrchestrationCapabilities()
      List of model capabilities supported by orchestration service
      Returns:
      orchestrationCapabilities The orchestrationCapabilities of this AiModelVersion instance.

    • setOrchestrationCapabilities

      public void setOrchestrationCapabilities(@Nullable List<String> orchestrationCapabilities)
      Set the orchestrationCapabilities of this AiModelVersion instance.
      Parameters:
      orchestrationCapabilities - List of model capabilities supported by orchestration service

    • getCustomFieldNames

      @Nonnull public Set<String> getCustomFieldNames()
      Get the names of the unrecognizable properties of the AiModelVersion.
      Returns:
      The set of properties names

    • getCustomField

      @Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException
      Deprecated.
      Use toMap() instead.
      Get the value of an unrecognizable property of this AiModelVersion instance.
      Parameters:
      name - The name of the property
      Returns:
      The value of the property
      Throws:
      NoSuchElementException - If no property with the given name could be found.

    • toMap

      @Nonnull public Map<String,Object> toMap()
      Get the value of all properties of this AiModelVersion instance including unrecognized properties.
      Returns:
      The map of all properties

    • setCustomField

      public void setCustomField(@Nonnull String customFieldName, @Nullable Object customFieldValue)
      Set an unrecognizable property of this AiModelVersion instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.
      Parameters:
      customFieldName - The name of the property
      customFieldValue - The value of the property

    • equals

      public boolean equals(@Nullable Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Nonnull public String toString()
      Overrides:
      toString in class Object

    • create

      public static AiModelVersion.Builder create()
      Create a type-safe, fluent-api builder object to construct a new AiModelVersion instance with all required arguments.