DESCRIPTION¶

This class extends the Search::Elasticsearch client with an "ml" namespace, to support the 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: <https://www.elastic.co/guide/en/x-pack/7.0/xpack-ml.html>

put_datafeed()¶

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

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

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

Query string parameters:
"error_trace",
"force",
"human"

start_datafeed()¶

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

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

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

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

stop_datafeed()¶

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

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

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

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

get_datafeeds()¶

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

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

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

Query string parameters:
"allow_no_datafeeds",
"error_trace",
"human"

get_datafeed_stats()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html> for more information.

Query string parameters:
"allow_no_datafeeds",
"error_trace",
"human"

preview_datafeed()¶

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

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

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

Query string parameters:
"error_trace",
"human"

update_datafeed()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html> for more information.

Query string parameters:
"error_trace",
"human"

put_job()¶

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

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

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

Query string parameters:
"error_trace",
"human"

delete_job()¶

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

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

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

Query string parameters:
"error_trace",
"force",
"human",
"wait_for_completion"

open_job()¶

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

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

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

Query string parameters:
"error_trace",
"human"

close_job()¶

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

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

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

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

get_jobs()¶

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

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

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

Query string parameters:
"allow_no_jobs",
"error_trace",
"human"

get_job_stats()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html> for more information.

Query string parameters:
"allow_no_jobs",
"error_trace",
"human"

flush_job()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html> for more information.

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

post_data()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html> for more information.

Query string parameters:
"error_trace",
"human",
"reset_end",
"reset_start"

update_job()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html> for more information.

Query string parameters:
"error_trace",
"human"

"delete_expired_data"¶

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

The delete_expired_data() method deletes expired machine learning data.

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

Query string parameters:
"error_trace",
"human"

put_calendar()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html> for more information.

delete_calendar()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html> for more information.

put_calendar_job()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html> for more information.

delete_calendar_job()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html> for more information.

put_calendar_event()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-events.html> for more information.

delete_calendar_event()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html> for more information.

get_calendars()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html> for more information.

get_calendar_events()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html> for more information.

put_filter()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html> for more information.

update_filter()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html> for more information.

get_filters()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filters.html> for more information.

delete_filter()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html> for more information.

forecast()¶

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

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

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

Query string parameters:
"duration",
"error_trace",
"expires_in",
"human"

delete_forecast()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html> for more information.

Query string parameters:
"allow_no_forecasts",
"error_trace",
"human",
"timeout"

delete_model_snapshot()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html> for more information.

Query string parameters:
"error_trace",
"human"

get_model_snapshots()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html> for more information.

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

revert_model_snapshot()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html> for more information.

Query string parameters:
"delete_intervening_results",
"error_trace",
"human"

update_model_snapshot()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html> for more information.

Query string parameters:
"error_trace",
"human"

get_buckets()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html> 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->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html> 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->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html> for more information.

Query string parameters:
"error_trace",
"from",
"human",
"size"

get_influencers()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html> for more information.

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

get_records()¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html> for more information.

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

"find_file_structure"¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html> 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"¶

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

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

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

Query string parameters:
"error_trace",
"human"

"set_upgrade_mode"¶

    $response = $es->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 <https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html> for more information.

Query string parameters:
"enabled",
"error_trace",
"human",
"timeout"