Package com.ants.platform.client.resources.score.types

Class CreateScoreRequest

java.lang.Object
com.ants.platform.client.resources.score.types.CreateScoreRequest
public final class CreateScoreRequest extends Object

  • Method Details

    • getId

      public Optional<String> getId()

    • getTraceId

      public Optional<String> getTraceId()

    • getSessionId

      public Optional<String> getSessionId()

    • getObservationId

      public Optional<String> getObservationId()

    • getDatasetRunId

      public Optional<String> getDatasetRunId()

    • getName

      public String getName()

    • getValue

      public CreateScoreValue getValue()
      Returns:
      The value of the score. Must be passed as string for categorical scores, and numeric for boolean and numeric scores. Boolean score values must equal either 1 or 0 (true or false)

    • getComment

      public Optional<String> getComment()

    • getMetadata

      public Optional<Object> getMetadata()

    • getEnvironment

      public Optional<String> getEnvironment()
      Returns:
      The environment of the score. Can be any lowercase alphanumeric string with hyphens and underscores that does not start with 'ants-platform'.

    • getDataType

      public Optional<ScoreDataType> getDataType()
      Returns:
      The data type of the score. When passing a configId this field is inferred. Otherwise, this field must be passed or will default to numeric.

    • getConfigId

      public Optional<String> getConfigId()
      Returns:
      Reference a score config on a score. The unique ANTS Platform identifier of a score config. When passing this field, the dataType and stringValue fields are automatically populated.

    • equals

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

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static CreateScoreRequest.NameStage builder()