lib/Search/Elasticsearch/Client/7_0/Direct/ML.pm

# 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::7_0::Direct::ML;

use Moo;
with 'Search::Elasticsearch::Client::7_0::Role::API';
with 'Search::Elasticsearch::Role::Client::Direct';
use namespace::clean;

__PACKAGE__->_install_api('ml');

1;

__END__

# ABSTRACT: Plugin providing ML API for Search::Elasticsearch 7.x

=head1 SYNOPSIS

    my $response = $es->ml->start_datafeed(...)

=head2 DESCRIPTION

This class extends the L<Search::Elasticsearch> client with an C<ml>
namespace, to support the
L<Machine Learning APIs|https://www.elastic.co/guide/en/x-pack/7.0/xpack-ml.html>.

The full documentation for the ML feature is available here:
L<https://www.elastic.co/guide/en/x-pack/7.0/xpack-ml.html>

=head1 DATAFEED METHODS

=head2 C<put_datafeed()>

    $response = $es->ml->put_datafeed(
        datafeed_id => $id      # required
        body        => {...}    # required
    )

The C<put_datafeed()> method enables you to instantiate a datafeed.

See the L<put_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head2 C<delete_datafeed()>

    $response = $es->xpack->ml->delete_datafeed(
        datafeed_id => $id      # required
    )

The C<delete_datafeed()> method enables you to delete a datafeed.

See the L<delete_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<force>,
    C<human>

=head2 C<start_datafeed()>

    $response = $es->ml->start_datafeed(
        datafeed_id => $id      # required
    )

The C<start_datafeed()> method enables you to start a datafeed.

See the L<start_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html>
for more information.

Query string parameters:
    C<end>,
    C<error_trace>,
    C<human>,
    C<start>,
    C<timeout>

=head2 C<stop_datafeed()>

    $response = $es->ml->stop_datafeed(
        datafeed_id => $id      # required
    )

The C<stop_datafeed()> method enables you to stop a datafeed.

See the L<stop_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html>
for more information.

Query string parameters:
    C<allow_no_datafeeds>,
    C<error_trace>,
    C<force>,
    C<human>,
    C<timeout>

=head2 C<get_datafeeds()>

    $response = $es->ml->get_datafeeds(
        datafeed_id => $id      # optional
    )

The C<get_datafeeds()> method enables you to retrieve configuration information for datafeeds.

See the L<get_datafeeds docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html>
for more information.

Query string parameters:
    C<allow_no_datafeeds>,
    C<error_trace>,
    C<human>

=head2 C<get_datafeed_stats()>

    $response = $es->ml->get_datafeed_stats(
        datafeed_id => $id      # optional
    )

The C<get_datafeed_stats()> method enables you to retrieve configuration information for datafeeds.

See the L<get_datafeed_stats docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html>
for more information.

Query string parameters:
    C<allow_no_datafeeds>,
    C<error_trace>,
    C<human>

=head2 C<preview_datafeed()>

    $response = $es->ml->preview_datafeed(
        datafeed_id => $id      # required
    )

The C<preview_datafeed()> method enables you to preview a datafeed.

See the L<preview_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head2 C<update_datafeed()>

    $response = $es->ml->update_datafeed(
        datafeed_id => $id      # required
        body        => {...}    # required
    )

The C<update_datafeed()> method enables you to update certain properties of a datafeed.

See the L<update_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head1 JOB METHODS

=head2 C<put_job()>

    $response = $es->ml->put_job(
        job_id => $id           # required
        body        => {...}    # required
    )

The C<put_job()> method enables you to instantiate a job.

See the L<put_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head2 C<delete_job()>

    $response = $es->ml->delete_job(
        job_id => $id           # required
    )

The C<delete_job()> method enables you to delete a job.

See the L<delete_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<force>,
    C<human>,
    C<wait_for_completion>

=head2 C<open_job()>

    $response = $es->ml->open_job(
        job_id => $id           # required
    )

