public class SummarizeRecordsRequest extends DataBoundAIRequest
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.
idfactoryCreated, factoryProperties| Constructor and Description |
|---|
SummarizeRecordsRequest() |
SummarizeRecordsRequest(com.google.gwt.core.client.JavaScriptObject jsObj) |
| Modifier and Type | Method and 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. |
java.lang.Integer |
getMaxConcurrent()
Maximum number of batches being summarized at any given time.
|
java.lang.Integer |
getMaxRecordsPerBatch()
If set, the maximum number of records that will be processed via AI in a single request.
|
java.lang.Integer |
getMaxRetries()
The maximum number of retries of any one particular request to an
AIEngine. |
static SummarizeRecordsRequest |
getOrCreateRef(com.google.gwt.core.client.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(java.lang.Integer maxConcurrent)
Maximum number of batches being summarized at any given time.
|
SummarizeRecordsRequest |
setMaxRecordsPerBatch(java.lang.Integer maxRecordsPerBatch)
If set, the maximum number of records that will be processed via AI in a single request.
|
SummarizeRecordsRequest |
setMaxRetries(java.lang.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. |
getExcludeFieldNames, setExcludeFieldNamesgetRef, getRef, internalSetIDapplyFactoryProperties, 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, setFactoryCreatedpublic SummarizeRecordsRequest()
public SummarizeRecordsRequest(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SummarizeRecordsRequest getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public SummarizeRecordsRequest setAIFieldRequest(AIFieldRequest aiFieldRequest)
AIFieldRequest generated from a natural language description of how to summarize each
record, which may include a request for relevant supplemental information.aiFieldRequest - New aiFieldRequest value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callsAI.buildAIFieldRequest(com.smartgwt.client.ai.BuildAIFieldRequestRequest, com.smartgwt.client.callbacks.BuildAIFieldRequestResponseCallback)public AIFieldRequest getAIFieldRequest()
AIFieldRequest generated from a natural language description of how to summarize each
record, which may include a request for relevant supplemental information.AI.buildAIFieldRequest(com.smartgwt.client.ai.BuildAIFieldRequestRequest, com.smartgwt.client.callbacks.BuildAIFieldRequestResponseCallback)public SummarizeRecordsRequest setAiFieldRequestSource(AIMessageSource aiFieldRequestSource)
aiFieldRequest.aiFieldRequestSource - New aiFieldRequestSource value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic AIMessageSource getAiFieldRequestSource()
aiFieldRequest.public SummarizeRecordsRequest setCancellationController(CancellationController cancellationController)
CancellationController that will be looked to for whether the record
summarization operation is canceled.setCancellationController in class AsyncOperationParamscancellationController - New cancellationController value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic CancellationController getCancellationController()
CancellationController that will be looked to for whether the record
summarization operation is canceled.getCancellationController in class AsyncOperationParamspublic SummarizeRecordsRequest setComponent(DataBoundComponent component)
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.
setComponent in class AsyncDataBoundOperationParamscomponent - New component value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic DataBoundComponent getComponent()
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.
getComponent in class AsyncDataBoundOperationParamspublic SummarizeRecordsRequest setDataSource(DataSource dataSource)
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.
setDataSource in class AsyncDataBoundOperationParamsdataSource - New dataSource value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic DataSource getDataSource()
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.
getDataSource in class AsyncDataBoundOperationParamspublic SummarizeRecordsRequest setMaxConcurrent(java.lang.Integer maxConcurrent)
maxConcurrent - New maxConcurrent value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic java.lang.Integer getMaxConcurrent()
public SummarizeRecordsRequest setMaxRecordsPerBatch(java.lang.Integer maxRecordsPerBatch)
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
maxRecordsPerBatch - New maxRecordsPerBatch value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic java.lang.Integer getMaxRecordsPerBatch()
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).
public SummarizeRecordsRequest setMaxRetries(java.lang.Integer maxRetries)
AIEngine.setMaxRetries in class DataBoundAIRequestmaxRetries - New maxRetries value. Default value is 2SummarizeRecordsRequest instance, for chaining setter callspublic java.lang.Integer getMaxRetries()
AIEngine.getMaxRetries in class DataBoundAIRequestpublic SummarizeRecordsRequest setRecords(Record... records)
DataSource dataSource.records - New records value. Default value is nullSummarizeRecordsRequest instance, for chaining setter callspublic Record[] getRecords()
DataSource dataSource.