1Search::Elasticsearch::USCseleairrecnChto::n::tE6rl_ia0bs:ut:tiDecidsreePacertrc:lh::XD:PoCaclcuikme:en:ntMt:La:(t63i_)o0n::Direct::XPack::ML(3)
2
6 Search::Elasticsearch::Client::6_0::Direct::XPack::ML - Plugin
7 providing ML API for Search::Elasticsearch 6.x
8
10 version 6.81
11
13 my $response = $es->xpack->ml->start_datafeed(...)
14 DESCRIPTION
16 This class extends the Search::Elasticsearch client with an "ml"
17 namespace, to support the Machine Learning APIs
18 <https://www.elastic.co/guide/en/x-pack/6.0/xpack-ml.html>.
19 The full documentation for the ML feature is available here:
21 <https://www.elastic.co/guide/en/x-pack/6.0/xpack-ml.html>
22
24 "put_datafeed()"
25 $response = $es->xpack->ml->put_datafeed(
26 datafeed_id => $id # required
27 body => {...} # required
28 )
29 The "put_datafeed()" method enables you to instantiate a datafeed.
31 See the put_datafeed docs
33 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
34 put-datafeed.html> for more information.
35 Query string parameters:
37 "error_trace",
38 "human"
39 "delete_datafeed()"
41 $response = $es->xpack->ml->delete_datafeed(
42 datafeed_id => $id # required
43 )
44 The "delete_datafeed()" method enables you to delete a datafeed.
46 See the delete_datafeed docs
48 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
49 delete-datafeed.html> for more information.
50 Query string parameters:
52 "error_trace",
53 "force",
54 "human"
55 "start_datafeed()"
57 $response = $es->xpack->ml->start_datafeed(
58 datafeed_id => $id # required
59 )
60 The "start_datafeed()" method enables you to start a datafeed.
62 See the start_datafeed docs
64 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
65 start-datafeed.html> for more information.
66 Query string parameters:
68 "end",
69 "error_trace",
70 "human",
71 "start",
72 "timeout"
73 "stop_datafeed()"
75 $response = $es->xpack->ml->stop_datafeed(
76 datafeed_id => $id # required
77 )
78 The "stop_datafeed()" method enables you to stop a datafeed.
80 See the stop_datafeed docs
82 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
83 stop-datafeed.html> for more information.
84 Query string parameters:
86 "allow_no_datafeeds",
87 "error_trace",
88 "force",
89 "human",
90 "timeout"
91 "get_datafeeds()"
93 $response = $es->xpack->ml->get_datafeeds(
94 datafeed_id => $id # optional
95 )
96 The "get_datafeeds()" method enables you to retrieve configuration
98 information for datafeeds.
99 See the get_datafeeds docs
101 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
102 get-datafeed.html> for more information.
103 Query string parameters:
105 "allow_no_datafeeds",
106 "error_trace",
107 "human"
108 "get_datafeed_stats()"
110 $response = $es->xpack->ml->get_datafeed_stats(
111 datafeed_id => $id # optional
112 )
113 The "get_datafeed_stats()" method enables you to retrieve configuration
115 information for datafeeds.
116 See the get_datafeed_stats docs
118 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
119 get-datafeed-stats.html> for more information.
120 Query string parameters:
122 "allow_no_datafeeds",
123 "error_trace",
124 "human"
125 "preview_datafeed()"
127 $response = $es->xpack->ml->preview_datafeed(
128 datafeed_id => $id # required
129 )
130 The "preview_datafeed()" method enables you to preview a datafeed.
132 See the preview_datafeed docs
134 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
135 preview-datafeed.html> for more information.
136 Query string parameters:
138 "error_trace",
139 "human"
140 "update_datafeed()"
142 $response = $es->xpack->ml->update_datafeed(
143 datafeed_id => $id # required
144 body => {...} # required
145 )
146 The "update_datafeed()" method enables you to update certain properties
148 of a datafeed.
149 See the update_datafeed docs
151 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
152 update-datafeed.html> for more information.
153 Query string parameters:
155 "error_trace",
156 "human"
157
159 "put_job()"
160 $response = $es->xpack->ml->put_job(
161 job_id => $id # required
162 body => {...} # required
163 )
164 The "put_job()" method enables you to instantiate a job.
166 See the put_job docs
168 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
169 put-job.html> for more information.
170 Query string parameters:
172 "error_trace",
173 "human"
174 "delete_job()"
176 $response = $es->xpack->ml->delete_job(
177 job_id => $id # required
178 )
179 The "delete_job()" method enables you to delete a job.
181 See the delete_job docs
183 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
184 delete-job.html> for more information.
185 Query string parameters:
187 "error_trace",
188 "force",
189 "human",
190 "wait_for_completion"
191 "open_job()"
193 $response = $es->xpack->ml->open_job(
194 job_id => $id # required
195 )
196 The "open_job()" method enables you to open a closed job.
198 See the open_job docs
200 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
201 open-job.html> for more information.
202 Query string parameters:
204 "error_trace",
205 "human"
206 "close_job()"
208 $response = $es->xpack->ml->close_job(
209 job_id => $id # required
210 )
211 The "close_job()" method enables you to close an open job.
213 See the close_job docs
215 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
216 close-job.html> for more information.
217 Query string parameters:
219 "allow_no_jobs",
220 "error_trace",
221 "force",
222 "human",
223 "timeout"
224 "get_jobs()"
226 $response = $es->xpack->ml->get_jobs(
227 job_id => $id # optional
228 )
229 The "get_jobs()" method enables you to retrieve configuration
231 information for jobs.
232 See the get_jobs docs
234 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
235 get-job.html> for more information.
236 Query string parameters:
238 "allow_no_jobs",
239 "error_trace",
240 "human"
241 "get_job_stats()"
243 $response = $es->xpack->ml->get_jobs_stats(
244 job_id => $id # optional
245 )
246 The "get_jobs_stats()" method enables you to retrieve usage information
248 for jobs.
249 See the get_job_statss docs
251 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
252 get-job-stats.html> for more information.
253 Query string parameters:
255 "allow_no_jobs",
256 "error_trace",
257 "human"
258 "flush_job()"
260 $response = $es->xpack->ml->flush_job(
261 job_id => $id # required
262 )
263 The "flush_job()" method forces any buffered data to be processed by
265 the job.
266 See the flush_job docs
268 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
269 flush-job.html> for more information.
270 Query string parameters:
272 "advance_time",
273 "calc_interm",
274 "end",
275 "error_trace",
276 "human",
277 "skip_time",
278 "start"
279 "post_data()"
281 $response = $es->xpack->ml->post_data(
282 job_id => $id # required
283 body => [data] # required
284 )
285 The "post_data()" method enables you to send data to an anomaly
287 detection job for analysis.
288 See the post_data docs
290 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
291 post-data.html> for more information.
292 Query string parameters:
294 "error_trace",
295 "human",
296 "reset_end",
297 "reset_start"
298 "update_job()"
300 $response = $es->xpack->ml->update_job(
301 job_id => $id # required
302 body => {...} # required
303 )
304 The "update_job()" method enables you to update certain properties of a
306 job.
307 See the update_job docs
309 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
310 update-job.html> for more information.
311 Query string parameters:
313 "error_trace",
314 "human"
315 "delete_expired_data"
317 $response = $es->xpack->ml->delete_expired_data(
318 )
319 The "delete_expired_data()" method deletes expired machine learning
321 data.
322 See the delete_expired_data docs
324 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
325 delete-expired-data.html> for more information.
326 Query string parameters:
328 "error_trace",
329 "human"
330
332 "put_calendar()"
333 $response = $es->xpack->ml->put_calendar(
334 calendar_id => $id # required
335 body => {...} # optional
336 )
337 The "put_calendar()" method creates a new calendar.
339 Query string parameters:
341 "error_trace",
342 "human"
343 See the put calendar docs
345 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
346 put-calendar.html> for more information.
347 "delete_calendar()"
349 $response = $es->xpack->ml->delete_calendar(
350 calendar_id => $id # required
351 )
352 The "delete_calendar()" method deletes the specified calendar
354 Query string parameters:
356 "error_trace",
357 "human"
358 See the delete_calendar docs
360 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
361 delete-calendar.html> for more information.
362 "put_calendar_job()"
364 $response = $es->xpack->ml->put_calendar_job(
365 calendar_id => $id, # required
366 job_id => $id # required
367 )
368 The "put_calendar_job()" method adds a job to a calendar.
370 Query string parameters:
372 "error_trace",
373 "human"
374 See the put_calendar_job docs
376 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
377 put-calendar-job.html> for more information.
378 "delete_calendar_job()"
380 $response = $es->xpack->ml->delete_calendar_job(
381 calendar_id => $id, # required
382 job_id => $id # required
383 )
384 The "delete_calendar_job()" method deletes a job from a calendar.
386 Query string parameters:
388 "error_trace",
389 "human"
390 See the delete_calendar_job docs
392 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
393 delete-calendar-job.html> for more information.
394 "put_calendar_event()"
396 $response = $es->xpack->ml->post_calendar_events(
397 calendar_id => $id, # required
398 body => {...} # required
399 )
400 The "post_calendar_events()" method adds scheduled events to a
402 calendar.
403 Query string parameters:
405 "error_trace",
406 "human"
407 See the post_calendar_events docs
409 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
410 post-calendar-events.html> for more information.
411 "delete_calendar_event()"
413 $response = $es->xpack->ml->delete_calendar_event(
414 calendar_id => $id, # required
415 event_id => $id # required
416 )
417 The "delete_calendar_event()" method deletes an event from a calendar.
419 Query string parameters:
421 "error_trace",
422 "human"
423 See the delete_calendar_event docs
425 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
426 delete-calendar-event.html> for more information.
427 "get_calendars()"
429 $response = $es->xpack->ml->get_calendars(
430 calendar_id => $id, # optional
431 )
432 The "get_calendars()" method returns the specified calendar or all
434 calendars.
435 Query string parameters:
437 "error_trace",
438 "from",
439 "human",
440 "size"
441 See the get_calendars docs
443 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
444 get-calendar-event.html> for more information.
445 "get_calendar_events()"
447 $response = $es->xpack->ml->get_calendar_events(
448 calendar_id => $id, # required
449 )
450 The "get_calendar_events()" method retrieves events from a calendar.
452 Query string parameters:
454 "end",
455 "error_trace",
456 "from",
457 "human",
458 "job_id",
459 "size",
460 "start"
461 See the get_calendar_events docs
463 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
464 get-calendar-event.html> for more information.
465
467 "put_filter()"
468 $response = $es->xpack->ml->put_filter(
469 filter_id => $id, # required
470 body => {...} # required
471 )
472 The "put_filter()" method creates a named filter.
474 Query string parameters:
476 "error_trace",
477 "human"
478 See the put_filter docs
480 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
481 put-filter.html> for more information.
482 "update_filter()"
484 $response = $es->xpack->ml->update_filter(
485 filter_id => $id, # required
486 body => {...} # required
487 )
488 The "update_filter()" method updates the description of a filter, adds
490 items, or removes items.
491 Query string parameters:
493 "error_trace",
494 "human"
495 See the update_filter docs
497 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
498 update-filter.html> for more information.
499 "get_filters()"
501 $response = $es->xpack->ml->get_filters(
502 filter_id => $id, # optional
503 )
504 The "get_filters()" method retrieves a named filter or all filters.
506 Query string parameters:
508 "error_trace",
509 "from",
510 "human",
511 "size"
512 See the get_filters docs
514 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
515 get-filters.html> for more information.
516 "delete_filter()"
518 $response = $es->xpack->ml->delete_filter(
519 filter_id => $id, # required
520 )
521 The "delete_filter()" method deletes a named filter.
523 Query string parameters:
525 "error_trace",
526 "human"
527 See the delete_filters docs
529 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
530 delete-filter.html> for more information.
531
533 "forecast()"
534 $response = $es->xpack->ml->forecast(
535 job_id => $id # required
536 )
537 The "forecast()" method enables you to create a new forecast
539 See the forecast docs
541 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
542 forecast.html> for more information.
543 Query string parameters:
545 "duration",
546 "error_trace",
547 "expires_in",
548 "human"
549 "delete_forecast()"
551 $response = $es->xpack->ml->delete_forecast(
552 forecast_id => $id, # required
553 job_id => $id # required
554 )
555 The "delete_forecast()" method enables you to delete an existing
557 forecast.
558 See the delete_forecast docs
560 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
561 delete-forecast.html> for more information.
562 Query string parameters:
564 "allow_no_forecasts",
565 "error_trace",
566 "human",
567 "timeout"
568
570 "delete_model_snapshot()"
571 $response = $es->xpack->ml->delete_model_snapshot(
572 snapshot_id => $id # required
573 )
574 The "delete_model_snapshot()" method enables you to delete an existing
576 model snapshot.
577 See the delete_model_snapshot docs
579 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
580 delete-snapshot.html> for more information.
581 Query string parameters:
583 "error_trace",
584 "human"
585 "get_model_snapshots()"
587 $response = $es->xpack->ml->get_model_snapshots(
588 job_id => $job_id, # required
589 snapshot_id => $snapshot_id # optional
590 )
591 The "get_model_snapshots()" method enables you to retrieve information
593 about model snapshots.
594 See the get_model_snapshots docs
596 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
597 get-snapshot.html> for more information.
598 Query string parameters:
600 "desc",
601 "end",
602 "error_trace",
603 "from",
604 "human",
605 "size",
606 "sort",
607 "start"
608 "revert_model_snapshot()"
610 $response = $es->xpack->ml->revert_model_snapshot(
611 job_id => $job_id, # required
612 snapshot_id => $snapshot_id # required
613 )
614 The "revert_model_snapshots()" method enables you to revert to a
616 specific snapshot.
617 See the revert_model_snapshot docs
619 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
620 revert-snapshot.html> for more information.
621 Query string parameters:
623 "delete_intervening_results",
624 "error_trace",
625 "human"
626 "update_model_snapshot()"
628 $response = $es->xpack->ml->update_model_snapshot(
629 job_id => $job_id, # required
630 snapshot_id => $snapshot_id # required
631 )
632 The "update_model_snapshots()" method enables you to update certain
634 properties of a snapshot.
635 See the update_model_snapshot docs
637 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
638 update-snapshot.html> for more information.
639 Query string parameters:
641 "error_trace",
642 "human"
643
645 "get_buckets()"
646 $response = $es->xpack->ml->get_buckets(
647 job_id => $job_id, # required
648 timestamp => $timestamp # optional
649 )
650 The "get_buckets()" method enables you to retrieve job results for one
652 or more buckets.
653 See the get_buckets docs
655 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
656 get-bucket.html> for more information.
657 Query string parameters:
659 "anomaly_score",
660 "desc",
661 "end",
662 "error_trace",
663 "exclude_interim",
664 "expand",
665 "from",
666 "human",
667 "size",
668 "sort",
669 "start"
670 "get_overall_buckets()"
672 $response = $es->xpack->ml->get_overall_buckets(
673 job_id => $job_id, # required
674 )
675 The "get_overall_buckets()" method retrieves overall bucket results
677 that summarize the bucket results of multiple jobs.
678 See the get_overall_buckets docs
680 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
681 get-overall-buckets.html> for more information.
682 Query string parameters:
684 "allow_no_jobs",
685 "bucket_span",
686 "end",
687 "error_trace",
688 "exclude_interim",
689 "human",
690 "overall_score",
691 "start",
692 "top_n"
693 "get_categories()"
695 $response = $es->xpack->ml->get_categories(
696 job_id => $job_id, # required
697 category_id => $category_id # optional
698 )
699 The "get_categories()" method enables you to retrieve job results for
701 one or more categories.
702 See the get_categories docs
704 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
705 get-category.html> for more information.
706 Query string parameters:
708 "error_trace",
709 "from",
710 "human",
711 "size"
712 "get_influencers()"
714 $response = $es->xpack->ml->get_influencers(
715 job_id => $job_id, # required
716 )
717 The "get_influencers()" method enables you to retrieve job results for
719 one or more influencers.
720 See the get_influencers docs
722 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
723 get-influencer.html> for more information.
724 Query string parameters:
726 "desc",
727 "end",
728 "error_trace",
729 "exclude_interim",
730 "expand",
731 "from",
732 "human",
733 "influencer_score",
734 "size",
735 "sort",
736 "start"
737 "get_records()"
739 $response = $es->xpack->ml->get_records(
740 job_id => $job_id, # required
741 )
742 The "get_records()" method enables you to retrieve anomaly records for
744 a job.
745 See the get_records docs
747 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
748 get-record.html> for more information.
749 Query string parameters:
751 "desc",
752 "end",
753 "error_trace",
754 "exclude_interim",
755 "expand",
756 "from",
757 "human",
758 "record_score",
759 "size",
760 "sort",
761 "start"
762
764 "find_file_structure"
765 $response = $es->xpack->ml->find_file_structure(
766 body => { ... }, # required
767 )
768 The "find_file_structure()" method finds the structure of a text file
770 which contains data that is suitable to be ingested into Elasticsearch.
771 See the find_file_structure docs
773 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
774 find-file-structure.html> for more information.
775 Query string parameters:
777 "charset",
778 "column_names",
779 "delimiter",
780 "error_trace",
781 "explain",
782 "format",
783 "grok_pattern",
784 "has_header_row",
785 "human",
786 "lines_to_sample",
787 "quote",
788 "should_trim_fields",
789 "timeout",
790 "timestamp_field",
791 "timestamp_format"
792
794 "info"
795 $response = $es->xpack->ml->info();
796 The "info()" method returns defaults and limits used by machine
798 learning.
799 See the find_file_structure docs
801 <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-
802 ml-info.html> for more information.
803 Query string parameters:
805 "error_trace",
806 "human"
807
809 "set_upgrade_mode"
810 $response = $es->xpack->ml->set_upgrade_mode();
811 The "set_upgrade_mode()" method sets a cluster wide "upgrade_mode"
813 setting that prepares machine learning indices for an upgrade.
814 See the set_upgrade_mode docs
816 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
817 set-upgrade-mode.html> for more information.
818 Query string parameters:
820 "enabled",
821 "error_trace",
822 "human",
823 "timeout"
824
826 Enrico Zimuel <enrico.zimuel@elastic.co>
827
829 This software is Copyright (c) 2020 by Elasticsearch BV.
830 This is free software, licensed under:
832 The Apache License, Version 2.0, January 2004
834perl v5.32.0 Search::Elas2t0i2c0s-e0a7r-c2h8::Client::6_0::Direct::XPack::ML(3)