The C<open_job()> method enables you to open a closed job.

See the L<open_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head2 C<close_job()>

    $response = $es->ml->close_job(
        job_id => $id           # required
    )

The C<close_job()> method enables you to close an open job.

See the L<close_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html>
for more information.

Query string parameters:
    C<allow_no_jobs>,
    C<error_trace>,
    C<force>,
    C<human>,
    C<timeout>

=head2 C<get_jobs()>

    $response = $es->ml->get_jobs(
        job_id => $id           # optional
    )

The C<get_jobs()> method enables you to retrieve configuration information for jobs.

See the L<get_jobs docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html>
for more information.

Query string parameters:
    C<allow_no_jobs>,
    C<error_trace>,
    C<human>

=head2 C<get_job_stats()>

    $response = $es->ml->get_jobs_stats(
        job_id => $id           # optional
    )

The C<get_jobs_stats()> method enables you to retrieve usage information for jobs.

See the L<get_job_statss docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html>
for more information.

Query string parameters:
    C<allow_no_jobs>,
    C<error_trace>,
    C<human>


=head2 C<flush_job()>

    $response = $es->ml->flush_job(
        job_id => $id           # required
    )

The C<flush_job()> method forces any buffered data to be processed by the job.

See the L<flush_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html>
for more information.

Query string parameters:
    C<advance_time>,
    C<calc_interm>,
    C<end>,
    C<error_trace>,
    C<human>,
    C<skip_time>,
    C<start>

=head2 C<post_data()>

    $response = $es->ml->post_data(
        job_id => $id           # required
        body   => [data]        # required
    )

The C<post_data()> method enables you to send data to an anomaly detection job for analysis.

See the L<post_data docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>,
    C<reset_end>,
    C<reset_start>

=head2 C<update_job()>

    $response = $es->ml->update_job(
        job_id => $id           # required
        body        => {...}    # required
    )

The C<update_job()> method enables you to update certain properties of a job.

See the L<update_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head2 C<delete_expired_data>

    $response = $es->ml->delete_expired_data(
    )

The C<delete_expired_data()> method deletes expired machine learning data.

See the L<delete_expired_data docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>


=head1 CALENDAR METHODS

=head2 C<put_calendar()>

    $response = $es->ml->put_calendar(
        calendar_id => $id      # required
        body        => {...}    # optional
    )

The C<put_calendar()> method creates a new calendar.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<put calendar docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html>
for more information.

=head2 C<delete_calendar()>

    $response = $es->ml->delete_calendar(
        calendar_id => $id      # required
    )

The C<delete_calendar()> method deletes the specified calendar

Query string parameters:
    C<error_trace>,
    C<human>

See the L<delete_calendar docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html>
for more information.

=head2 C<put_calendar_job()>

    $response = $es->ml->put_calendar_job(
        calendar_id => $id,     # required
        job_id      => $id      # required
    )

The C<put_calendar_job()> method adds a job to a calendar.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<put_calendar_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html>
for more information.

=head2 C<delete_calendar_job()>

    $response = $es->ml->delete_calendar_job(
        calendar_id => $id,     # required
        job_id      => $id      # required
    )

The C<delete_calendar_job()> method deletes a job from a calendar.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<delete_calendar_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html>
for more information.

=head2 C<put_calendar_event()>

    $response = $es->ml->post_calendar_events(
        calendar_id => $id,     # required
        body        => {...}    # required
    )

The C<post_calendar_events()> method adds scheduled events to a calendar.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<post_calendar_events docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-events.html>
for more information.


=head2 C<delete_calendar_event()>

    $response = $es->ml->delete_calendar_event(
        calendar_id => $id,     # required
        event_id    => $id      # required
    )

The C<delete_calendar_event()> method deletes an event from a calendar.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<delete_calendar_event docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html>
for more information.

=head2 C<get_calendars()>

    $response = $es->ml->get_calendars(
        calendar_id => $id,     # optional
    )

