NAME

Search::Elasticsearch::Client::6_0::Direct::XPack::ML - Plugin providing ML API for Search::Elasticsearch 6.x

VERSION

version 6.81

SYNOPSIS

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

DESCRIPTION

This class extends the Search::Elasticsearch client with an ml namespace, to support the Machine Learning APIs.

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

DATAFEED METHODS

put_datafeed()

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

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

See the put_datafeed docs for more information.

Query string parameters: error_trace, human

delete_datafeed()

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

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

See the delete_datafeed docs for more information.

Query string parameters: error_trace, force, human

start_datafeed()

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

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

See the start_datafeed docs for more information.

Query string parameters: end, error_trace, human, start, timeout

stop_datafeed()

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

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

See the stop_datafeed docs for more information.

Query string parameters: allow_no_datafeeds, error_trace, force, human, timeout

get_datafeeds()

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

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

See the get_datafeeds docs for more information.

Query string parameters: allow_no_datafeeds, error_trace, human

get_datafeed_stats()

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

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

See the get_datafeed_stats docs for more information.

Query string parameters: allow_no_datafeeds, error_trace, human

preview_datafeed()

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

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

See the preview_datafeed docs for more information.

Query string parameters: error_trace, human

update_datafeed()

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

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

See the update_datafeed docs for more information.

Query string parameters: error_trace, human

JOB METHODS

put_job()

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

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

See the put_job docs for more information.

Query string parameters: error_trace, human

delete_job()

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

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

See the delete_job docs for more information.

Query string parameters: error_trace, force, human, wait_for_completion

open_job()

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

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

See the open_job docs for more information.

Query string parameters: error_trace, human

close_job()

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

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

See the close_job docs for more information.

Query string parameters: allow_no_jobs, error_trace, force, human, timeout

get_jobs()

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

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

See the get_jobs docs for more information.

Query string parameters: allow_no_jobs, error_trace, human

get_job_stats()

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

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

See the get_job_statss docs for more information.

Query string parameters: allow_no_jobs, error_trace, human

flush_job()

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

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

See the flush_job docs for more information.

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

post_data()

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

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

See the post_data docs for more information.

Query string parameters: error_trace, human, reset_end, reset_start

update_job()

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

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

See the update_job docs for more information.

Query string parameters: error_trace, human

delete_expired_data

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

The delete_expired_data() method deletes expired machine learning data.

See the delete_expired_data docs for more information.

Query string parameters: error_trace, human

CALENDAR METHODS

put_calendar()

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

The put_calendar() method creates a new calendar.

Query string parameters: error_trace, human

See the put calendar docs for more information.

delete_calendar()

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

The delete_calendar() method deletes the specified calendar

Query string parameters: error_trace, human

See the delete_calendar docs for more information.

put_calendar_job()

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

The put_calendar_job() method adds a job to a calendar.

Query string parameters: error_trace, human

See the put_calendar_job docs for more information.

delete_calendar_job()

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

The delete_calendar_job() method deletes a job from a calendar.

Query string parameters: error_trace, human

See the delete_calendar_job docs for more information.

put_calendar_event()

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

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

Query string parameters: error_trace, human

See the post_calendar_events docs for more information.

delete_calendar_event()

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

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

Query string parameters: error_trace, human

See the delete_calendar_event docs for more information.

get_calendars()

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

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

Query string parameters: error_trace, from, human, size

See the get_calendars docs for more information.

get_calendar_events()

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

The get_calendar_events() method retrieves events from a calendar.

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

See the get_calendar_events docs for more information.

FILTER METHODS

put_filter()

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

The put_filter() method creates a named filter.

Query string parameters: error_trace, human

See the put_filter docs for more information.

update_filter()

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

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

Query string parameters: error_trace, human

See the update_filter docs for more information.

get_filters()

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

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

Query string parameters: error_trace, from, human, size

See the get_filters docs for more information.

delete_filter()

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

The delete_filter() method deletes a named filter.

Query string parameters: error_trace, human

See the delete_filters docs for more information.

FORECAST METHODS

forecast()

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

The forecast() method enables you to create a new forecast

See the forecast docs for more information.

Query string parameters: duration, error_trace, expires_in, human

delete_forecast()

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

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

See the delete_forecast docs for more information.

Query string parameters: allow_no_forecasts, error_trace, human, timeout

MODEL SNAPSHOT METHODS

delete_model_snapshot()

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

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

See the delete_model_snapshot docs for more information.

Query string parameters: error_trace, human

get_model_snapshots()

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

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

See the get_model_snapshots docs for more information.

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

revert_model_snapshot()

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

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

See the revert_model_snapshot docs for more information.

Query string parameters: delete_intervening_results, error_trace, human

update_model_snapshot()

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

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

See the update_model_snapshot docs for more information.

Query string parameters: error_trace, human

RESULT METHODS

get_buckets()

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

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

See the get_buckets docs for more information.

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

get_overall_buckets()

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

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

See the get_overall_buckets docs for more information.

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

get_categories()

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

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

See the get_categories docs for more information.

Query string parameters: error_trace, from, human, size

get_influencers()

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

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

See the get_influencers docs for more information.

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

get_records()

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

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

See the get_records docs for more information.

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

FILE STRUCTURE METHODS

find_file_structure

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

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

See the find_file_structure docs for more information.

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

INFO METHODS

info

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

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

See the find_file_structure docs for more information.

Query string parameters: error_trace, human

UPGRADE METHODS

set_upgrade_mode

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

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

See the set_upgrade_mode docs for more information.

Query string parameters: enabled, error_trace, human, timeout

AUTHOR

Enrico Zimuel <enrico.zimuel@elastic.co>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2020 by Elasticsearch BV.

This is free software, licensed under:

  The Apache License, Version 2.0, January 2004