Package com.smartgwt.client.ai

Class AIFieldRequest

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.ai.SingleSourceAIRequest
com.smartgwt.client.ai.AIFieldRequest
All Implemented Interfaces:
HasHandlers
public class AIFieldRequest extends SingleSourceAIRequest
Settings that configure requests to AI to generate the values for a field.
See Also:

  • Constructor Details

    • AIFieldRequest

      public AIFieldRequest()

    • AIFieldRequest

      public AIFieldRequest(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static AIFieldRequest getOrCreateRef(JavaScriptObject jsObj)

    • setCategories

      public AIFieldRequest setCategories(String... categories)
      If the valueClass is CATEGORICAL or ORDINAL, the list of available categories.
      Parameters:
      categories - New categories value. Default value is null
      Returns:
      AIFieldRequest instance, for chaining setter calls

    • getCategories

      public String[] getCategories()
      If the valueClass is CATEGORICAL or ORDINAL, the list of available categories.
      Returns:
      Current categories value. Default value is null

    • setMaxRecordsPerBatch

      public AIFieldRequest setMaxRecordsPerBatch(Integer maxRecordsPerBatch)
      When generating values for a list of records that are split into batches, the maximum number of records per batch.
      Parameters:
      maxRecordsPerBatch - New maxRecordsPerBatch value. Default value is null
      Returns:
      AIFieldRequest instance, for chaining setter calls

    • getMaxRecordsPerBatch

      public Integer getMaxRecordsPerBatch()
      When generating values for a list of records that are split into batches, the maximum number of records per batch.
      Returns:
      Current maxRecordsPerBatch value. Default value is null

    • setMaxValue

      public AIFieldRequest setMaxValue(Integer maxValue)
      If the valueClass is INTERVAL or RATIO, the maximum value that can be generated. If null, then there is no maximum.
      Parameters:
      maxValue - New maxValue value. Default value is null
      Returns:
      AIFieldRequest instance, for chaining setter calls

    • getMaxValue

      public Integer getMaxValue()
      If the valueClass is INTERVAL or RATIO, the maximum value that can be generated. If null, then there is no maximum.
      Returns:
      Current maxValue value. Default value is null

    • setMinValue

      public AIFieldRequest setMinValue(Integer minValue)
      If the valueClass is INTERVAL or RATIO, the minimum value that can be generated. If null, then there is no minimum.
      Parameters:
      minValue - New minValue value. Default value is null
      Returns:
      AIFieldRequest instance, for chaining setter calls

    • getMinValue

      public Integer getMinValue()
      If the valueClass is INTERVAL or RATIO, the minimum value that can be generated. If null, then there is no minimum.
      Returns:
      Current minValue value. Default value is null

    • setRelevantFieldNames

      public AIFieldRequest setRelevantFieldNames(String... relevantFieldNames)
      The names of fields that are relevant to each SummarizeRecordsRequest.
      Parameters:
      relevantFieldNames - New relevantFieldNames value. Default value is null
      Returns:
      AIFieldRequest instance, for chaining setter calls
      See Also:

    • getRelevantFieldNames

      public String[] getRelevantFieldNames()
      The names of fields that are relevant to each SummarizeRecordsRequest.
      Returns:
      Current relevantFieldNames value. Default value is null
      See Also:

    • setValueClass

      public AIFieldRequest setValueClass(ValueClass valueClass)
      The class of value that AI will be asked to generate for the field.
      Parameters:
      valueClass - New valueClass value. Default value is "general"
      Returns:
      AIFieldRequest instance, for chaining setter calls

    • getValueClass

      public ValueClass getValueClass()
      The class of value that AI will be asked to generate for the field.
      Returns:
      Current valueClass value. Default value is "general"