The C<get_calendars()> method returns the specified calendar or all calendars.

Query string parameters:
    C<error_trace>,
    C<from>,
    C<human>,
    C<size>

See the L<get_calendars docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html>
for more information.

=head2 C<get_calendar_events()>

    $response = $es->ml->get_calendar_events(
        calendar_id => $id,     # required
    )

The C<get_calendar_events()> method retrieves events from a calendar.

Query string parameters:
    C<end>,
    C<error_trace>,
    C<from>,
    C<human>,
    C<job_id>,
    C<size>,
    C<start>

See the L<get_calendar_events docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html>
for more information.

=head1 FILTER METHODS

=head2 C<put_filter()>

    $response = $es->ml->put_filter(
        filter_id   => $id,     # required
        body        => {...}    # required
    )

The C<put_filter()> method creates a named filter.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<put_filter docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html>
for more information.

=head2 C<update_filter()>

    $response = $es->ml->update_filter(
        filter_id   => $id,     # required
        body        => {...}    # required
    )

The C<update_filter()> method updates the description of a filter, adds items, or removes items.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<update_filter docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html>
for more information.

=head2 C<get_filters()>

    $response = $es->ml->get_filters(
        filter_id   => $id,     # optional
    )

The C<get_filters()> method retrieves a named filter or all filters.

Query string parameters:
    C<error_trace>,
    C<from>,
    C<human>,
    C<size>

See the L<get_filters docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filters.html>
for more information.

=head2 C<delete_filter()>

    $response = $es->ml->delete_filter(
        filter_id   => $id,     # required
    )

The C<delete_filter()> method deletes a named filter.

Query string parameters:
    C<error_trace>,
    C<human>

See the L<delete_filters docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html>
for more information.

=head1 FORECAST METHODS

=head2 C<forecast()>

    $response = $es->ml->forecast(
        job_id      => $id      # required
    )

The C<forecast()> method enables you to create a new forecast

See the L<forecast docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html>
for more information.

Query string parameters:
    C<duration>,
    C<error_trace>,
    C<expires_in>,
    C<human>

=head2 C<delete_forecast()>

    $response = $es->ml->delete_forecast(
        forecast_id => $id,     # required
        job_id      => $id      # required
    )

The C<delete_forecast()> method enables you to delete an existing forecast.

See the L<delete_forecast docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html>
for more information.

Query string parameters:
    C<allow_no_forecasts>,
    C<error_trace>,
    C<human>,
    C<timeout>

=head1 MODEL SNAPSHOT METHODS

=head2 C<delete_model_snapshot()>

    $response = $es->ml->delete_model_snapshot(
        snapshot_id => $id      # required
    )

The C<delete_model_snapshot()> method enables you to delete an existing model snapshot.

See the L<delete_model_snapshot docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head2 C<get_model_snapshots()>

    $response = $es->ml->get_model_snapshots(
        job_id      => $job_id,         # required
        snapshot_id => $snapshot_id     # optional
    )

The C<get_model_snapshots()> method enables you to retrieve information about model snapshots.

See the L<get_model_snapshots docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html>
for more information.

Query string parameters:
    C<desc>,
    C<end>,
    C<error_trace>,
    C<from>,
    C<human>,
    C<size>,
    C<sort>,
    C<start>

=head2 C<revert_model_snapshot()>

    $response = $es->ml->revert_model_snapshot(
        job_id      => $job_id,         # required
        snapshot_id => $snapshot_id     # required
    )

The C<revert_model_snapshots()> method enables you to revert to a specific snapshot.

See the L<revert_model_snapshot docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html>
for more information.

Query string parameters:
    C<delete_intervening_results>,
    C<error_trace>,
    C<human>

=head2 C<update_model_snapshot()>

    $response = $es->ml->update_model_snapshot(
        job_id      => $job_id,         # required
        snapshot_id => $snapshot_id     # required
    )

