Class DataBoundAIRequest

All Implemented Interfaces:
HasHandlers
Direct Known Subclasses:
SuggestRecordSummaryTitleRequest, SummarizeRecordsRequest, SummarizeValueRequest

public class DataBoundAIRequest extends AsyncDataBoundOperationParams
  • Constructor Details

    • DataBoundAIRequest

      public DataBoundAIRequest()
    • DataBoundAIRequest

      public DataBoundAIRequest(JavaScriptObject jsObj)
  • Method Details

    • getOrCreateRef

      public static DataBoundAIRequest getOrCreateRef(JavaScriptObject jsObj)
    • setExcludeFieldNames

      public DataBoundAIRequest setExcludeFieldNames(String... excludeFieldNames)
      Optional list of field names to exclude. This is a deny list.
      Parameters:
      excludeFieldNames - New excludeFieldNames value. Default value is null
      Returns:
      DataBoundAIRequest instance, for chaining setter calls
      See Also:
    • getExcludeFieldNames

      public String[] getExcludeFieldNames()
      Optional list of field names to exclude. This is a deny list.
      Returns:
      Current excludeFieldNames value. Default value is null
      See Also:
    • setMaxRetries

      public DataBoundAIRequest setMaxRetries(Integer maxRetries)
      The maximum number of retries for any one particular request to AI.

      Note that multiple AI requests may be involved in processing the data-bound AI request. This limit is the maximum number of retries of any one request. For example, if there are 2 requests made to AI, then each one would be submitted at most 1 + maxRetries number of times for up to 2 * (1 + maxRetries) total requests.

      If unset, then defaultMaxRetries will be used.

      Parameters:
      maxRetries - New maxRetries value. Default value is null
      Returns:
      DataBoundAIRequest instance, for chaining setter calls
    • getMaxRetries

      public Integer getMaxRetries()
      The maximum number of retries for any one particular request to AI.

      Note that multiple AI requests may be involved in processing the data-bound AI request. This limit is the maximum number of retries of any one request. For example, if there are 2 requests made to AI, then each one would be submitted at most 1 + maxRetries number of times for up to 2 * (1 + maxRetries) total requests.

      If unset, then defaultMaxRetries will be used.

      Returns:
      Current maxRetries value. Default value is null