com.smartgwt.client.ai

## Class SummarizeRecordsResult

- 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.SummarizeRecordsResult

- All Implemented Interfaces:
    com.google.gwt.event.shared.HasHandlers

      public class SummarizeRecordsResult
      extends AsyncOperationResult

  The result of 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
    `SummarizeRecordsResult()`
    `SummarizeRecordsResult(com.google.gwt.core.client.JavaScriptObject jsObj)`

  - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `static SummarizeRecordsResult` | `getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)`
    `SummarizeRecordsPartialResult[]` | `getPartialResults()` All partial results.
    `int[]` | `getRecordNumericalSummaries()` If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is not `numerical`, `null`; otherwise: 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 any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is `numerical`, `null`; otherwise, the generated summaries (text) or unordered categories for the corresponding `records` of the `request`.
    `SummarizeRecordsResult` | `setPartialResults(SummarizeRecordsPartialResult... partialResults)` All partial results.
    `SummarizeRecordsResult` | `setRecordNumericalSummaries(int... recordNumericalSummaries)` If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is not `numerical`, `null`; otherwise: If the `valueClass` is ORDINAL, the 0-based index of the category in the ordered list of `AIFieldRequest.categories` The computed numerical value ..
    `SummarizeRecordsResult` | `setRecordSummaries(java.lang.String... recordSummaries)` If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is `numerical`, `null`; otherwise, the generated summaries (text) or unordered categories for the corresponding `records` of the `request`.

    - ### 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

    - #### SummarizeRecordsResult

          public SummarizeRecordsResult()

    - #### SummarizeRecordsResult

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

  - ### Method Detail

    - #### getOrCreateRef

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

    - #### setPartialResults

          public SummarizeRecordsResult setPartialResults(SummarizeRecordsPartialResult... partialResults)

      All partial results. There will be at most one `SummarizeRecordsPartialResult` covering each `record` of the `request`. Note: there may be no `SummarizeRecordsPartialResult` for a record if the record summarization operation is canceled or fails early.

      The order of `SummarizeRecordsPartialResult` objects in the array is unspecified.

      This property may be `null` if an error occurs early.

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

    - #### getPartialResults

          public SummarizeRecordsPartialResult[] getPartialResults()

      All partial results. There will be at most one `SummarizeRecordsPartialResult` covering each `record` of the `request`. Note: there may be no `SummarizeRecordsPartialResult` for a record if the record summarization operation is canceled or fails early.

      The order of `SummarizeRecordsPartialResult` objects in the array is unspecified.

      This property may be `null` if an error occurs early.

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

    - #### setRecordNumericalSummaries

          public SummarizeRecordsResult setRecordNumericalSummaries(int... recordNumericalSummaries)

      If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is not `numerical`, `null`; otherwise:
      - 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` of the `request`.
      Parameters:
        `recordNumericalSummaries` - New recordNumericalSummaries value. Default value is *initialized by the implementation*
      Returns:
        `SummarizeRecordsResult` instance, for chaining setter calls
      See Also:
        `setRecordSummaries(java.lang.String...)`

    - #### getRecordNumericalSummaries

          public int[] getRecordNumericalSummaries()

      If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is not `numerical`, `null`; otherwise:
      - 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` of the `request`.
      Returns:
        Current recordNumericalSummaries value. Default value is *initialized by the implementation*
      See Also:
        `getRecordSummaries()`

    - #### setRecordSummaries

          public SummarizeRecordsResult setRecordSummaries(java.lang.String... recordSummaries)

      If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is `numerical`, `null`; otherwise, the generated summaries (text) or unordered categories for the corresponding `records` of the `request`.
      Parameters:
        `recordSummaries` - New recordSummaries value. Default value is *initialized by the implementation*
      Returns:
        `SummarizeRecordsResult` instance, for chaining setter calls
      See Also:
        `setRecordNumericalSummaries(int...)`

    - #### getRecordSummaries

          public java.lang.String[] getRecordSummaries()

      If any batch is non-successful or the `SummarizeRecordsRequest.aiFieldRequest` is `numerical`, `null`; otherwise, the generated summaries (text) or unordered categories for the corresponding `records` of the `request`.
      Returns:
        Current recordSummaries value. Default value is *initialized by the implementation*
      See Also:
        `getRecordNumericalSummaries()`