Class SummarizeRecordsRequest
- All Implemented Interfaces:
HasHandlers
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
idFields inherited from class com.smartgwt.client.core.DataClass
factoryCreated, factoryProperties -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionTheAIFieldRequestgenerated from a natural language description of how to summarize each record, which may include a request for relevant supplemental information.The source of theaiFieldRequest.If provided, theCancellationControllerthat will be looked to for whether the record summarization operation is canceled.If specified, theDataBoundComponentthat is displaying or managing therecords.TheDataSourcecontaining therecords.Maximum number of batches being summarized at any given time.If set, the maximum number of records that will be processed via AI in a single request.The maximum number of retries of any one particular request to anAIEngine.static SummarizeRecordsRequestgetOrCreateRef(JavaScriptObject jsObj) Record[]The records to summarize, fromDataSourcedataSource.setAIFieldRequest(AIFieldRequest aiFieldRequest) TheAIFieldRequestgenerated from a natural language description of how to summarize each record, which may include a request for relevant supplemental information.setAiFieldRequestSource(AIMessageSource aiFieldRequestSource) The source of theaiFieldRequest.setCancellationController(CancellationController cancellationController) If provided, theCancellationControllerthat will be looked to for whether the record summarization operation is canceled.setComponent(DataBoundComponent component) If specified, theDataBoundComponentthat is displaying or managing therecords.setDataSource(DataSource dataSource) TheDataSourcecontaining therecords.setMaxConcurrent(Integer maxConcurrent) Maximum number of batches being summarized at any given time.setMaxRecordsPerBatch(Integer maxRecordsPerBatch) If set, the maximum number of records that will be processed via AI in a single request.setMaxRetries(Integer maxRetries) The maximum number of retries of any one particular request to anAIEngine.setRecords(Record... records) The records to summarize, fromDataSourcedataSource.Methods inherited from class com.smartgwt.client.ai.DataBoundAIRequest
getExcludeFieldNames, setExcludeFieldNamesMethods inherited from class com.smartgwt.client.core.RefDataClass
getRef, getRef, internalSetIDMethods 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
-
Constructor Details
-
SummarizeRecordsRequest
public SummarizeRecordsRequest() -
SummarizeRecordsRequest
-
-
Method Details
-
getOrCreateRef
-
setAIFieldRequest
TheAIFieldRequestgenerated 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:
SummarizeRecordsRequestinstance, for chaining setter calls- See Also:
-
getAIFieldRequest
TheAIFieldRequestgenerated 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:
-
setAiFieldRequestSource
The source of theaiFieldRequest.- Parameters:
aiFieldRequestSource- New aiFieldRequestSource value. Default value is null- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getAiFieldRequestSource
The source of theaiFieldRequest.- Returns:
- Current aiFieldRequestSource value. Default value is null
-
setCancellationController
public SummarizeRecordsRequest setCancellationController(CancellationController cancellationController) If provided, theCancellationControllerthat will be looked to for whether the record summarization operation is canceled.- Overrides:
setCancellationControllerin classAsyncOperationParams- Parameters:
cancellationController- New cancellationController value. Default value is null- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getCancellationController
If provided, theCancellationControllerthat will be looked to for whether the record summarization operation is canceled.- Overrides:
getCancellationControllerin classAsyncOperationParams- Returns:
- Current cancellationController value. Default value is null
-
setComponent
If specified, theDataBoundComponentthat is displaying or managing therecords.The component should be bound to the same
dataSourceof the request or aDataSourceinheriting from it.- Overrides:
setComponentin classAsyncDataBoundOperationParams- Parameters:
component- New component value. Default value is null- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getComponent
If specified, theDataBoundComponentthat is displaying or managing therecords.The component should be bound to the same
dataSourceof the request or aDataSourceinheriting from it.- Overrides:
getComponentin classAsyncDataBoundOperationParams- Returns:
- Current component value. Default value is null
-
setDataSource
TheDataSourcecontaining therecords.If
componentis also specified, then the component should be bound to the sameDataSourceor aDataSourceinheriting from it.- Overrides:
setDataSourcein classAsyncDataBoundOperationParams- Parameters:
dataSource- New dataSource value. Default value is null- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getDataSource
TheDataSourcecontaining therecords.If
componentis also specified, then the component should be bound to the sameDataSourceor aDataSourceinheriting from it.- Overrides:
getDataSourcein classAsyncDataBoundOperationParams- Returns:
- Current dataSource value. Default value is null
-
setMaxConcurrent
Maximum number of batches being summarized at any given time.- Parameters:
maxConcurrent- New maxConcurrent value. Default value is null- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getMaxConcurrent
Maximum number of batches being summarized at any given time.- Returns:
- Current maxConcurrent value. Default value is null
-
setMaxRecordsPerBatch
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 theaiFieldRequest'smaxRecordsPerBatchsetting.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:
SummarizeRecordsRequestinstance, for chaining setter calls
-
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 theaiFieldRequest'smaxRecordsPerBatchsetting.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
The maximum number of retries of any one particular request to anAIEngine.- Overrides:
setMaxRetriesin classDataBoundAIRequest- Parameters:
maxRetries- New maxRetries value. Default value is 2- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getMaxRetries
The maximum number of retries of any one particular request to anAIEngine.- Overrides:
getMaxRetriesin classDataBoundAIRequest- Returns:
- Current maxRetries value. Default value is 2
-
setRecords
The records to summarize, fromDataSourcedataSource.- Parameters:
records- New records value. Default value is null- Returns:
SummarizeRecordsRequestinstance, for chaining setter calls
-
getRecords
The records to summarize, fromDataSourcedataSource.- Returns:
- Current records value. Default value is null
-