1
2
3[[Elasticsearch_Namespaces_MlNamespace]]
4=== Elasticsearch\Namespaces\MlNamespace
5
6
7
8Class MlNamespace
9
10*Description*
11
12
13NOTE: this file is autogenerated using util/GenerateEndpoints.php
14and Elasticsearch 7.12.1 (3186837139b9c6b6d23c3200870651f10d3343b7)
15
16
17*Methods*
18
19The class defines the following methods:
20
21* <<Elasticsearch_Namespaces_MlNamespacecloseJob_closeJob,`closeJob()`>>
22* <<Elasticsearch_Namespaces_MlNamespacedeleteCalendar_deleteCalendar,`deleteCalendar()`>>
23* <<Elasticsearch_Namespaces_MlNamespacedeleteCalendarEvent_deleteCalendarEvent,`deleteCalendarEvent()`>>
24* <<Elasticsearch_Namespaces_MlNamespacedeleteCalendarJob_deleteCalendarJob,`deleteCalendarJob()`>>
25* <<Elasticsearch_Namespaces_MlNamespacedeleteDataFrameAnalytics_deleteDataFrameAnalytics,`deleteDataFrameAnalytics()`>>
26* <<Elasticsearch_Namespaces_MlNamespacedeleteDatafeed_deleteDatafeed,`deleteDatafeed()`>>
27* <<Elasticsearch_Namespaces_MlNamespacedeleteExpiredData_deleteExpiredData,`deleteExpiredData()`>>
28* <<Elasticsearch_Namespaces_MlNamespacedeleteFilter_deleteFilter,`deleteFilter()`>>
29* <<Elasticsearch_Namespaces_MlNamespacedeleteForecast_deleteForecast,`deleteForecast()`>>
30* <<Elasticsearch_Namespaces_MlNamespacedeleteJob_deleteJob,`deleteJob()`>>
31* <<Elasticsearch_Namespaces_MlNamespacedeleteModelSnapshot_deleteModelSnapshot,`deleteModelSnapshot()`>>
32* <<Elasticsearch_Namespaces_MlNamespacedeleteTrainedModel_deleteTrainedModel,`deleteTrainedModel()`>>
33* <<Elasticsearch_Namespaces_MlNamespaceestimateModelMemory_estimateModelMemory,`estimateModelMemory()`>>
34* <<Elasticsearch_Namespaces_MlNamespaceevaluateDataFrame_evaluateDataFrame,`evaluateDataFrame()`>>
35* <<Elasticsearch_Namespaces_MlNamespaceexplainDataFrameAnalytics_explainDataFrameAnalytics,`explainDataFrameAnalytics()`>>
36* <<Elasticsearch_Namespaces_MlNamespacefindFileStructure_findFileStructure,`findFileStructure()`>>
37* <<Elasticsearch_Namespaces_MlNamespaceflushJob_flushJob,`flushJob()`>>
38* <<Elasticsearch_Namespaces_MlNamespaceforecast_forecast,`forecast()`>>
39* <<Elasticsearch_Namespaces_MlNamespacegetBuckets_getBuckets,`getBuckets()`>>
40* <<Elasticsearch_Namespaces_MlNamespacegetCalendarEvents_getCalendarEvents,`getCalendarEvents()`>>
41* <<Elasticsearch_Namespaces_MlNamespacegetCalendars_getCalendars,`getCalendars()`>>
42* <<Elasticsearch_Namespaces_MlNamespacegetCategories_getCategories,`getCategories()`>>
43* <<Elasticsearch_Namespaces_MlNamespacegetDataFrameAnalytics_getDataFrameAnalytics,`getDataFrameAnalytics()`>>
44* <<Elasticsearch_Namespaces_MlNamespacegetDataFrameAnalyticsStats_getDataFrameAnalyticsStats,`getDataFrameAnalyticsStats()`>>
45* <<Elasticsearch_Namespaces_MlNamespacegetDatafeedStats_getDatafeedStats,`getDatafeedStats()`>>
46* <<Elasticsearch_Namespaces_MlNamespacegetDatafeeds_getDatafeeds,`getDatafeeds()`>>
47* <<Elasticsearch_Namespaces_MlNamespacegetFilters_getFilters,`getFilters()`>>
48* <<Elasticsearch_Namespaces_MlNamespacegetInfluencers_getInfluencers,`getInfluencers()`>>
49* <<Elasticsearch_Namespaces_MlNamespacegetJobStats_getJobStats,`getJobStats()`>>
50* <<Elasticsearch_Namespaces_MlNamespacegetJobs_getJobs,`getJobs()`>>
51* <<Elasticsearch_Namespaces_MlNamespacegetModelSnapshots_getModelSnapshots,`getModelSnapshots()`>>
52* <<Elasticsearch_Namespaces_MlNamespacegetOverallBuckets_getOverallBuckets,`getOverallBuckets()`>>
53* <<Elasticsearch_Namespaces_MlNamespacegetRecords_getRecords,`getRecords()`>>
54* <<Elasticsearch_Namespaces_MlNamespacegetTrainedModels_getTrainedModels,`getTrainedModels()`>>
55* <<Elasticsearch_Namespaces_MlNamespacegetTrainedModelsStats_getTrainedModelsStats,`getTrainedModelsStats()`>>
56* <<Elasticsearch_Namespaces_MlNamespaceinfo_info,`info()`>>
57* <<Elasticsearch_Namespaces_MlNamespaceopenJob_openJob,`openJob()`>>
58* <<Elasticsearch_Namespaces_MlNamespacepostCalendarEvents_postCalendarEvents,`postCalendarEvents()`>>
59* <<Elasticsearch_Namespaces_MlNamespacepostData_postData,`postData()`>>
60* <<Elasticsearch_Namespaces_MlNamespacepreviewDatafeed_previewDatafeed,`previewDatafeed()`>>
61* <<Elasticsearch_Namespaces_MlNamespaceputCalendar_putCalendar,`putCalendar()`>>
62* <<Elasticsearch_Namespaces_MlNamespaceputCalendarJob_putCalendarJob,`putCalendarJob()`>>
63* <<Elasticsearch_Namespaces_MlNamespaceputDataFrameAnalytics_putDataFrameAnalytics,`putDataFrameAnalytics()`>>
64* <<Elasticsearch_Namespaces_MlNamespaceputDatafeed_putDatafeed,`putDatafeed()`>>
65* <<Elasticsearch_Namespaces_MlNamespaceputFilter_putFilter,`putFilter()`>>
66* <<Elasticsearch_Namespaces_MlNamespaceputJob_putJob,`putJob()`>>
67* <<Elasticsearch_Namespaces_MlNamespaceputTrainedModel_putTrainedModel,`putTrainedModel()`>>
68* <<Elasticsearch_Namespaces_MlNamespacerevertModelSnapshot_revertModelSnapshot,`revertModelSnapshot()`>>
69* <<Elasticsearch_Namespaces_MlNamespacesetUpgradeMode_setUpgradeMode,`setUpgradeMode()`>>
70* <<Elasticsearch_Namespaces_MlNamespacestartDataFrameAnalytics_startDataFrameAnalytics,`startDataFrameAnalytics()`>>
71* <<Elasticsearch_Namespaces_MlNamespacestartDatafeed_startDatafeed,`startDatafeed()`>>
72* <<Elasticsearch_Namespaces_MlNamespacestopDataFrameAnalytics_stopDataFrameAnalytics,`stopDataFrameAnalytics()`>>
73* <<Elasticsearch_Namespaces_MlNamespacestopDatafeed_stopDatafeed,`stopDatafeed()`>>
74* <<Elasticsearch_Namespaces_MlNamespaceupdateDataFrameAnalytics_updateDataFrameAnalytics,`updateDataFrameAnalytics()`>>
75* <<Elasticsearch_Namespaces_MlNamespaceupdateDatafeed_updateDatafeed,`updateDatafeed()`>>
76* <<Elasticsearch_Namespaces_MlNamespaceupdateFilter_updateFilter,`updateFilter()`>>
77* <<Elasticsearch_Namespaces_MlNamespaceupdateJob_updateJob,`updateJob()`>>
78* <<Elasticsearch_Namespaces_MlNamespaceupdateModelSnapshot_updateModelSnapshot,`updateModelSnapshot()`>>
79* <<Elasticsearch_Namespaces_MlNamespaceupgradeJobSnapshot_upgradeJobSnapshot,`upgradeJobSnapshot()`>>
80* <<Elasticsearch_Namespaces_MlNamespacevalidate_validate,`validate()`>>
81* <<Elasticsearch_Namespaces_MlNamespacevalidateDetector_validateDetector,`validateDetector()`>>
82
83
84
85[[Elasticsearch_Namespaces_MlNamespacecloseJob_closeJob]]
86.`closeJob(array $params = [])`
87****
88[source,php]
89----
90/*
91$params['job_id']         = (string) The name of the job to close
92$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
93$params['allow_no_jobs']  = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
94$params['force']          = (boolean) True if the job should be forcefully closed
95$params['timeout']        = (time) Controls the time to wait until a job has closed. Default to 30 minutes
96$params['body']           = (array) The URL params optionally sent in the body
97*/
98----
99****
100
101
102
103[[Elasticsearch_Namespaces_MlNamespacedeleteCalendar_deleteCalendar]]
104.`deleteCalendar(array $params = [])`
105****
106[source,php]
107----
108/*
109$params['calendar_id'] = (string) The ID of the calendar to delete
110*/
111----
112****
113
114
115
116[[Elasticsearch_Namespaces_MlNamespacedeleteCalendarEvent_deleteCalendarEvent]]
117.`deleteCalendarEvent(array $params = [])`
118****
119[source,php]
120----
121/*
122$params['calendar_id'] = (string) The ID of the calendar to modify
123$params['event_id']    = (string) The ID of the event to remove from the calendar
124*/
125----
126****
127
128
129
130[[Elasticsearch_Namespaces_MlNamespacedeleteCalendarJob_deleteCalendarJob]]
131.`deleteCalendarJob(array $params = [])`
132****
133[source,php]
134----
135/*
136$params['calendar_id'] = (string) The ID of the calendar to modify
137$params['job_id']      = (string) The ID of the job to remove from the calendar
138*/
139----
140****
141
142
143
144[[Elasticsearch_Namespaces_MlNamespacedeleteDataFrameAnalytics_deleteDataFrameAnalytics]]
145.`deleteDataFrameAnalytics(array $params = [])`
146*NOTE:* This API is BETA and may change in ways that are not backwards compatible
147****
148[source,php]
149----
150/*
151$params['id']      = (string) The ID of the data frame analytics to delete
152$params['force']   = (boolean) True if the job should be forcefully deleted (Default = false)
153$params['timeout'] = (time) Controls the time to wait until a job is deleted. Defaults to 1 minute
154*/
155----
156****
157
158
159
160[[Elasticsearch_Namespaces_MlNamespacedeleteDatafeed_deleteDatafeed]]
161.`deleteDatafeed(array $params = [])`
162****
163[source,php]
164----
165/*
166$params['datafeed_id'] = (string) The ID of the datafeed to delete
167$params['force']       = (boolean) True if the datafeed should be forcefully deleted
168*/
169----
170****
171
172
173
174[[Elasticsearch_Namespaces_MlNamespacedeleteExpiredData_deleteExpiredData]]
175.`deleteExpiredData(array $params = [])`
176****
177[source,php]
178----
179/*
180$params['job_id']              = (string) The ID of the job(s) to perform expired data hygiene for
181$params['requests_per_second'] = (number) The desired requests per second for the deletion processes.
182*/
183----
184****
185
186
187
188[[Elasticsearch_Namespaces_MlNamespacedeleteFilter_deleteFilter]]
189.`deleteFilter(array $params = [])`
190****
191[source,php]
192----
193/*
194$params['filter_id'] = (string) The ID of the filter to delete
195*/
196----
197****
198
199
200
201[[Elasticsearch_Namespaces_MlNamespacedeleteForecast_deleteForecast]]
202.`deleteForecast(array $params = [])`
203****
204[source,php]
205----
206/*
207$params['job_id']             = (string) The ID of the job from which to delete forecasts (Required)
208$params['forecast_id']        = (string) The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`
209$params['allow_no_forecasts'] = (boolean) Whether to ignore if `_all` matches no forecasts
210$params['timeout']            = (time) Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
211*/
212----
213****
214
215
216
217[[Elasticsearch_Namespaces_MlNamespacedeleteJob_deleteJob]]
218.`deleteJob(array $params = [])`
219****
220[source,php]
221----
222/*
223$params['job_id']              = (string) The ID of the job to delete
224$params['force']               = (boolean) True if the job should be forcefully deleted (Default = false)
225$params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = true)
226*/
227----
228****
229
230
231
232[[Elasticsearch_Namespaces_MlNamespacedeleteModelSnapshot_deleteModelSnapshot]]
233.`deleteModelSnapshot(array $params = [])`
234****
235[source,php]
236----
237/*
238$params['job_id']      = (string) The ID of the job to fetch
239$params['snapshot_id'] = (string) The ID of the snapshot to delete
240*/
241----
242****
243
244
245
246[[Elasticsearch_Namespaces_MlNamespacedeleteTrainedModel_deleteTrainedModel]]
247.`deleteTrainedModel(array $params = [])`
248*NOTE:* This API is BETA and may change in ways that are not backwards compatible
249****
250[source,php]
251----
252/*
253$params['model_id'] = (string) The ID of the trained model to delete
254*/
255----
256****
257
258
259
260[[Elasticsearch_Namespaces_MlNamespaceestimateModelMemory_estimateModelMemory]]
261.`estimateModelMemory(array $params = [])`
262****
263[source,php]
264----
265/*
266$params['body'] = (array) The analysis config, plus cardinality estimates for fields it references (Required)
267*/
268----
269****
270
271
272
273[[Elasticsearch_Namespaces_MlNamespaceevaluateDataFrame_evaluateDataFrame]]
274.`evaluateDataFrame(array $params = [])`
275****
276[source,php]
277----
278/*
279*/
280----
281****
282
283
284
285[[Elasticsearch_Namespaces_MlNamespaceexplainDataFrameAnalytics_explainDataFrameAnalytics]]
286.`explainDataFrameAnalytics(array $params = [])`
287*NOTE:* This API is BETA and may change in ways that are not backwards compatible
288****
289[source,php]
290----
291/*
292$params['id']   = (string) The ID of the data frame analytics to explain
293$params['body'] = (array) The data frame analytics config to explain
294*/
295----
296****
297
298
299
300[[Elasticsearch_Namespaces_MlNamespacefindFileStructure_findFileStructure]]
301.`findFileStructure(array $params = [])`
302*NOTE:* This API is EXPERIMENTAL and may be changed or removed completely in a future release
303****
304[source,php]
305----
306/*
307$params['lines_to_sample']       = (int) How many lines of the file should be included in the analysis (Default = 1000)
308$params['line_merge_size_limit'] = (int) Maximum number of characters permitted in a single message when lines are merged to create messages. (Default = 10000)
309$params['timeout']               = (time) Timeout after which the analysis will be aborted (Default = 25s)
310$params['charset']               = (string) Optional parameter to specify the character set of the file
311$params['format']                = (enum) Optional parameter to specify the high level file format (Options = ndjson,xml,delimited,semi_structured_text)
312$params['has_header_row']        = (boolean) Optional parameter to specify whether a delimited file includes the column names in its first row
313$params['column_names']          = (list) Optional parameter containing a comma separated list of the column names for a delimited file
314$params['delimiter']             = (string) Optional parameter to specify the delimiter character for a delimited file - must be a single character
315$params['quote']                 = (string) Optional parameter to specify the quote character for a delimited file - must be a single character
316$params['should_trim_fields']    = (boolean) Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
317$params['grok_pattern']          = (string) Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
318$params['timestamp_field']       = (string) Optional parameter to specify the timestamp field in the file
319$params['timestamp_format']      = (string) Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
320$params['explain']               = (boolean) Whether to include a commentary on how the structure was derived (Default = false)
321$params['body']                  = (array) The contents of the file to be analyzed (Required)
322*/
323----
324****
325
326
327
328[[Elasticsearch_Namespaces_MlNamespaceflushJob_flushJob]]
329.`flushJob(array $params = [])`
330****
331[source,php]
332----
333/*
334$params['job_id']       = (string) The name of the job to flush
335$params['calc_interim'] = (boolean) Calculates interim results for the most recent bucket or all buckets within the latency period
336$params['start']        = (string) When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
337$params['end']          = (string) When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
338$params['advance_time'] = (string) Advances time to the given value generating results and updating the model for the advanced interval
339$params['skip_time']    = (string) Skips time to the given value without generating results or updating the model for the skipped interval
340$params['body']         = (array) Flush parameters
341*/
342----
343****
344
345
346
347[[Elasticsearch_Namespaces_MlNamespaceforecast_forecast]]
348.`forecast(array $params = [])`
349****
350[source,php]
351----
352/*
353$params['job_id']           = (string) The ID of the job to forecast for
354$params['duration']         = (time) The duration of the forecast
355$params['expires_in']       = (time) The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
356*/
357----
358****
359
360
361
362[[Elasticsearch_Namespaces_MlNamespacegetBuckets_getBuckets]]
363.`getBuckets(array $params = [])`
364****
365[source,php]
366----
367/*
368$params['job_id']          = (string) ID of the job to get bucket results from (Required)
369$params['timestamp']       = (string) The timestamp of the desired single bucket result
370$params['expand']          = (boolean) Include anomaly records
371$params['exclude_interim'] = (boolean) Exclude interim results
372$params['from']            = (int) skips a number of buckets
373$params['size']            = (int) specifies a max number of buckets to get
374$params['start']           = (string) Start time filter for buckets
375$params['end']             = (string) End time filter for buckets
376$params['anomaly_score']   = (double) Filter for the most anomalous buckets
377$params['sort']            = (string) Sort buckets by a particular field
378$params['desc']            = (boolean) Set the sort direction
379$params['body']            = (array) Bucket selection details if not provided in URI
380*/
381----
382****
383
384
385
386[[Elasticsearch_Namespaces_MlNamespacegetCalendarEvents_getCalendarEvents]]
387.`getCalendarEvents(array $params = [])`
388****
389[source,php]
390----
391/*
392$params['calendar_id'] = (string) The ID of the calendar containing the events
393$params['job_id']      = (string) Get events for the job. When this option is used calendar_id must be '_all'
394$params['start']       = (string) Get events after this time
395$params['end']         = (date) Get events before this time
396$params['from']        = (int) Skips a number of events
397$params['size']        = (int) Specifies a max number of events to get
398*/
399----
400****
401
402
403
404[[Elasticsearch_Namespaces_MlNamespacegetCalendars_getCalendars]]
405.`getCalendars(array $params = [])`
406****
407[source,php]
408----
409/*
410$params['calendar_id'] = (string) The ID of the calendar to fetch
411$params['from']        = (int) skips a number of calendars
412$params['size']        = (int) specifies a max number of calendars to get
413$params['body']        = (array) The from and size parameters optionally sent in the body
414*/
415----
416****
417
418
419
420[[Elasticsearch_Namespaces_MlNamespacegetCategories_getCategories]]
421.`getCategories(array $params = [])`
422****
423[source,php]
424----
425/*
426$params['job_id']                = (string) The name of the job (Required)
427$params['category_id']           = (long) The identifier of the category definition of interest
428$params['from']                  = (int) skips a number of categories
429$params['size']                  = (int) specifies a max number of categories to get
430$params['partition_field_value'] = (string) Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled.
431*/
432----
433****
434
435
436
437[[Elasticsearch_Namespaces_MlNamespacegetDataFrameAnalytics_getDataFrameAnalytics]]
438.`getDataFrameAnalytics(array $params = [])`
439*NOTE:* This API is BETA and may change in ways that are not backwards compatible
440****
441[source,php]
442----
443/*
444$params['id']                = (string) The ID of the data frame analytics to fetch
445$params['allow_no_match']    = (boolean) Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) (Default = true)
446$params['from']              = (int) skips a number of analytics (Default = 0)
447$params['size']              = (int) specifies a max number of analytics to get (Default = 100)
448$params['exclude_generated'] = (boolean) Omits fields that are illegal to set on data frame analytics PUT (Default = false)
449*/
450----
451****
452
453
454
455[[Elasticsearch_Namespaces_MlNamespacegetDataFrameAnalyticsStats_getDataFrameAnalyticsStats]]
456.`getDataFrameAnalyticsStats(array $params = [])`
457*NOTE:* This API is BETA and may change in ways that are not backwards compatible
458****
459[source,php]
460----
461/*
462$params['id']             = (string) The ID of the data frame analytics stats to fetch
463$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) (Default = true)
464$params['from']           = (int) skips a number of analytics (Default = 0)
465$params['size']           = (int) specifies a max number of analytics to get (Default = 100)
466$params['verbose']        = (boolean) whether the stats response should be verbose (Default = false)
467*/
468----
469****
470
471
472
473[[Elasticsearch_Namespaces_MlNamespacegetDatafeedStats_getDatafeedStats]]
474.`getDatafeedStats(array $params = [])`
475****
476[source,php]
477----
478/*
479$params['datafeed_id']        = (string) The ID of the datafeeds stats to fetch
480$params['allow_no_match']     = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
481$params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
482*/
483----
484****
485
486
487
488[[Elasticsearch_Namespaces_MlNamespacegetDatafeeds_getDatafeeds]]
489.`getDatafeeds(array $params = [])`
490****
491[source,php]
492----
493/*
494$params['datafeed_id']        = (string) The ID of the datafeeds to fetch
495$params['allow_no_match']     = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
496$params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
497$params['exclude_generated']  = (boolean) Omits fields that are illegal to set on datafeed PUT (Default = false)
498*/
499----
500****
501
502
503
504[[Elasticsearch_Namespaces_MlNamespacegetFilters_getFilters]]
505.`getFilters(array $params = [])`
506****
507[source,php]
508----
509/*
510$params['filter_id'] = (string) The ID of the filter to fetch
511$params['from']      = (int) skips a number of filters
512$params['size']      = (int) specifies a max number of filters to get
513*/
514----
515****
516
517
518
519[[Elasticsearch_Namespaces_MlNamespacegetInfluencers_getInfluencers]]
520.`getInfluencers(array $params = [])`
521****
522[source,php]
523----
524/*
525$params['job_id']           = (string) Identifier for the anomaly detection job
526$params['exclude_interim']  = (boolean) Exclude interim results
527$params['from']             = (int) skips a number of influencers
528$params['size']             = (int) specifies a max number of influencers to get
529$params['start']            = (string) start timestamp for the requested influencers
530$params['end']              = (string) end timestamp for the requested influencers
531$params['influencer_score'] = (double) influencer score threshold for the requested influencers
532$params['sort']             = (string) sort field for the requested influencers
533$params['desc']             = (boolean) whether the results should be sorted in decending order
534$params['body']             = (array) Influencer selection criteria
535*/
536----
537****
538
539
540
541[[Elasticsearch_Namespaces_MlNamespacegetJobStats_getJobStats]]
542.`getJobStats(array $params = [])`
543****
544[source,php]
545----
546/*
547$params['job_id']         = (string) The ID of the jobs stats to fetch
548$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
549$params['allow_no_jobs']  = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
550*/
551----
552****
553
554
555
556[[Elasticsearch_Namespaces_MlNamespacegetJobs_getJobs]]
557.`getJobs(array $params = [])`
558****
559[source,php]
560----
561/*
562$params['job_id']            = (string) The ID of the jobs to fetch
563$params['allow_no_match']    = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
564$params['allow_no_jobs']     = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
565$params['exclude_generated'] = (boolean) Omits fields that are illegal to set on job PUT (Default = false)
566*/
567----
568****
569
570
571
572[[Elasticsearch_Namespaces_MlNamespacegetModelSnapshots_getModelSnapshots]]
573.`getModelSnapshots(array $params = [])`
574****
575[source,php]
576----
577/*
578$params['job_id']      = (string) The ID of the job to fetch (Required)
579$params['snapshot_id'] = (string) The ID of the snapshot to fetch
580$params['from']        = (int) Skips a number of documents
581$params['size']        = (int) The default number of documents returned in queries as a string.
582*/
583----
584****
585
586
587
588[[Elasticsearch_Namespaces_MlNamespacegetOverallBuckets_getOverallBuckets]]
589.`getOverallBuckets(array $params = [])`
590****
591[source,php]
592----
593/*
594$params['job_id']          = (string) The job IDs for which to calculate overall bucket results
595$params['top_n']           = (int) The number of top job bucket scores to be used in the overall_score calculation
596$params['bucket_span']     = (string) The span of the overall buckets. Defaults to the longest job bucket_span
597$params['overall_score']   = (double) Returns overall buckets with overall scores higher than this value
598$params['exclude_interim'] = (boolean) If true overall buckets that include interim buckets will be excluded
599$params['start']           = (string) Returns overall buckets with timestamps after this time
600$params['end']             = (string) Returns overall buckets with timestamps earlier than this time
601$params['allow_no_match']  = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
602$params['allow_no_jobs']   = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
603$params['body']            = (array) Overall bucket selection details if not provided in URI
604*/
605----
606****
607
608
609
610[[Elasticsearch_Namespaces_MlNamespacegetRecords_getRecords]]
611.`getRecords(array $params = [])`
612****
613[source,php]
614----
615/*
616$params['job_id']          = (string) The ID of the job
617$params['exclude_interim'] = (boolean) Exclude interim results
618$params['from']            = (int) skips a number of records
619$params['size']            = (int) specifies a max number of records to get
620$params['start']           = (string) Start time filter for records
621$params['end']             = (string) End time filter for records
622$params['record_score']    = (double) Returns records with anomaly scores greater or equal than this value
623$params['sort']            = (string) Sort records by a particular field
624$params['desc']            = (boolean) Set the sort direction
625$params['body']            = (array) Record selection criteria
626*/
627----
628****
629
630
631
632[[Elasticsearch_Namespaces_MlNamespacegetTrainedModels_getTrainedModels]]
633.`getTrainedModels(array $params = [])`
634*NOTE:* This API is BETA and may change in ways that are not backwards compatible
635****
636[source,php]
637----
638/*
639$params['model_id']                 = (string) The ID of the trained models to fetch
640$params['allow_no_match']           = (boolean) Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) (Default = true)
641$params['include']                  = (string) A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none.
642*/
643----
644****
645
646
647
648[[Elasticsearch_Namespaces_MlNamespacegetTrainedModelsStats_getTrainedModelsStats]]
649.`getTrainedModelsStats(array $params = [])`
650*NOTE:* This API is BETA and may change in ways that are not backwards compatible
651****
652[source,php]
653----
654/*
655$params['model_id']       = (string) The ID of the trained models stats to fetch
656$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) (Default = true)
657$params['from']           = (int) skips a number of trained models (Default = 0)
658$params['size']           = (int) specifies a max number of trained models to get (Default = 100)
659*/
660----
661****
662
663
664
665[[Elasticsearch_Namespaces_MlNamespaceinfo_info]]
666.`info(array $params = [])`
667****
668[source,php]
669----
670/*
671*/
672----
673****
674
675
676
677[[Elasticsearch_Namespaces_MlNamespaceopenJob_openJob]]
678.`openJob(array $params = [])`
679****
680[source,php]
681----
682/*
683$params['job_id'] = (string) The ID of the job to open
684*/
685----
686****
687
688
689
690[[Elasticsearch_Namespaces_MlNamespacepostCalendarEvents_postCalendarEvents]]
691.`postCalendarEvents(array $params = [])`
692****
693[source,php]
694----
695/*
696$params['calendar_id'] = (string) The ID of the calendar to modify
697$params['body']        = (array) A list of events (Required)
698*/
699----
700****
701
702
703
704[[Elasticsearch_Namespaces_MlNamespacepostData_postData]]
705.`postData(array $params = [])`
706****
707[source,php]
708----
709/*
710$params['job_id']      = (string) The name of the job receiving the data
711$params['reset_start'] = (string) Optional parameter to specify the start of the bucket resetting range
712$params['reset_end']   = (string) Optional parameter to specify the end of the bucket resetting range
713$params['body']        = (array) The data to process (Required)
714*/
715----
716****
717
718
719
720[[Elasticsearch_Namespaces_MlNamespacepreviewDatafeed_previewDatafeed]]
721.`previewDatafeed(array $params = [])`
722****
723[source,php]
724----
725/*
726$params['datafeed_id'] = (string) The ID of the datafeed to preview
727*/
728----
729****
730
731
732
733[[Elasticsearch_Namespaces_MlNamespaceputCalendar_putCalendar]]
734.`putCalendar(array $params = [])`
735****
736[source,php]
737----
738/*
739$params['calendar_id'] = (string) The ID of the calendar to create
740$params['body']        = (array) The calendar details
741*/
742----
743****
744
745
746
747[[Elasticsearch_Namespaces_MlNamespaceputCalendarJob_putCalendarJob]]
748.`putCalendarJob(array $params = [])`
749****
750[source,php]
751----
752/*
753$params['calendar_id'] = (string) The ID of the calendar to modify
754$params['job_id']      = (string) The ID of the job to add to the calendar
755*/
756----
757****
758
759
760
761[[Elasticsearch_Namespaces_MlNamespaceputDataFrameAnalytics_putDataFrameAnalytics]]
762.`putDataFrameAnalytics(array $params = [])`
763*NOTE:* This API is BETA and may change in ways that are not backwards compatible
764****
765[source,php]
766----
767/*
768$params['id']   = (string) The ID of the data frame analytics to create
769$params['body'] = (array) The data frame analytics configuration (Required)
770*/
771----
772****
773
774
775
776[[Elasticsearch_Namespaces_MlNamespaceputDatafeed_putDatafeed]]
777.`putDatafeed(array $params = [])`
778****
779[source,php]
780----
781/*
782$params['datafeed_id']        = (string) The ID of the datafeed to create
783$params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
784$params['allow_no_indices']   = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true)
785$params['ignore_throttled']   = (boolean) Ignore indices that are marked as throttled (default: true)
786$params['expand_wildcards']   = (enum) Whether source index expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all)
787$params['body']               = (array) The datafeed config (Required)
788*/
789----
790****
791
792
793
794[[Elasticsearch_Namespaces_MlNamespaceputFilter_putFilter]]
795.`putFilter(array $params = [])`
796****
797[source,php]
798----
799/*
800$params['filter_id'] = (string) The ID of the filter to create
801$params['body']      = (array) The filter details (Required)
802*/
803----
804****
805
806
807
808[[Elasticsearch_Namespaces_MlNamespaceputJob_putJob]]
809.`putJob(array $params = [])`
810****
811[source,php]
812----
813/*
814$params['job_id'] = (string) The ID of the job to create
815$params['body']   = (array) The job (Required)
816*/
817----
818****
819
820
821
822[[Elasticsearch_Namespaces_MlNamespaceputTrainedModel_putTrainedModel]]
823.`putTrainedModel(array $params = [])`
824*NOTE:* This API is BETA and may change in ways that are not backwards compatible
825****
826[source,php]
827----
828/*
829$params['model_id'] = (string) The ID of the trained models to store
830$params['body']     = (array) The trained model configuration (Required)
831*/
832----
833****
834
835
836
837[[Elasticsearch_Namespaces_MlNamespacerevertModelSnapshot_revertModelSnapshot]]
838.`revertModelSnapshot(array $params = [])`
839****
840[source,php]
841----
842/*
843$params['job_id']                     = (string) The ID of the job to fetch
844$params['snapshot_id']                = (string) The ID of the snapshot to revert to
845$params['delete_intervening_results'] = (boolean) Should we reset the results back to the time of the snapshot?
846$params['body']                       = (array) Reversion options
847*/
848----
849****
850
851
852
853[[Elasticsearch_Namespaces_MlNamespacesetUpgradeMode_setUpgradeMode]]
854.`setUpgradeMode(array $params = [])`
855****
856[source,php]
857----
858/*
859$params['enabled'] = (boolean) Whether to enable upgrade_mode ML setting or not. Defaults to false.
860*/
861----
862****
863
864
865
866[[Elasticsearch_Namespaces_MlNamespacestartDataFrameAnalytics_startDataFrameAnalytics]]
867.`startDataFrameAnalytics(array $params = [])`
868*NOTE:* This API is BETA and may change in ways that are not backwards compatible
869****
870[source,php]
871----
872/*
873$params['id']      = (string) The ID of the data frame analytics to start
874$params['timeout'] = (time) Controls the time to wait until the task has started. Defaults to 20 seconds
875$params['body']    = (array) The start data frame analytics parameters
876*/
877----
878****
879
880
881
882[[Elasticsearch_Namespaces_MlNamespacestartDatafeed_startDatafeed]]
883.`startDatafeed(array $params = [])`
884****
885[source,php]
886----
887/*
888$params['datafeed_id'] = (string) The ID of the datafeed to start
889$params['start']       = (string) The start time from where the datafeed should begin
890$params['end']         = (string) The end time when the datafeed should stop. When not set, the datafeed continues in real time
891$params['timeout']     = (time) Controls the time to wait until a datafeed has started. Default to 20 seconds
892$params['body']        = (array) The start datafeed parameters
893*/
894----
895****
896
897
898
899[[Elasticsearch_Namespaces_MlNamespacestopDataFrameAnalytics_stopDataFrameAnalytics]]
900.`stopDataFrameAnalytics(array $params = [])`
901*NOTE:* This API is BETA and may change in ways that are not backwards compatible
902****
903[source,php]
904----
905/*
906$params['id']             = (string) The ID of the data frame analytics to stop
907$params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
908$params['force']          = (boolean) True if the data frame analytics should be forcefully stopped
909$params['timeout']        = (time) Controls the time to wait until the task has stopped. Defaults to 20 seconds
910$params['body']           = (array) The stop data frame analytics parameters
911*/
912----
913****
914
915
916
917[[Elasticsearch_Namespaces_MlNamespacestopDatafeed_stopDatafeed]]
918.`stopDatafeed(array $params = [])`
919****
920[source,php]
921----
922/*
923$params['datafeed_id']        = (string) The ID of the datafeed to stop
924$params['allow_no_match']     = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
925$params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
926$params['force']              = (boolean) True if the datafeed should be forcefully stopped.
927*/
928----
929****
930
931
932
933[[Elasticsearch_Namespaces_MlNamespaceupdateDataFrameAnalytics_updateDataFrameAnalytics]]
934.`updateDataFrameAnalytics(array $params = [])`
935*NOTE:* This API is BETA and may change in ways that are not backwards compatible
936****
937[source,php]
938----
939/*
940$params['id']   = (string) The ID of the data frame analytics to update
941$params['body'] = (array) The data frame analytics settings to update (Required)
942*/
943----
944****
945
946
947
948[[Elasticsearch_Namespaces_MlNamespaceupdateDatafeed_updateDatafeed]]
949.`updateDatafeed(array $params = [])`
950****
951[source,php]
952----
953/*
954$params['datafeed_id']        = (string) The ID of the datafeed to update
955$params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
956$params['allow_no_indices']   = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true)
957$params['ignore_throttled']   = (boolean) Ignore indices that are marked as throttled (default: true)
958$params['expand_wildcards']   = (enum) Whether source index expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all)
959$params['body']               = (array) The datafeed update settings (Required)
960*/
961----
962****
963
964
965
966[[Elasticsearch_Namespaces_MlNamespaceupdateFilter_updateFilter]]
967.`updateFilter(array $params = [])`
968****
969[source,php]
970----
971/*
972$params['filter_id'] = (string) The ID of the filter to update
973$params['body']      = (array) The filter update (Required)
974*/
975----
976****
977
978
979
980[[Elasticsearch_Namespaces_MlNamespaceupdateJob_updateJob]]
981.`updateJob(array $params = [])`
982****
983[source,php]
984----
985/*
986$params['job_id'] = (string) The ID of the job to create
987$params['body']   = (array) The job update settings (Required)
988*/
989----
990****
991
992
993
994[[Elasticsearch_Namespaces_MlNamespaceupdateModelSnapshot_updateModelSnapshot]]
995.`updateModelSnapshot(array $params = [])`
996****
997[source,php]
998----
999/*
1000$params['job_id']      = (string) The ID of the job to fetch
1001$params['snapshot_id'] = (string) The ID of the snapshot to update
1002$params['body']        = (array) The model snapshot properties to update (Required)
1003*/
1004----
1005****
1006
1007
1008
1009[[Elasticsearch_Namespaces_MlNamespaceupgradeJobSnapshot_upgradeJobSnapshot]]
1010.`upgradeJobSnapshot(array $params = [])`
1011****
1012[source,php]
1013----
1014/*
1015$params['job_id']              = (string) The ID of the job
1016$params['snapshot_id']         = (string) The ID of the snapshot
1017$params['timeout']             = (time) How long should the API wait for the job to be opened and the old snapshot to be loaded.
1018*/
1019----
1020****
1021
1022
1023
1024[[Elasticsearch_Namespaces_MlNamespacevalidate_validate]]
1025.`validate(array $params = [])`
1026****
1027[source,php]
1028----
1029/*
1030$params['body'] = (array) The job config (Required)
1031*/
1032----
1033****
1034
1035
1036
1037[[Elasticsearch_Namespaces_MlNamespacevalidateDetector_validateDetector]]
1038.`validateDetector(array $params = [])`
1039****
1040[source,php]
1041----
1042/*
1043$params['body'] = (array) The detector (Required)
1044*/
1045----
1046****
1047
1048
1049