PredictabilityEstimateStore - Global
-
- UpdatedJan 30, 2025
- 2 minutes to read
- Yokohama
- API reference
Enables storing and retrieving predictability estimates.
The PredictabilityEstimateStore
API requires the Predictive Intelligence plugin (com.glide.platform_ml) and is provided
within the sn_ml
namespace.
PredictabilityEstimateStore - add(Object mlEstimate)
Adds a new predictability estimate object to the store and returns a unique name.
Name | Type | Description |
---|---|---|
mlEstimate | PredictabilityEstimate | PredictabilityEstimate() object to add to the store. |
Type | Description |
---|---|
String | System-generated predictability estimate name. |
Example
The following example shows how to add a predictability estimate to the store. Use PredictabilityEstimate - submitTrainingJob() to run the training job after adding it to the store.
PredictabilityEstimateStore - deleteObject(String name)
Removes a specified predictability estimate object from the store.
Name | Type | Description |
---|---|---|
name | String | Name of the PredictabilityEstimate() object to be deleted. |
Type | Description |
---|---|
None |
Example
The following example shows how to delete a predictability estimate from the store.
PredictabilityEstimateStore - get(String name)
Gets a predictability estimate object from a store.
Name | Type | Description |
---|---|---|
name | String | Name of a predictability estimate in a store. |
Type | Description |
---|---|
Object | PredictabilityEstimate object. Returns an error if the object does not exist. |
Example
The following example shows how to get a predictability estimate object from the store using the get() method and view its training status using the PredictabilityEstimate - getActiveVersion() and PredictabilityEstimateVersion - getStatus() methods.
Output:
PredictabilityEstimateStore - getAllNames(Object options)
Gets the names of all predictability estimate definition records in the store.
Type | Description |
---|---|
Array | List of strings representing predictability estimate object names in the store. |
Example
In the following example, the getAllNames() method returns a list of all names in the store.
Output:
Example
In the following example, the getAllNames() method returns only names associated with values set in the options parameter.
Output:
PredictabilityEstimateStore - update(String name, Object mlEstimate)
Updates a predictability estimate object in a store.
Name | Type | Description |
---|---|---|
name | String | Name of the predictability estimate to update. |
mlEstimate | PredictabilityEstimate | PredictabilityEstimate() object properties to update. |
Type | Description |
---|---|
None |
Example
The following example shows how to update a predictability estimate object in the store.