1Search::Elasticsearch::UCsleirenCto:nS:te8ra_ir0bc:uh:t:De:idErlePacestrt:li:cMDsLoe(ca3ur)mcehn:t:aCtliioennt::8_0::Direct::ML(3)
2
6 Search::Elasticsearch::Client::8_0::Direct::ML - Plugin providing ML
7 API for Search::Elasticsearch 8.x
8
10 version 8.00
11
13 my $response = $es->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/7.0/xpack-ml.html>.
19 The full documentation for the ML feature is available here:
21 <https://www.elastic.co/guide/en/x-pack/7.0/xpack-ml.html>
22
24 put_datafeed()
25 $response = $es->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->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->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->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->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->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->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->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->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->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->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->ml->get_jobs(
227 job_id => $id # optional
228 )
229 The get_jobs() method enables you to retrieve configuration information
231 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->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->ml->flush_job(
261 job_id => $id # required
262 )
263 The flush_job() method forces any buffered data to be processed by the
265 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->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 detection
287 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->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->ml->delete_expired_data(
318 )
319 The delete_expired_data() method deletes expired machine learning data.
321 See the delete_expired_data docs
323 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
324 delete-expired-data.html> for more information.
325 Query string parameters:
327 "error_trace",
328 "human"
329
331 put_calendar()
332 $response = $es->ml->put_calendar(
333 calendar_id => $id # required
334 body => {...} # optional
335 )
336 The put_calendar() method creates a new calendar.
338 Query string parameters:
340 "error_trace",
341 "human"
342 See the put calendar docs
344 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
345 put-calendar.html> for more information.
346 delete_calendar()
348 $response = $es->ml->delete_calendar(
349 calendar_id => $id # required
350 )
351 The delete_calendar() method deletes the specified calendar
353 Query string parameters:
355 "error_trace",
356 "human"
357 See the delete_calendar docs
359 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
360 delete-calendar.html> for more information.
361 put_calendar_job()
363 $response = $es->ml->put_calendar_job(
364 calendar_id => $id, # required
365 job_id => $id # required
366 )
367 The put_calendar_job() method adds a job to a calendar.
369 Query string parameters:
371 "error_trace",
372 "human"
373 See the put_calendar_job docs
375 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
376 put-calendar-job.html> for more information.
377 delete_calendar_job()
379 $response = $es->ml->delete_calendar_job(
380 calendar_id => $id, # required
381 job_id => $id # required
382 )
383 The delete_calendar_job() method deletes a job from a calendar.
385 Query string parameters:
387 "error_trace",
388 "human"
389 See the delete_calendar_job docs
391 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
392 delete-calendar-job.html> for more information.
393 put_calendar_event()
395 $response = $es->ml->post_calendar_events(
396 calendar_id => $id, # required
397 body => {...} # required
398 )
399 The post_calendar_events() method adds scheduled events to a calendar.
401 Query string parameters:
403 "error_trace",
404 "human"
405 See the post_calendar_events docs
407 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
408 post-calendar-events.html> for more information.
409 delete_calendar_event()
411 $response = $es->ml->delete_calendar_event(
412 calendar_id => $id, # required
413 event_id => $id # required
414 )
415 The delete_calendar_event() method deletes an event from a calendar.
417 Query string parameters:
419 "error_trace",
420 "human"
421 See the delete_calendar_event docs
423 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
424 delete-calendar-event.html> for more information.
425 get_calendars()
427 $response = $es->ml->get_calendars(
428 calendar_id => $id, # optional
429 )
430 The get_calendars() method returns the specified calendar or all
432 calendars.
433 Query string parameters:
435 "error_trace",
436 "from",
437 "human",
438 "size"
439 See the get_calendars docs
441 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
442 get-calendar-event.html> for more information.
443 get_calendar_events()
445 $response = $es->ml->get_calendar_events(
446 calendar_id => $id, # required
447 )
448 The get_calendar_events() method retrieves events from a calendar.
450 Query string parameters:
452 "end",
453 "error_trace",
454 "from",
455 "human",
456 "job_id",
457 "size",
458 "start"
459 See the get_calendar_events docs
461 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
462 get-calendar-event.html> for more information.
463
465 put_filter()
466 $response = $es->ml->put_filter(
467 filter_id => $id, # required
468 body => {...} # required
469 )
470 The put_filter() method creates a named filter.
472 Query string parameters:
474 "error_trace",
475 "human"
476 See the put_filter docs
478 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
479 put-filter.html> for more information.
480 update_filter()
482 $response = $es->ml->update_filter(
483 filter_id => $id, # required
484 body => {...} # required
485 )
486 The update_filter() method updates the description of a filter, adds
488 items, or removes items.
489 Query string parameters:
491 "error_trace",
492 "human"
493 See the update_filter docs
495 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
496 update-filter.html> for more information.
497 get_filters()
499 $response = $es->ml->get_filters(
500 filter_id => $id, # optional
501 )
502 The get_filters() method retrieves a named filter or all filters.
504 Query string parameters:
506 "error_trace",
507 "from",
508 "human",
509 "size"
510 See the get_filters docs
512 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
513 get-filters.html> for more information.
514 delete_filter()
516 $response = $es->ml->delete_filter(
517 filter_id => $id, # required
518 )
519 The delete_filter() method deletes a named filter.
521 Query string parameters:
523 "error_trace",
524 "human"
525 See the delete_filters docs
527 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
528 delete-filter.html> for more information.
529
531 forecast()
532 $response = $es->ml->forecast(
533 job_id => $id # required
534 )
535 The forecast() method enables you to create a new forecast
537 See the forecast docs
539 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
540 forecast.html> for more information.
541 Query string parameters:
543 "duration",
544 "error_trace",
545 "expires_in",
546 "human"
547 delete_forecast()
549 $response = $es->ml->delete_forecast(
550 forecast_id => $id, # required
551 job_id => $id # required
552 )
553 The delete_forecast() method enables you to delete an existing
555 forecast.
556 See the delete_forecast docs
558 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
559 delete-forecast.html> for more information.
560 Query string parameters:
562 "allow_no_forecasts",
563 "error_trace",
564 "human",
565 "timeout"
566
568 delete_model_snapshot()
569 $response = $es->ml->delete_model_snapshot(
570 snapshot_id => $id # required
571 )
572 The delete_model_snapshot() method enables you to delete an existing
574 model snapshot.
575 See the delete_model_snapshot docs
577 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
578 delete-snapshot.html> for more information.
579 Query string parameters:
581 "error_trace",
582 "human"
583 get_model_snapshots()
585 $response = $es->ml->get_model_snapshots(
586 job_id => $job_id, # required
587 snapshot_id => $snapshot_id # optional
588 )
589 The get_model_snapshots() method enables you to retrieve information
591 about model snapshots.
592 See the get_model_snapshots docs
594 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
595 get-snapshot.html> for more information.
596 Query string parameters:
598 "desc",
599 "end",
600 "error_trace",
601 "from",
602 "human",
603 "size",
604 "sort",
605 "start"
606 revert_model_snapshot()
608 $response = $es->ml->revert_model_snapshot(
609 job_id => $job_id, # required
610 snapshot_id => $snapshot_id # required
611 )
612 The revert_model_snapshots() method enables you to revert to a specific
614 snapshot.
615 See the revert_model_snapshot docs
617 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
618 revert-snapshot.html> for more information.
619 Query string parameters:
621 "delete_intervening_results",
622 "error_trace",
623 "human"
624 update_model_snapshot()
626 $response = $es->ml->update_model_snapshot(
627 job_id => $job_id, # required
628 snapshot_id => $snapshot_id # required
629 )
630 The update_model_snapshots() method enables you to update certain
632 properties of a snapshot.
633 See the update_model_snapshot docs
635 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
636 update-snapshot.html> for more information.
637 Query string parameters:
639 "error_trace",
640 "human"
641
643 get_buckets()
644 $response = $es->ml->get_buckets(
645 job_id => $job_id, # required
646 timestamp => $timestamp # optional
647 )
648 The get_buckets() method enables you to retrieve job results for one or
650 more buckets.
651 See the get_buckets docs
653 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
654 get-bucket.html> for more information.
655 Query string parameters:
657 "anomaly_score",
658 "desc",
659 "end",
660 "error_trace",
661 "exclude_interim",
662 "expand",
663 "from",
664 "human",
665 "size",
666 "sort",
667 "start"
668 get_overall_buckets()
670 $response = $es->ml->get_overall_buckets(
671 job_id => $job_id, # required
672 )
673 The get_overall_buckets() method retrieves overall bucket results that
675 summarize the bucket results of multiple jobs.
676 See the get_overall_buckets docs
678 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
679 get-overall-buckets.html> for more information.
680 Query string parameters:
682 "allow_no_jobs",
683 "bucket_span",
684 "end",
685 "error_trace",
686 "exclude_interim",
687 "human",
688 "overall_score",
689 "start",
690 "top_n"
691 get_categories()
693 $response = $es->ml->get_categories(
694 job_id => $job_id, # required
695 category_id => $category_id # optional
696 )
697 The get_categories() method enables you to retrieve job results for one
699 or more categories.
700 See the get_categories docs
702 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
703 get-category.html> for more information.
704 Query string parameters:
706 "error_trace",
707 "from",
708 "human",
709 "size"
710 get_influencers()
712 $response = $es->ml->get_influencers(
713 job_id => $job_id, # required
714 )
715 The get_influencers() method enables you to retrieve job results for
717 one or more influencers.
718 See the get_influencers docs
720 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
721 get-influencer.html> for more information.
722 Query string parameters:
724 "desc",
725 "end",
726 "error_trace",
727 "exclude_interim",
728 "expand",
729 "from",
730 "human",
731 "influencer_score",
732 "size",
733 "sort",
734 "start"
735 get_records()
737 $response = $es->ml->get_records(
738 job_id => $job_id, # required
739 )
740 The get_records() method enables you to retrieve anomaly records for a
742 job.
743 See the get_records docs
745 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
746 get-record.html> for more information.
747 Query string parameters:
749 "desc",
750 "end",
751 "error_trace",
752 "exclude_interim",
753 "expand",
754 "from",
755 "human",
756 "record_score",
757 "size",
758 "sort",
759 "start"
760
762 "find_file_structure"
763 $response = $es->ml->find_file_structure(
764 body => { ... }, # required
765 )
766 The find_file_structure() method finds the structure of a text file
768 which contains data that is suitable to be ingested into Elasticsearch.
769 See the find_file_structure docs
771 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
772 find-file-structure.html> for more information.
773 Query string parameters:
775 "charset",
776 "column_names",
777 "delimiter",
778 "error_trace",
779 "explain",
780 "format",
781 "grok_pattern",
782 "has_header_row",
783 "human",
784 "lines_to_sample",
785 "quote",
786 "should_trim_fields",
787 "timeout",
788 "timestamp_field",
789 "timestamp_format"
790
792 "info"
793 $response = $es->ml->info();
794 The info() method returns defaults and limits used by machine learning.
796 See the find_file_structure docs
798 <https://www.elastic.co/guide/en/elasticsearch/reference/current/get-
799 ml-info.html> for more information.
800 Query string parameters:
802 "error_trace",
803 "human"
804
806 "set_upgrade_mode"
807 $response = $es->ml->set_upgrade_mode();
808 The set_upgrade_mode() method sets a cluster wide "upgrade_mode"
810 setting that prepares machine learning indices for an upgrade.
811 See the set_upgrade_mode docs
813 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-
814 set-upgrade-mode.html> for more information.
815 Query string parameters:
817 "enabled",
818 "error_trace",
819 "human",
820 "timeout"
821
823 Enrico Zimuel <enrico.zimuel@elastic.co>
824
826 This software is Copyright (c) 2022 by Elasticsearch BV.
827 This is free software, licensed under:
829 The Apache License, Version 2.0, January 2004
831perl v5.36.0 Searc2h0:2:3E-l0a1s-t2i0csearch::Client::8_0::Direct::ML(3)