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:
    com.google.gwt.event.shared.HasHandlers

      public class SummarizeRecordsPartialResult
      extends AsyncOperationResult

  The result for a batch of records in a record summarization operation.

- - ### Field Summary

    - ### Fields inherited from class com.smartgwt.client.core.RefDataClass

      `id`

    - ### Fields inherited from class com.smartgwt.client.core.DataClass

      `factoryCreated, factoryProperties`

    - ### Fields inherited from class com.smartgwt.client.core.JsObject

      `jsObj`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `SummarizeRecordsPartialResult()`
    `SummarizeRecordsPartialResult(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `java.lang.Integer` | `getLength()` The number of records in the batch.
    `static SummarizeRecordsPartialResult` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `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 ..
    `java.lang.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.
    `java.lang.Integer` | `getStartIndex()` Starting index of the batch within the `records` of the `SummarizeRecordsRequest`.
    `SummarizeRecordsPartialResult` | `setLength(java.lang.Integer length)` The number of records in the batch.
    `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 ..
    `SummarizeRecordsPartialResult` | `setRecordSummaries(java.lang.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.
    `SummarizeRecordsPartialResult` | `setStartIndex(java.lang.Integer startIndex)` Starting index of the batch within the `records` of the `SummarizeRecordsRequest`.

    - ### Methods inherited from class com.smartgwt.client.util.AsyncOperationResult

      `getCancellationReason, getDisabledMessage, getErrorMessage, getType, setCancellationReason, setDisabledMessage, setErrorMessage, setType`

    - ### Methods inherited from class com.smartgwt.client.core.RefDataClass

      `getRef, getRef, internalSetID`

    - ### Methods inherited from class com.smartgwt.client.core.DataClass

      `applyFactoryProperties, doAddHandler, fireEvent, getAttribute, getAttributeAsBoolean, getAttributeAsBoolean, getAttributeAsDate, getAttributeAsDouble, getAttributeAsDoubleArray, getAttributeAsElement, getAttributeAsFloat, getAttributeAsInt, getAttributeAsIntArray, getAttributeAsJavaScriptObject, getAttributeAsLong, getAttributeAsMap, getAttributeAsObject, getAttributeAsRecord, getAttributeAsString, getAttributeAsStringArray, getAttributes, getHandlerCount, isFactoryCreated, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttribute, setAttributeAsJavaObject, setFactoryCreated`

    - ### Methods inherited from class com.smartgwt.client.core.JsObject

      `equals, getJsObj, hashCode, isCreated, setJavaScriptObject, setJsObj`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait`

- - ### Constructor Detail

    - #### SummarizeRecordsPartialResult

          public SummarizeRecordsPartialResult()

    - #### SummarizeRecordsPartialResult

          public SummarizeRecordsPartialResult(com.google.gwt.core.client.JavaScriptObject jsObj)

  - ### Method Detail

    - #### getOrCreateRef

          public static SummarizeRecordsPartialResult getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)

    - #### setLength

          public SummarizeRecordsPartialResult setLength(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.Integer getStartIndex()

      Starting index of the batch within the `records` of the `SummarizeRecordsRequest`.
      Returns:
        Current startIndex value. Default value is *initialized by the implementation*