Description
The information about a model of an OpenSearch application.
Example
{
"id": 113023,
"groupId": "100297752",
"groupName": "appGroupName",
"type": "pop",
"name": "pop_1212",
"trainTarget": "ctr",
"cron": "15 0 */2 * *",
"cronEnabled": true,
"behaviorEnabled": true,
"behaviorFromGroupName": "DemoModelName",
"lastTrainingTime": 1543233439000,
"auc": 0.85,
"status": "train_success",
"progress": 69,
"isAlreadyDeployed": true,
"industry": "general",
"filter": "user_id=1,level=1",
"fields": [{
"name": "item_title",
"appFieldType": "title"
},
{
"name": "item_content"
},
{
"name": "item_title_keep",
"processType": "reserve"
}
],
"extend": {
"useHotQuery": true,
"useHistoryQuery": true
}
}
Structure
Field | Type | Description |
---|---|---|
id | Integer | The ID of the model. |
groupId | String | The ID of the application. |
groupName | String | The name of the application. |
type | String | The type of the model. Valid values:- pop: a popularity model- cp: a category prediction model- hot: a top search model- hint: a hint model- suggest: a drop-down suggestions model |
name | String | The name of the model. The model must be named based on the following regular expression: /^(?!ops_)[a-zA-Z]\w{0,29}$/.ops_)[a-zA-Z]\w{0,29}$/ |
industry | String | The industry to which the model applies. Valid values:- general- ecommerce- content |
trainTarget | String | The training goal of the model. Valid values:- click- buy- cart- collect- like- comment- share- subscribe- gift- download- read- tip |
behaviorEnabled | Boolean | Specifies whether to use behavioral data. Default value: true. Specific models cannot use behavioral data. |
behaviorFromGroupName | String | The name of the application whose behavioral data is used. By default, the behavioral data of the current application is used. |
cron | String | The CRON expression used to schedule training. For more information, search for Linux Crontab online. |
cronEnabled | Boolean | Specifies whether to enable scheduled training. Default value: true. |
availableThreshold | Float | The threshold when the model is qualified. Valid values: 0 to 1. |
filter | String | The operator that is used for data import. The following operators are supported: <, >, =, !=,>=, and <=. Separate multiple conditions with commas (,). |
fields[] | Object | The fields to be used by the model. |
fields[].name | String | The name of the field. |
fields[].appFieldType | String | The role of the field in the application. Valid values:- pk: a primary key- cate_id: a category ID- title: a title- cate_name: a category name- normal: a regular field |
fields[].processType | String | The processing type for the field. Valid values: reserve and normal. |
lastTrainingTime | Integer | The most recent time when the training was complete. |
lastModifyTime | Integer | The most recent time when the model was modified. |
auc | Float | The area under curve (AUC) value of the model. |
status | String | The status of the task. Valid values:- train_init: The model is to be trained.- train_pending: The model is being trained.- validate_failed: An exception related with the data occurred.- train_failed: The training failed.- train_bad_model: The training succeeded but the model failed the training.- train_success: The training succeeded and the model passed the training. |
progress | Integer | The progress of the task, in percentage. |
isAlreadyDeployed | Boolean | Indicates whether the model has been deployed or whether one or more models with the same configuration are available. |
extend | Object | The extended configurations of the model. |
extend.useHotQuery | Boolean | Indicates whether one or more models that are supported by hot queries are used. We recommend that you use the models. |
extend.useHistoryQuery | Boolean | Indicates whether one or more models that are supported by historical queries are used. We recommend that you use the models. |