Skip to main content
Version: v41

dataset

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

idstring<uuid>
last_trainingstring<date-time>

last successful training reported from ueba server

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

startstring<date-time>
endstring<date-time>
exclude object[]

time ranges to exclude

  • Array [
  • startstring<date-time>
    endstring<date-time>
  • ]
  • training_results object[]
  • Array [
  • createdstring<date-time>

    when training entry in ueba server created

    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

    createdstring<date-time>
    created_bystring
    updatedstring<date-time>
    updated_bystring
    dataset
    {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "last_training": "2024-07-29T15:51:28.071Z",
    "is_active": true,
    "use_for_inference_once_trained": false,
    "time_range_settings": {
    "start": "2024-07-29T15:51:28.071Z",
    "end": "2024-07-29T15:51:28.071Z",
    "exclude": [
    {
    "start": "2024-07-29T15:51:28.071Z",
    "end": "2024-07-29T15:51:28.071Z"
    }
    ]
    },
    "training_results": [
    {
    "created": "2024-07-29T15:51:28.071Z",
    "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": "2024-07-29T15:51:28.071Z",
    "created_by": "string",
    "updated": "2024-07-29T15:51:28.071Z",
    "updated_by": "string"
    }