Class SummarizeValueRequest
- All Implemented Interfaces:
HasHandlers
-
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 TypeMethodDescriptionThe natural language description of how to summarize the value, which may include a request for relevant supplemental information.The source of theaiRequest.If specified, theDataBoundComponentdisplaying thevalue.If specified, theDataSourcewhere thevalueoriginated.If specified, examples to provide to AI.If specified, the name of the field containing thevalue.static SummarizeValueRequestgetOrCreateRef(JavaScriptObject jsObj) String[]If specified, the names of theDBCFields of thecomponent(orDataSourceFields of thedataSource) that are relevant to the request to summarize thevalue.getValue()The value to summarize.The type of thevalue.setAIRequest(SingleSourceAIRequest aiRequest) The natural language description of how to summarize the value, which may include a request for relevant supplemental information.setAIRequestSource(AIMessageSource aiRequestSource) The source of theaiRequest.setComponent(DataBoundComponent component) If specified, theDataBoundComponentdisplaying thevalue.setDataSource(DataSource dataSource) If specified, theDataSourcewhere thevalueoriginated.setExamples(SummarizeValueExample... examples) If specified, examples to provide to AI.setFieldName(String fieldName) If specified, the name of the field containing thevalue.setRelevantFieldNames(String... relevantFieldNames) If specified, the names of theDBCFields of thecomponent(orDataSourceFields of thedataSource) that are relevant to the request to summarize thevalue.The value to summarize.setValueType(AIContentType valueType) The type of thevalue.Methods inherited from class com.smartgwt.client.ai.DataBoundAIRequest
getExcludeFieldNames, getMaxRetries, setExcludeFieldNames, setMaxRetriesMethods inherited from class com.smartgwt.client.util.AsyncOperationParams
getCancellationController, setCancellationControllerMethods 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
-
SummarizeValueRequest
public SummarizeValueRequest() -
SummarizeValueRequest
-
-
Method Details
-
getOrCreateRef
-
setAIRequest
The natural language description of how to summarize the value, which may include a request for relevant supplemental information.Note: For more consistently-formatted AI-generated summaries of values, it is often helpful to specify
examplesthat include the desired output form.- Parameters:
aiRequest- New aiRequest value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getAIRequest
The natural language description of how to summarize the value, which may include a request for relevant supplemental information.Note: For more consistently-formatted AI-generated summaries of values, it is often helpful to specify
examplesthat include the desired output form.- Returns:
- Current aiRequest value. Default value is null
-
setAIRequestSource
The source of theaiRequest.- Parameters:
aiRequestSource- New aiRequestSource value. Default value is "system"- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getAIRequestSource
The source of theaiRequest.- Returns:
- Current aiRequestSource value. Default value is "system"
-
setComponent
If specified, theDataBoundComponentdisplaying thevalue.If
dataSourceis also specified, then the component should be bound to the sameDataSourceor aDataSourceinheriting from it.- Overrides:
setComponentin classAsyncDataBoundOperationParams- Parameters:
component- New component value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getComponent
If specified, theDataBoundComponentdisplaying thevalue.If
dataSourceis also specified, then the component should be bound to the sameDataSourceor aDataSourceinheriting from it.- Overrides:
getComponentin classAsyncDataBoundOperationParams- Returns:
- Current component value. Default value is null
-
setDataSource
If specified, theDataSourcewhere thevalueoriginated.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:
SummarizeValueRequestinstance, for chaining setter calls
-
getDataSource
If specified, theDataSourcewhere thevalueoriginated.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
-
setExamples
If specified, examples to provide to AI.Examples that include the desired output form often help to make the formatting of AI-generated summaries of values more consistent.
- Parameters:
examples- New examples value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getExamples
If specified, examples to provide to AI.Examples that include the desired output form often help to make the formatting of AI-generated summaries of values more consistent.
- Returns:
- Current examples value. Default value is null
-
setFieldName
If specified, the name of the field containing thevalue.- Parameters:
fieldName- New fieldName value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls- See Also:
-
getFieldName
If specified, the name of the field containing thevalue.- Returns:
- Current fieldName value. Default value is null
- See Also:
-
setRecord
If specified, theRecordcontaining thevalue.If supplying the record, then the
componentand/ordataSourcemust be specified as well.- Parameters:
record- New record value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getRecord
If specified, theRecordcontaining thevalue.If supplying the record, then the
componentand/ordataSourcemust be specified as well.- Returns:
- Current record value. Default value is null
-
setRelevantFieldNames
If specified, the names of theDBCFields of thecomponent(orDataSourceFields of thedataSource) that are relevant to the request to summarize thevalue.- Parameters:
relevantFieldNames- New relevantFieldNames value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls- See Also:
-
getRelevantFieldNames
If specified, the names of theDBCFields of thecomponent(orDataSourceFields of thedataSource) that are relevant to the request to summarize thevalue.- Returns:
- Current relevantFieldNames value. Default value is null
- See Also:
-
setValue
The value to summarize. Its type is specified by thevalueType.- Parameters:
value- New value value. Default value is null- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getValue
The value to summarize. Its type is specified by thevalueType.- Returns:
- Current value value. Default value is null
-
setValueType
The type of thevalue.- Parameters:
valueType- New valueType value. Default value is "text"- Returns:
SummarizeValueRequestinstance, for chaining setter calls
-
getValueType
The type of thevalue.- Returns:
- Current valueType value. Default value is "text"
-