Package com.smartgwt.client.ai

Class SummarizeRecordsPartialResult

java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.util.AsyncOperationResult
com.smartgwt.client.ai.SummarizeRecordsPartialResult
All Implemented Interfaces:
HasHandlers
public class SummarizeRecordsPartialResult extends AsyncOperationResult
The result for a batch of records in a record summarization operation.

  • Constructor Details

    • SummarizeRecordsPartialResult

      public SummarizeRecordsPartialResult()

    • SummarizeRecordsPartialResult

      public SummarizeRecordsPartialResult(JavaScriptObject jsObj)

  • Method Details

    • getOrCreateRef

      public static SummarizeRecordsPartialResult getOrCreateRef(JavaScriptObject jsObj)

    • setLength

      public SummarizeRecordsPartialResult setLength(Integer length)
      The number of records in the batch.
      Parameters:
      length - New length value. Default value is *initialized by the implementation*
      Returns:
      SummarizeRecordsPartialResult instance, for chaining setter calls

    • getLength

      public Integer getLength()
      The number of records in the batch.
      Returns:
      Current length value. Default value is *initialized by the implementation*

    • setRecordNumericalSummaries

      public SummarizeRecordsPartialResult setRecordNumericalSummaries(int... recordNumericalSummaries)
      If successful and the SummarizeRecordsRequest.aiFieldRequest is numerical,
      • If the valueClass is ORDINAL, the 0-based index of the category in the ordered list of AIFieldRequest.categories
      • The computed numerical value
      .. for the corresponding records in the batch.

      This array will have the same length as the batch.

      Parameters:
      recordNumericalSummaries - New recordNumericalSummaries value. Default value is *initialized by the implementation*
      Returns:
      SummarizeRecordsPartialResult instance, for chaining setter calls

    • getRecordNumericalSummaries

      public int[] getRecordNumericalSummaries()
      If successful and the SummarizeRecordsRequest.aiFieldRequest is numerical,
      • If the valueClass is ORDINAL, the 0-based index of the category in the ordered list of AIFieldRequest.categories
      • The computed numerical value
      .. for the corresponding records in the batch.

      This array will have the same length as the batch.

      Returns:
      Current recordNumericalSummaries value. Default value is *initialized by the implementation*

    • setRecordSummaries

      public SummarizeRecordsPartialResult setRecordSummaries(String... recordSummaries)
      If successful and the SummarizeRecordsRequest.aiFieldRequest is not numerical, the generated record summaries (text) or unordered categories for the corresponding records in the batch.

      This array will have the same length as the batch.

      Parameters:
      recordSummaries - New recordSummaries value. Default value is *initialized by the implementation*
      Returns:
      SummarizeRecordsPartialResult instance, for chaining setter calls

    • getRecordSummaries

      public String[] getRecordSummaries()
      If successful and the SummarizeRecordsRequest.aiFieldRequest is not numerical, the generated record summaries (text) or unordered categories for the corresponding records in the batch.

      This array will have the same length as the batch.

      Returns:
      Current recordSummaries value. Default value is *initialized by the implementation*

    • setStartIndex

      public SummarizeRecordsPartialResult setStartIndex(Integer startIndex)
      Starting index of the batch within the records of the SummarizeRecordsRequest.
      Parameters:
      startIndex - New startIndex value. Default value is *initialized by the implementation*
      Returns:
      SummarizeRecordsPartialResult instance, for chaining setter calls

    • getStartIndex

      public Integer getStartIndex()
      Starting index of the batch within the records of the SummarizeRecordsRequest.
      Returns:
      Current startIndex value. Default value is *initialized by the implementation*