Skip to main content
Version: v44

dataset

contains the time interval settings for connections and training results from Ueba

iduuid
Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
last_trainingdate-time

date time in ISO8601 format

Example: 2017-01-01T15:05:05Z
is_activeboolean

if set, dataset based on which inference is done.

use_for_inference_once_trainedboolean

admin can set ueba to take results into use automatically after training completed. Note will toggle is_active bits once training done, as needed.

Default value: false
time_range_settings objectrequired

Definition of time interval(s) from where connections data is fetched from db for training

startdate-time

date time in ISO8601 format

Example: 2017-01-01T15:05:05Z
enddate-time

date time in ISO8601 format

Example: 2017-01-01T15:05:05Z
exclude object[]

time ranges to exclude

  • Array [
  • startdate-time

    date time in ISO8601 format

    Example: 2017-01-01T15:05:05Z
    enddate-time

    date time in ISO8601 format

    Example: 2017-01-01T15:05:05Z
  • ]
  • training_results object[]
  • Array [
  • createddate-time

    date time in ISO8601 format

    Example: 2017-01-01T15:05:05Z
    feature_config_namestringrequired
    statusstringrequired

    Possible values: [TRAINING, SUCCESS, FAILURE]

    error_codestring
    error_detailsstring
    num_connectionsinteger
    meannumber
    stdnumber
    quantile_99number
    quantile_999number
    training_logstring
    training_dataset_lossnumber[]
    validation_dataset_lossnumber[]
    validation_dataset_histogram object
    histnumber[]required
    bin_edgesnumber[]required
  • ]
  • commentstring

    A comment describing the dataset

    createddate-time

    date time in ISO8601 format

    Example: 2017-01-01T15:05:05Z
    created_byuuid
    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    updateddate-time

    date time in ISO8601 format

    Example: 2017-01-01T15:05:05Z
    updated_byuuid
    Example: eef4aefc-d64e-4c2c-aba4-4914c86ce059
    dataset
    {
    "id": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "last_training": "2017-01-01T15:05:05Z",
    "is_active": true,
    "use_for_inference_once_trained": false,
    "time_range_settings": {
    "start": "2017-01-01T15:05:05Z",
    "end": "2017-01-01T15:05:05Z",
    "exclude": [
    {
    "start": "2017-01-01T15:05:05Z",
    "end": "2017-01-01T15:05:05Z"
    }
    ]
    },
    "training_results": [
    {
    "created": "2017-01-01T15:05:05Z",
    "feature_config_name": "string",
    "status": "TRAINING",
    "error_code": "string",
    "error_details": "string",
    "num_connections": 0,
    "mean": 0,
    "std": 0,
    "quantile_99": 0,
    "quantile_999": 0,
    "training_log": "string",
    "training_dataset_loss": [
    0
    ],
    "validation_dataset_loss": [
    0
    ],
    "validation_dataset_histogram": {
    "hist": [
    0
    ],
    "bin_edges": [
    0
    ]
    }
    }
    ],
    "comment": "string",
    "created": "2017-01-01T15:05:05Z",
    "created_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059",
    "updated": "2017-01-01T15:05:05Z",
    "updated_by": "eef4aefc-d64e-4c2c-aba4-4914c86ce059"
    }