# Licensed to Elasticsearch B.V. under one or more contributor # license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright # ownership. Elasticsearch B.V. licenses this file to you under # the Apache License, Version 2.0 (the "License"); you may # not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, # software distributed under the License is distributed on an # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY # KIND, either express or implied. See the License for the # specific language governing permissions and limitations # under the License. package Search::Elasticsearch::Client::8_0::Direct::ML; $Search::Elasticsearch::Client::8_0::Direct::ML::VERSION = '8.12'; use Moo; with 'Search::Elasticsearch::Client::8_0::Role::API'; with 'Search::Elasticsearch::Role::Client::Direct'; use namespace::clean; __PACKAGE__->_install_api('ml'); 1; =pod =encoding UTF-8 =head1 NAME Search::Elasticsearch::Client::8_0::Direct::ML - Plugin providing ML API for Search::Elasticsearch 8.x =head1 VERSION version 8.12 =head1 SYNOPSIS my $response = $es->ml->start_datafeed(...) =head2 DESCRIPTION This class extends the L client with an C namespace, to support the L. The full documentation for the ML feature is available here: L =head1 DATAFEED METHODS =head2 C $response = $es->ml->put_datafeed( datafeed_id => $id # required body => {...} # required ) The C method enables you to instantiate a datafeed. See the L for more information. Query string parameters: C, C =head2 C $response = $es->xpack->ml->delete_datafeed( datafeed_id => $id # required ) The C method enables you to delete a datafeed. See the L for more information. Query string parameters: C, C, C =head2 C $response = $es->ml->start_datafeed( datafeed_id => $id # required ) The C method enables you to start a datafeed. See the L for more information. Query string parameters: C, C, C, C, C =head2 C $response = $es->ml->stop_datafeed( datafeed_id => $id # required ) The C method enables you to stop a datafeed. See the L for more information. Query string parameters: C, C, C, C, C =head2 C $response = $es->ml->get_datafeeds( datafeed_id => $id # optional ) The C method enables you to retrieve configuration information for datafeeds. See the L for more information. Query string parameters: C, C, C =head2 C $response = $es->ml->get_datafeed_stats( datafeed_id => $id # optional ) The C method enables you to retrieve configuration information for datafeeds. See the L for more information. Query string parameters: C, C, C =head2 C $response = $es->ml->preview_datafeed( datafeed_id => $id # required ) The C method enables you to preview a datafeed. See the L for more information. Query string parameters: C, C =head2 C $response = $es->ml->update_datafeed( datafeed_id => $id # required body => {...} # required ) The C method enables you to update certain properties of a datafeed. See the L for more information. Query string parameters: C, C =head1 JOB METHODS =head2 C $response = $es->ml->put_job( job_id => $id # required body => {...} # required ) The C method enables you to instantiate a job. See the L for more information. Query string parameters: C, C =head2 C $response = $es->ml->delete_job( job_id => $id # required ) The C method enables you to delete a job. See the L for more information. Query string parameters: C, C, C, C =head2 C $response = $es->ml->open_job( job_id => $id # required ) The C method enables you to open a closed job. See the L for more information. Query string parameters: C, C =head2 C $response = $es->ml->close_job( job_id => $id # required ) The C method enables you to close an open job. See the L for more information. Query string parameters: C, C, C, C, C =head2 C $response = $es->ml->get_jobs( job_id => $id # optional ) The C method enables you to retrieve configuration information for jobs. See the L for more information. Query string parameters: C, C, C =head2 C $response = $es->ml->get_jobs_stats( job_id => $id # optional ) The C method enables you to retrieve usage information for jobs. See the L for more information. Query string parameters: C, C, C =head2 C $response = $es->ml->flush_job( job_id => $id # required ) The C method forces any buffered data to be processed by the job. See the L for more information. Query string parameters: C, C, C, C, C, C, C =head2 C $response = $es->ml->post_data( job_id => $id # required body => [data] # required ) The C method enables you to send data to an anomaly detection job for analysis. See the L for more information. Query string parameters: C, C, C, C =head2 C $response = $es->ml->update_job( job_id => $id # required body => {...} # required ) The C method enables you to update certain properties of a job. See the L for more information. Query string parameters: C, C =head2 C $response = $es->ml->delete_expired_data( ) The C method deletes expired machine learning data. See the L for more information. Query string parameters: C, C =head1 CALENDAR METHODS =head2 C $response = $es->ml->put_calendar( calendar_id => $id # required body => {...} # optional ) The C method creates a new calendar. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->delete_calendar( calendar_id => $id # required ) The C method deletes the specified calendar Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->put_calendar_job( calendar_id => $id, # required job_id => $id # required ) The C method adds a job to a calendar. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->delete_calendar_job( calendar_id => $id, # required job_id => $id # required ) The C method deletes a job from a calendar. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->post_calendar_events( calendar_id => $id, # required body => {...} # required ) The C method adds scheduled events to a calendar. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->delete_calendar_event( calendar_id => $id, # required event_id => $id # required ) The C method deletes an event from a calendar. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->get_calendars( calendar_id => $id, # optional ) The C method returns the specified calendar or all calendars. Query string parameters: C, C, C, C See the L for more information. =head2 C $response = $es->ml->get_calendar_events( calendar_id => $id, # required ) The C method retrieves events from a calendar. Query string parameters: C, C, C, C, C, C, C See the L for more information. =head1 FILTER METHODS =head2 C $response = $es->ml->put_filter( filter_id => $id, # required body => {...} # required ) The C method creates a named filter. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->update_filter( filter_id => $id, # required body => {...} # required ) The C method updates the description of a filter, adds items, or removes items. Query string parameters: C, C See the L for more information. =head2 C $response = $es->ml->get_filters( filter_id => $id, # optional ) The C method retrieves a named filter or all filters. Query string parameters: C, C, C, C See the L for more information. =head2 C $response = $es->ml->delete_filter( filter_id => $id, # required ) The C method deletes a named filter. Query string parameters: C, C See the L for more information. =head1 FORECAST METHODS =head2 C $response = $es->ml->forecast( job_id => $id # required ) The C method enables you to create a new forecast See the L for more information. Query string parameters: C, C, C, C =head2 C $response = $es->ml->delete_forecast( forecast_id => $id, # required job_id => $id # required ) The C method enables you to delete an existing forecast. See the L for more information. Query string parameters: C, C, C, C =head1 MODEL SNAPSHOT METHODS =head2 C $response = $es->ml->delete_model_snapshot( snapshot_id => $id # required ) The C method enables you to delete an existing model snapshot. See the L for more information. Query string parameters: C, C =head2 C $response = $es->ml->get_model_snapshots( job_id => $job_id, # required snapshot_id => $snapshot_id # optional ) The C method enables you to retrieve information about model snapshots. See the L for more information. Query string parameters: C, C, C, C, C, C, C, C =head2 C $response = $es->ml->revert_model_snapshot( job_id => $job_id, # required snapshot_id => $snapshot_id # required ) The C method enables you to revert to a specific snapshot. See the L for more information. Query string parameters: C, C, C =head2 C $response = $es->ml->update_model_snapshot( job_id => $job_id, # required snapshot_id => $snapshot_id # required ) The C method enables you to update certain properties of a snapshot. See the L for more information. Query string parameters: C, C =head1 RESULT METHODS =head2 C $response = $es->ml->get_buckets( job_id => $job_id, # required timestamp => $timestamp # optional ) The C method enables you to retrieve job results for one or more buckets. See the L for more information. Query string parameters: C, C, C, C, C, C, C, C, C, C, C =head2 C $response = $es->ml->get_overall_buckets( job_id => $job_id, # required ) The C method retrieves overall bucket results that summarize the bucket results of multiple jobs. See the L for more information. Query string parameters: C, C, C, C, C, C, C, C, C =head2 C $response = $es->ml->get_categories( job_id => $job_id, # required category_id => $category_id # optional ) The C method enables you to retrieve job results for one or more categories. See the L for more information. Query string parameters: C, C, C, C =head2 C $response = $es->ml->get_influencers( job_id => $job_id, # required ) The C method enables you to retrieve job results for one or more influencers. See the L for more information. Query string parameters: C, C, C, C, C, C, C, C, C, C, C =head2 C $response = $es->ml->get_records( job_id => $job_id, # required ) The C method enables you to retrieve anomaly records for a job. See the L for more information. Query string parameters: C, C, C, C, C, C, C, C, C, C, C =head1 FILE STRUCTURE METHODS =head2 C $response = $es->ml->find_file_structure( body => { ... }, # required ) The C method finds the structure of a text file which contains data that is suitable to be ingested into Elasticsearch. See the L for more information. Query string parameters: C, C, C, C, C, C, C, C, C, C, C, C, C, C, C =head1 INFO METHODS =head2 C $response = $es->ml->info(); The C method returns defaults and limits used by machine learning. See the L for more information. Query string parameters: C, C =head1 UPGRADE METHODS =head2 C $response = $es->ml->set_upgrade_mode(); The C method sets a cluster wide C setting that prepares machine learning indices for an upgrade. See the L for more information. Query string parameters: C, C, C, C =head1 AUTHOR Enrico Zimuel =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2024 by Elasticsearch BV. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut __END__ # ABSTRACT: Plugin providing ML API for Search::Elasticsearch 8.x