public class SummarizeRecordsRequest extends DataClass
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.
factoryCreated, factoryProperties
Constructor and Description |
---|
SummarizeRecordsRequest() |
SummarizeRecordsRequest(com.google.gwt.core.client.JavaScriptObject jsObj) |
Modifier and Type | Method and Description |
---|---|
CancellationController |
getCancellationController()
If provided, the
CancellationController that will be looked to for whether the record
summarization operation is canceled. |
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 . |
UserAIRequest |
getUserAIRequest()
The natural language description of how to summarize each record, which may include a request for relevant supplemental
information.
|
SummarizeRecordsRequest |
setCancellationController(CancellationController cancellationController)
If provided, the
CancellationController that will be looked to for whether the record
summarization operation is canceled. |
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 . |
SummarizeRecordsRequest |
setUserAIRequest(UserAIRequest userAIRequest)
The natural language description of how to summarize each record, which may include a request for relevant supplemental
information.
|
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
public SummarizeRecordsRequest()
public SummarizeRecordsRequest(com.google.gwt.core.client.JavaScriptObject jsObj)
public static SummarizeRecordsRequest getOrCreateRef(com.google.gwt.core.client.JavaScriptObject jsObj)
public SummarizeRecordsRequest setCancellationController(CancellationController cancellationController)
CancellationController
that will be looked to for whether the record
summarization operation is canceled.cancellationController
- 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.public SummarizeRecordsRequest setDataSource(DataSource dataSource)
DataSource
containing the records
.dataSource
- New dataSource value. Default value is nullSummarizeRecordsRequest
instance, for chaining setter callspublic DataSource getDataSource()
DataSource
containing the records
.public 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)
userAIRequest
'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()
userAIRequest
'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)
maxRetries
- New maxRetries value. Default value is 2SummarizeRecordsRequest
instance, for chaining setter callspublic java.lang.Integer getMaxRetries()
public SummarizeRecordsRequest setRecords(Record... records)
DataSource
dataSource
.records
- New records value. Default value is nullSummarizeRecordsRequest
instance, for chaining setter callspublic Record[] getRecords()
DataSource
dataSource
.public SummarizeRecordsRequest setUserAIRequest(UserAIRequest userAIRequest)
userAIRequest
- New userAIRequest value. Default value is nullSummarizeRecordsRequest
instance, for chaining setter callspublic UserAIRequest getUserAIRequest()