Package com.smartgwt.client.ai
Class AIFieldRequest
java.lang.Object
com.smartgwt.client.core.JsObject
com.smartgwt.client.core.DataClass
com.smartgwt.client.core.RefDataClass
com.smartgwt.client.ai.SingleSourceAIRequest
com.smartgwt.client.ai.AIFieldRequest
- All Implemented Interfaces:
HasHandlers
Settings that configure requests to AI to generate the values for a field.
-
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 TypeMethodDescriptionString[]If thevalueClassis CATEGORICAL or ORDINAL, the list of available categories.When generating values for a list of records that are split into batches, the maximum number of records per batch.If thevalueClassis INTERVAL or RATIO, the maximum value that can be generated.If thevalueClassis INTERVAL or RATIO, the minimum value that can be generated.static AIFieldRequestgetOrCreateRef(JavaScriptObject jsObj) String[]The names of fields that are relevant to eachSummarizeRecordsRequest.The suggested initial sort direction for the field.The class of value that AI will be asked to generate for the field.setCategories(String... categories) If thevalueClassis CATEGORICAL or ORDINAL, the list of available categories.setMaxRecordsPerBatch(Integer maxRecordsPerBatch) When generating values for a list of records that are split into batches, the maximum number of records per batch.setMaxValue(Integer maxValue) If thevalueClassis INTERVAL or RATIO, the maximum value that can be generated.setMinValue(Integer minValue) If thevalueClassis INTERVAL or RATIO, the minimum value that can be generated.setRelevantFieldNames(String... relevantFieldNames) The names of fields that are relevant to eachSummarizeRecordsRequest.setSortDirection(SortDirection sortDirection) The suggested initial sort direction for the field.setValueClass(ValueClass valueClass) The class of value that AI will be asked to generate for the field.Methods inherited from class com.smartgwt.client.ai.SingleSourceAIRequest
getAdditionalMessages, getPrompt, getPromptType, setAdditionalMessages, setPrompt, setPromptTypeMethods 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
-
AIFieldRequest
public AIFieldRequest() -
AIFieldRequest
-
-
Method Details
-
getOrCreateRef
-
setCategories
If thevalueClassis CATEGORICAL or ORDINAL, the list of available categories.- Parameters:
categories- New categories value. Default value is null- Returns:
AIFieldRequestinstance, for chaining setter calls
-
getCategories
If thevalueClassis CATEGORICAL or ORDINAL, the list of available categories.- Returns:
- Current categories value. Default value is null
-
setMaxRecordsPerBatch
When generating values for a list of records that are split into batches, the maximum number of records per batch.- Parameters:
maxRecordsPerBatch- New maxRecordsPerBatch value. Default value is null- Returns:
AIFieldRequestinstance, for chaining setter calls
-
getMaxRecordsPerBatch
When generating values for a list of records that are split into batches, the maximum number of records per batch.- Returns:
- Current maxRecordsPerBatch value. Default value is null
-
setMaxValue
If thevalueClassis INTERVAL or RATIO, the maximum value that can be generated. Ifnull, then there is no maximum.- Parameters:
maxValue- New maxValue value. Default value is null- Returns:
AIFieldRequestinstance, for chaining setter calls
-
getMaxValue
If thevalueClassis INTERVAL or RATIO, the maximum value that can be generated. Ifnull, then there is no maximum.- Returns:
- Current maxValue value. Default value is null
-
setMinValue
If thevalueClassis INTERVAL or RATIO, the minimum value that can be generated. Ifnull, then there is no minimum.- Parameters:
minValue- New minValue value. Default value is null- Returns:
AIFieldRequestinstance, for chaining setter calls
-
getMinValue
If thevalueClassis INTERVAL or RATIO, the minimum value that can be generated. Ifnull, then there is no minimum.- Returns:
- Current minValue value. Default value is null
-
setRelevantFieldNames
The names of fields that are relevant to eachSummarizeRecordsRequest.- Parameters:
relevantFieldNames- New relevantFieldNames value. Default value is null- Returns:
AIFieldRequestinstance, for chaining setter calls- See Also:
-
getRelevantFieldNames
The names of fields that are relevant to eachSummarizeRecordsRequest.- Returns:
- Current relevantFieldNames value. Default value is null
- See Also:
-
setSortDirection
The suggested initial sort direction for the field.- Parameters:
sortDirection- New sortDirection value. Default value is null- Returns:
AIFieldRequestinstance, for chaining setter calls
-
getSortDirection
The suggested initial sort direction for the field.- Returns:
- Current sortDirection value. Default value is null
-
setValueClass
The class of value that AI will be asked to generate for the field.- Parameters:
valueClass- New valueClass value. Default value is "general"- Returns:
AIFieldRequestinstance, for chaining setter calls
-
getValueClass
The class of value that AI will be asked to generate for the field.- Returns:
- Current valueClass value. Default value is "general"
-