Package com.smartgwt.client.ai

Class SummarizeRecordsRequest

java.lang.Object

com.smartgwt.client.core.JsObject

com.smartgwt.client.core.DataClass

com.smartgwt.client.core.RefDataClass

com.smartgwt.client.util.AsyncOperationParams

com.smartgwt.client.util.AsyncDataBoundOperationParams

com.smartgwt.client.ai.DataBoundAIRequest

com.smartgwt.client.ai.SummarizeRecordsRequest

All Implemented Interfaces:

HasHandlers

public class SummarizeRecordsRequest
extends DataBoundAIRequest

Represents a request to AI to generate summaries of records, using data in the records, relevant general knowledge, and reasonable inferences from the data. Summaries may include relevant supplemental information for each record.

The provided records are split into batches of varying lengths (see maxRecordsPerBatch). For each batch, a SummarizeRecordsPartialResult will be generated with either information about the reason for a non-successful outcome, or the generated summaries for records in the batch.

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	Description
SummarizeRecordsRequest()
SummarizeRecordsRequest(JavaScriptObject jsObj)

Method Summary

Modifier and Type	Method	Description
AIFieldRequest	getAIFieldRequest()	The AIFieldRequest generated from a natural language description of how to summarize each record, which may include a request for relevant supplemental information.
AIMessageSource	getAiFieldRequestSource()	The source of the aiFieldRequest.
CancellationController	getCancellationController()	If provided, the CancellationController that will be looked to for whether the record summarization operation is canceled.
DataBoundComponent	getComponent()	If specified, the DataBoundComponent that is displaying or managing the records.
DataSource	getDataSource()	The DataSource containing the records.
Integer	getMaxConcurrent()	Maximum number of batches being summarized at any given time.
Integer	getMaxRecordsPerBatch()	If set, the maximum number of records that will be processed via AI in a single request.
Integer	getMaxRetries()	The maximum number of retries of any one particular request to an AIEngine.
static SummarizeRecordsRequest	getOrCreateRef(JavaScriptObject jsObj)
Record[]	getRecords()	The records to summarize, from DataSource dataSource.
SummarizeRecordsRequest	setAIFieldRequest(AIFieldRequest aiFieldRequest)	The AIFieldRequest generated from a natural language description of how to summarize each record, which may include a request for relevant supplemental information.
SummarizeRecordsRequest	setAiFieldRequestSource(AIMessageSource aiFieldRequestSource)	The source of the aiFieldRequest.
SummarizeRecordsRequest	setCancellationController(CancellationController cancellationController)	If provided, the CancellationController that will be looked to for whether the record summarization operation is canceled.
SummarizeRecordsRequest	setComponent(DataBoundComponent component)	If specified, the DataBoundComponent that is displaying or managing the records.
SummarizeRecordsRequest	setDataSource(DataSource dataSource)	The DataSource containing the records.
SummarizeRecordsRequest	setMaxConcurrent(Integer maxConcurrent)	Maximum number of batches being summarized at any given time.
SummarizeRecordsRequest	setMaxRecordsPerBatch(Integer maxRecordsPerBatch)	If set, the maximum number of records that will be processed via AI in a single request.
SummarizeRecordsRequest	setMaxRetries(Integer maxRetries)	The maximum number of retries of any one particular request to an AIEngine.
SummarizeRecordsRequest	setRecords(Record... records)	The records to summarize, from DataSource dataSource.

Methods inherited from class com.smartgwt.client.ai.DataBoundAIRequest

getExcludeFieldNames, setExcludeFieldNames

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 Details

SummarizeRecordsRequest

public SummarizeRecordsRequest()

SummarizeRecordsRequest

public SummarizeRecordsRequest(JavaScriptObject jsObj)

Method Details

getOrCreateRef

public static SummarizeRecordsRequest getOrCreateRef(JavaScriptObject jsObj)

setAIFieldRequest

public SummarizeRecordsRequest setAIFieldRequest(AIFieldRequest aiFieldRequest)

The AIFieldRequest generated from a natural language description of how to summarize each record, which may include a request for relevant supplemental information.

Parameters:

aiFieldRequest - New aiFieldRequest value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

See Also:

• AI.buildAIFieldRequest(com.smartgwt.client.ai.BuildAIFieldRequestRequest, com.smartgwt.client.callbacks.BuildAIFieldRequestResponseCallback)

getAIFieldRequest

public AIFieldRequest getAIFieldRequest()

The AIFieldRequest generated from a natural language description of how to summarize each record, which may include a request for relevant supplemental information.

Returns:

Current aiFieldRequest value. Default value is null

See Also:

• AI.buildAIFieldRequest(com.smartgwt.client.ai.BuildAIFieldRequestRequest, com.smartgwt.client.callbacks.BuildAIFieldRequestResponseCallback)

setAiFieldRequestSource

public SummarizeRecordsRequest setAiFieldRequestSource(AIMessageSource aiFieldRequestSource)

The source of the aiFieldRequest.

Parameters:

aiFieldRequestSource - New aiFieldRequestSource value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getAiFieldRequestSource

public AIMessageSource getAiFieldRequestSource()

The source of the aiFieldRequest.

Returns:

Current aiFieldRequestSource value. Default value is null

setCancellationController

public SummarizeRecordsRequest setCancellationController(CancellationController cancellationController)

If provided, the CancellationController that will be looked to for whether the record summarization operation is canceled.

Overrides:

setCancellationController in class AsyncOperationParams

Parameters:

cancellationController - New cancellationController value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getCancellationController

public CancellationController getCancellationController()

If provided, the CancellationController that will be looked to for whether the record summarization operation is canceled.

Overrides:

getCancellationController in class AsyncOperationParams

Returns:

Current cancellationController value. Default value is null

setComponent

public SummarizeRecordsRequest setComponent(DataBoundComponent component)

If specified, the DataBoundComponent that is displaying or managing the records.

The component should be bound to the same dataSource of the request or a DataSource inheriting from it.

Overrides:

setComponent in class AsyncDataBoundOperationParams

Parameters:

component - New component value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getComponent

public DataBoundComponent getComponent()

If specified, the DataBoundComponent that is displaying or managing the records.

The component should be bound to the same dataSource of the request or a DataSource inheriting from it.

Overrides:

getComponent in class AsyncDataBoundOperationParams

Returns:

Current component value. Default value is null

setDataSource

public SummarizeRecordsRequest setDataSource(DataSource dataSource)

The DataSource containing the records.

If component is also specified, then the component should be bound to the same DataSource or a DataSource inheriting from it.

Overrides:

setDataSource in class AsyncDataBoundOperationParams

Parameters:

dataSource - New dataSource value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getDataSource

public DataSource getDataSource()

The DataSource containing the records.

If component is also specified, then the component should be bound to the same DataSource or a DataSource inheriting from it.

Overrides:

getDataSource in class AsyncDataBoundOperationParams

Returns:

Current dataSource value. Default value is null

setMaxConcurrent

public SummarizeRecordsRequest setMaxConcurrent(Integer maxConcurrent)

Maximum number of batches being summarized at any given time.

Parameters:

maxConcurrent - New maxConcurrent value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getMaxConcurrent

public Integer getMaxConcurrent()

Maximum number of batches being summarized at any given time.

Returns:

Current maxConcurrent value. Default value is null

setMaxRecordsPerBatch

public SummarizeRecordsRequest setMaxRecordsPerBatch(Integer maxRecordsPerBatch)

If set, the maximum number of records that will be processed via AI in a single request. This can be further or alternatively limited by the aiFieldRequest's maxRecordsPerBatch setting.

By default, requests will be filled with as many records as will fit into a single request to the selected AIEngine(s).

Note : This is an advanced setting

Parameters:

maxRecordsPerBatch - New maxRecordsPerBatch value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getMaxRecordsPerBatch

public Integer getMaxRecordsPerBatch()

If set, the maximum number of records that will be processed via AI in a single request. This can be further or alternatively limited by the aiFieldRequest's maxRecordsPerBatch setting.

By default, requests will be filled with as many records as will fit into a single request to the selected AIEngine(s).

Returns:

Current maxRecordsPerBatch value. Default value is null

setMaxRetries

public SummarizeRecordsRequest setMaxRetries(Integer maxRetries)

The maximum number of retries of any one particular request to an AIEngine.

Overrides:

setMaxRetries in class DataBoundAIRequest

Parameters:

maxRetries - New maxRetries value. Default value is 2

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getMaxRetries

public Integer getMaxRetries()

The maximum number of retries of any one particular request to an AIEngine.

Overrides:

getMaxRetries in class DataBoundAIRequest

Returns:

Current maxRetries value. Default value is 2

setRecords

public SummarizeRecordsRequest setRecords(Record... records)

The records to summarize, from DataSource dataSource.

Parameters:

records - New records value. Default value is null

Returns:

SummarizeRecordsRequest instance, for chaining setter calls

getRecords

public Record[] getRecords()

The records to summarize, from DataSource dataSource.

Returns:

Current records value. Default value is null