The C<update_model_snapshots()> method enables you to update certain properties of a snapshot.

See the L<update_model_snapshot docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head1 RESULT METHODS

=head2 C<get_buckets()>

    $response = $es->ml->get_buckets(
        job_id      => $job_id,         # required
        timestamp   => $timestamp       # optional
    )

The C<get_buckets()> method enables you to retrieve job results for one or more buckets.

See the L<get_buckets docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html>
for more information.

Query string parameters:
    C<anomaly_score>,
    C<desc>,
    C<end>,
    C<error_trace>,
    C<exclude_interim>,
    C<expand>,
    C<from>,
    C<human>,
    C<size>,
    C<sort>,
    C<start>

=head2 C<get_overall_buckets()>

    $response = $es->ml->get_overall_buckets(
        job_id      => $job_id,         # required
    )

The C<get_overall_buckets()> method retrieves overall bucket results that summarize the bucket results of multiple jobs.

See the L<get_overall_buckets docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html>
for more information.

Query string parameters:
    C<allow_no_jobs>,
    C<bucket_span>,
    C<end>,
    C<error_trace>,
    C<exclude_interim>,
    C<human>,
    C<overall_score>,
    C<start>,
    C<top_n>

=head2 C<get_categories()>

    $response = $es->ml->get_categories(
        job_id      => $job_id,         # required
        category_id => $category_id     # optional
    )

The C<get_categories()> method enables you to retrieve job results for one or more categories.

See the L<get_categories docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<from>,
    C<human>,
    C<size>


=head2 C<get_influencers()>

    $response = $es->ml->get_influencers(
        job_id      => $job_id,         # required
    )

The C<get_influencers()> method enables you to retrieve job results for one or more influencers.

See the L<get_influencers docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html>
for more information.

Query string parameters:
    C<desc>,
    C<end>,
    C<error_trace>,
    C<exclude_interim>,
    C<expand>,
    C<from>,
    C<human>,
    C<influencer_score>,
    C<size>,
    C<sort>,
    C<start>

=head2 C<get_records()>

    $response = $es->ml->get_records(
        job_id      => $job_id,         # required
    )

The C<get_records()> method enables you to retrieve anomaly records for a job.

See the L<get_records docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html>
for more information.

Query string parameters:
    C<desc>,
    C<end>,
    C<error_trace>,
    C<exclude_interim>,
    C<expand>,
    C<from>,
    C<human>,
    C<record_score>,
    C<size>,
    C<sort>,
    C<start>

=head1 FILE STRUCTURE METHODS

=head2 C<find_file_structure>


    $response = $es->ml->find_file_structure(
        body    => { ... },         # required
    )

The C<find_file_structure()> method finds the structure of a text file which contains data
that is suitable to be ingested into Elasticsearch.

See the L<find_file_structure docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html>
for more information.

Query string parameters:
    C<charset>,
    C<column_names>,
    C<delimiter>,
    C<error_trace>,
    C<explain>,
    C<format>,
    C<grok_pattern>,
    C<has_header_row>,
    C<human>,
    C<lines_to_sample>,
    C<quote>,
    C<should_trim_fields>,
    C<timeout>,
    C<timestamp_field>,
    C<timestamp_format>



=head1 INFO METHODS


=head2 C<info>

    $response = $es->ml->info();

The C<info()> method returns defaults and limits used by machine learning.

See the L<find_file_structure docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html>
for more information.

Query string parameters:
    C<error_trace>,
    C<human>

=head1 UPGRADE METHODS

=head2 C<set_upgrade_mode>

    $response = $es->ml->set_upgrade_mode();

The C<set_upgrade_mode()> method sets a cluster wide C<upgrade_mode> setting that prepares
machine learning indices for an upgrade.

See the L<set_upgrade_mode docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html>
for more information.

Query string parameters:
    C<enabled>,
    C<error_trace>,
    C<human>,
    C<timeout>