| 1 |
# Licensed to Elasticsearch B.V. under one or more contributor |
| 2 |
# license agreements. See the NOTICE file distributed with |
| 3 |
# this work for additional information regarding copyright |
| 4 |
# ownership. Elasticsearch B.V. licenses this file to you under |
| 5 |
# the Apache License, Version 2.0 (the "License"); you may |
| 6 |
# not use this file except in compliance with the License. |
| 7 |
# You may obtain a copy of the License at |
| 8 |
# |
| 9 |
# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 |
# |
| 11 |
# Unless required by applicable law or agreed to in writing, |
| 12 |
# software distributed under the License is distributed on an |
| 13 |
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 |
# KIND, either express or implied. See the License for the |
| 15 |
# specific language governing permissions and limitations |
| 16 |
# under the License. |
| 17 |
|
| 18 |
package Search::Elasticsearch::Client::8_0::Direct::ML; |
| 19 |
$Search::Elasticsearch::Client::8_0::Direct::ML::VERSION = '8.12'; |
| 20 |
use Moo; |
| 21 |
with 'Search::Elasticsearch::Client::8_0::Role::API'; |
| 22 |
with 'Search::Elasticsearch::Role::Client::Direct'; |
| 23 |
use namespace::clean; |
| 24 |
|
| 25 |
__PACKAGE__->_install_api('ml'); |
| 26 |
|
| 27 |
1; |
| 28 |
|
| 29 |
=pod |
| 30 |
|
| 31 |
=encoding UTF-8 |
| 32 |
|
| 33 |
=head1 NAME |
| 34 |
|
| 35 |
Search::Elasticsearch::Client::8_0::Direct::ML - Plugin providing ML API for Search::Elasticsearch 8.x |
| 36 |
|
| 37 |
=head1 VERSION |
| 38 |
|
| 39 |
version 8.12 |
| 40 |
|
| 41 |
=head1 SYNOPSIS |
| 42 |
|
| 43 |
my $response = $es->ml->start_datafeed(...) |
| 44 |
|
| 45 |
=head2 DESCRIPTION |
| 46 |
|
| 47 |
This class extends the L<Search::Elasticsearch> client with an C<ml> |
| 48 |
namespace, to support the |
| 49 |
L<Machine Learning APIs|https://www.elastic.co/guide/en/x-pack/7.0/xpack-ml.html>. |
| 50 |
|
| 51 |
The full documentation for the ML feature is available here: |
| 52 |
L<https://www.elastic.co/guide/en/x-pack/7.0/xpack-ml.html> |
| 53 |
|
| 54 |
=head1 DATAFEED METHODS |
| 55 |
|
| 56 |
=head2 C<put_datafeed()> |
| 57 |
|
| 58 |
$response = $es->ml->put_datafeed( |
| 59 |
datafeed_id => $id # required |
| 60 |
body => {...} # required |
| 61 |
) |
| 62 |
|
| 63 |
The C<put_datafeed()> method enables you to instantiate a datafeed. |
| 64 |
|
| 65 |
See the L<put_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html> |
| 66 |
for more information. |
| 67 |
|
| 68 |
Query string parameters: |
| 69 |
C<error_trace>, |
| 70 |
C<human> |
| 71 |
|
| 72 |
=head2 C<delete_datafeed()> |
| 73 |
|
| 74 |
$response = $es->xpack->ml->delete_datafeed( |
| 75 |
datafeed_id => $id # required |
| 76 |
) |
| 77 |
|
| 78 |
The C<delete_datafeed()> method enables you to delete a datafeed. |
| 79 |
|
| 80 |
See the L<delete_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html> |
| 81 |
for more information. |
| 82 |
|
| 83 |
Query string parameters: |
| 84 |
C<error_trace>, |
| 85 |
C<force>, |
| 86 |
C<human> |
| 87 |
|
| 88 |
=head2 C<start_datafeed()> |
| 89 |
|
| 90 |
$response = $es->ml->start_datafeed( |
| 91 |
datafeed_id => $id # required |
| 92 |
) |
| 93 |
|
| 94 |
The C<start_datafeed()> method enables you to start a datafeed. |
| 95 |
|
| 96 |
See the L<start_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html> |
| 97 |
for more information. |
| 98 |
|
| 99 |
Query string parameters: |
| 100 |
C<end>, |
| 101 |
C<error_trace>, |
| 102 |
C<human>, |
| 103 |
C<start>, |
| 104 |
C<timeout> |
| 105 |
|
| 106 |
=head2 C<stop_datafeed()> |
| 107 |
|
| 108 |
$response = $es->ml->stop_datafeed( |
| 109 |
datafeed_id => $id # required |
| 110 |
) |
| 111 |
|
| 112 |
The C<stop_datafeed()> method enables you to stop a datafeed. |
| 113 |
|
| 114 |
See the L<stop_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html> |
| 115 |
for more information. |
| 116 |
|
| 117 |
Query string parameters: |
| 118 |
C<allow_no_datafeeds>, |
| 119 |
C<error_trace>, |
| 120 |
C<force>, |
| 121 |
C<human>, |
| 122 |
C<timeout> |
| 123 |
|
| 124 |
=head2 C<get_datafeeds()> |
| 125 |
|
| 126 |
$response = $es->ml->get_datafeeds( |
| 127 |
datafeed_id => $id # optional |
| 128 |
) |
| 129 |
|
| 130 |
The C<get_datafeeds()> method enables you to retrieve configuration information for datafeeds. |
| 131 |
|
| 132 |
See the L<get_datafeeds docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html> |
| 133 |
for more information. |
| 134 |
|
| 135 |
Query string parameters: |
| 136 |
C<allow_no_datafeeds>, |
| 137 |
C<error_trace>, |
| 138 |
C<human> |
| 139 |
|
| 140 |
=head2 C<get_datafeed_stats()> |
| 141 |
|
| 142 |
$response = $es->ml->get_datafeed_stats( |
| 143 |
datafeed_id => $id # optional |
| 144 |
) |
| 145 |
|
| 146 |
The C<get_datafeed_stats()> method enables you to retrieve configuration information for datafeeds. |
| 147 |
|
| 148 |
See the L<get_datafeed_stats docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html> |
| 149 |
for more information. |
| 150 |
|
| 151 |
Query string parameters: |
| 152 |
C<allow_no_datafeeds>, |
| 153 |
C<error_trace>, |
| 154 |
C<human> |
| 155 |
|
| 156 |
=head2 C<preview_datafeed()> |
| 157 |
|
| 158 |
$response = $es->ml->preview_datafeed( |
| 159 |
datafeed_id => $id # required |
| 160 |
) |
| 161 |
|
| 162 |
The C<preview_datafeed()> method enables you to preview a datafeed. |
| 163 |
|
| 164 |
See the L<preview_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html> |
| 165 |
for more information. |
| 166 |
|
| 167 |
Query string parameters: |
| 168 |
C<error_trace>, |
| 169 |
C<human> |
| 170 |
|
| 171 |
=head2 C<update_datafeed()> |
| 172 |
|
| 173 |
$response = $es->ml->update_datafeed( |
| 174 |
datafeed_id => $id # required |
| 175 |
body => {...} # required |
| 176 |
) |
| 177 |
|
| 178 |
The C<update_datafeed()> method enables you to update certain properties of a datafeed. |
| 179 |
|
| 180 |
See the L<update_datafeed docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html> |
| 181 |
for more information. |
| 182 |
|
| 183 |
Query string parameters: |
| 184 |
C<error_trace>, |
| 185 |
C<human> |
| 186 |
|
| 187 |
=head1 JOB METHODS |
| 188 |
|
| 189 |
=head2 C<put_job()> |
| 190 |
|
| 191 |
$response = $es->ml->put_job( |
| 192 |
job_id => $id # required |
| 193 |
body => {...} # required |
| 194 |
) |
| 195 |
|
| 196 |
The C<put_job()> method enables you to instantiate a job. |
| 197 |
|
| 198 |
See the L<put_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html> |
| 199 |
for more information. |
| 200 |
|
| 201 |
Query string parameters: |
| 202 |
C<error_trace>, |
| 203 |
C<human> |
| 204 |
|
| 205 |
=head2 C<delete_job()> |
| 206 |
|
| 207 |
$response = $es->ml->delete_job( |
| 208 |
job_id => $id # required |
| 209 |
) |
| 210 |
|
| 211 |
The C<delete_job()> method enables you to delete a job. |
| 212 |
|
| 213 |
See the L<delete_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html> |
| 214 |
for more information. |
| 215 |
|
| 216 |
Query string parameters: |
| 217 |
C<error_trace>, |
| 218 |
C<force>, |
| 219 |
C<human>, |
| 220 |
C<wait_for_completion> |
| 221 |
|
| 222 |
=head2 C<open_job()> |
| 223 |
|
| 224 |
$response = $es->ml->open_job( |
| 225 |
job_id => $id # required |
| 226 |
) |
| 227 |
|
| 228 |
The C<open_job()> method enables you to open a closed job. |
| 229 |
|
| 230 |
See the L<open_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html> |
| 231 |
for more information. |
| 232 |
|
| 233 |
Query string parameters: |
| 234 |
C<error_trace>, |
| 235 |
C<human> |
| 236 |
|
| 237 |
=head2 C<close_job()> |
| 238 |
|
| 239 |
$response = $es->ml->close_job( |
| 240 |
job_id => $id # required |
| 241 |
) |
| 242 |
|
| 243 |
The C<close_job()> method enables you to close an open job. |
| 244 |
|
| 245 |
See the L<close_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html> |
| 246 |
for more information. |
| 247 |
|
| 248 |
Query string parameters: |
| 249 |
C<allow_no_jobs>, |
| 250 |
C<error_trace>, |
| 251 |
C<force>, |
| 252 |
C<human>, |
| 253 |
C<timeout> |
| 254 |
|
| 255 |
=head2 C<get_jobs()> |
| 256 |
|
| 257 |
$response = $es->ml->get_jobs( |
| 258 |
job_id => $id # optional |
| 259 |
) |
| 260 |
|
| 261 |
The C<get_jobs()> method enables you to retrieve configuration information for jobs. |
| 262 |
|
| 263 |
See the L<get_jobs docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html> |
| 264 |
for more information. |
| 265 |
|
| 266 |
Query string parameters: |
| 267 |
C<allow_no_jobs>, |
| 268 |
C<error_trace>, |
| 269 |
C<human> |
| 270 |
|
| 271 |
=head2 C<get_job_stats()> |
| 272 |
|
| 273 |
$response = $es->ml->get_jobs_stats( |
| 274 |
job_id => $id # optional |
| 275 |
) |
| 276 |
|
| 277 |
The C<get_jobs_stats()> method enables you to retrieve usage information for jobs. |
| 278 |
|
| 279 |
See the L<get_job_statss docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html> |
| 280 |
for more information. |
| 281 |
|
| 282 |
Query string parameters: |
| 283 |
C<allow_no_jobs>, |
| 284 |
C<error_trace>, |
| 285 |
C<human> |
| 286 |
|
| 287 |
=head2 C<flush_job()> |
| 288 |
|
| 289 |
$response = $es->ml->flush_job( |
| 290 |
job_id => $id # required |
| 291 |
) |
| 292 |
|
| 293 |
The C<flush_job()> method forces any buffered data to be processed by the job. |
| 294 |
|
| 295 |
See the L<flush_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html> |
| 296 |
for more information. |
| 297 |
|
| 298 |
Query string parameters: |
| 299 |
C<advance_time>, |
| 300 |
C<calc_interm>, |
| 301 |
C<end>, |
| 302 |
C<error_trace>, |
| 303 |
C<human>, |
| 304 |
C<skip_time>, |
| 305 |
C<start> |
| 306 |
|
| 307 |
=head2 C<post_data()> |
| 308 |
|
| 309 |
$response = $es->ml->post_data( |
| 310 |
job_id => $id # required |
| 311 |
body => [data] # required |
| 312 |
) |
| 313 |
|
| 314 |
The C<post_data()> method enables you to send data to an anomaly detection job for analysis. |
| 315 |
|
| 316 |
See the L<post_data docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html> |
| 317 |
for more information. |
| 318 |
|
| 319 |
Query string parameters: |
| 320 |
C<error_trace>, |
| 321 |
C<human>, |
| 322 |
C<reset_end>, |
| 323 |
C<reset_start> |
| 324 |
|
| 325 |
=head2 C<update_job()> |
| 326 |
|
| 327 |
$response = $es->ml->update_job( |
| 328 |
job_id => $id # required |
| 329 |
body => {...} # required |
| 330 |
) |
| 331 |
|
| 332 |
The C<update_job()> method enables you to update certain properties of a job. |
| 333 |
|
| 334 |
See the L<update_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html> |
| 335 |
for more information. |
| 336 |
|
| 337 |
Query string parameters: |
| 338 |
C<error_trace>, |
| 339 |
C<human> |
| 340 |
|
| 341 |
=head2 C<delete_expired_data> |
| 342 |
|
| 343 |
$response = $es->ml->delete_expired_data( |
| 344 |
) |
| 345 |
|
| 346 |
The C<delete_expired_data()> method deletes expired machine learning data. |
| 347 |
|
| 348 |
See the L<delete_expired_data docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html> |
| 349 |
for more information. |
| 350 |
|
| 351 |
Query string parameters: |
| 352 |
C<error_trace>, |
| 353 |
C<human> |
| 354 |
|
| 355 |
=head1 CALENDAR METHODS |
| 356 |
|
| 357 |
=head2 C<put_calendar()> |
| 358 |
|
| 359 |
$response = $es->ml->put_calendar( |
| 360 |
calendar_id => $id # required |
| 361 |
body => {...} # optional |
| 362 |
) |
| 363 |
|
| 364 |
The C<put_calendar()> method creates a new calendar. |
| 365 |
|
| 366 |
Query string parameters: |
| 367 |
C<error_trace>, |
| 368 |
C<human> |
| 369 |
|
| 370 |
See the L<put calendar docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html> |
| 371 |
for more information. |
| 372 |
|
| 373 |
=head2 C<delete_calendar()> |
| 374 |
|
| 375 |
$response = $es->ml->delete_calendar( |
| 376 |
calendar_id => $id # required |
| 377 |
) |
| 378 |
|
| 379 |
The C<delete_calendar()> method deletes the specified calendar |
| 380 |
|
| 381 |
Query string parameters: |
| 382 |
C<error_trace>, |
| 383 |
C<human> |
| 384 |
|
| 385 |
See the L<delete_calendar docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html> |
| 386 |
for more information. |
| 387 |
|
| 388 |
=head2 C<put_calendar_job()> |
| 389 |
|
| 390 |
$response = $es->ml->put_calendar_job( |
| 391 |
calendar_id => $id, # required |
| 392 |
job_id => $id # required |
| 393 |
) |
| 394 |
|
| 395 |
The C<put_calendar_job()> method adds a job to a calendar. |
| 396 |
|
| 397 |
Query string parameters: |
| 398 |
C<error_trace>, |
| 399 |
C<human> |
| 400 |
|
| 401 |
See the L<put_calendar_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html> |
| 402 |
for more information. |
| 403 |
|
| 404 |
=head2 C<delete_calendar_job()> |
| 405 |
|
| 406 |
$response = $es->ml->delete_calendar_job( |
| 407 |
calendar_id => $id, # required |
| 408 |
job_id => $id # required |
| 409 |
) |
| 410 |
|
| 411 |
The C<delete_calendar_job()> method deletes a job from a calendar. |
| 412 |
|
| 413 |
Query string parameters: |
| 414 |
C<error_trace>, |
| 415 |
C<human> |
| 416 |
|
| 417 |
See the L<delete_calendar_job docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html> |
| 418 |
for more information. |
| 419 |
|
| 420 |
=head2 C<put_calendar_event()> |
| 421 |
|
| 422 |
$response = $es->ml->post_calendar_events( |
| 423 |
calendar_id => $id, # required |
| 424 |
body => {...} # required |
| 425 |
) |
| 426 |
|
| 427 |
The C<post_calendar_events()> method adds scheduled events to a calendar. |
| 428 |
|
| 429 |
Query string parameters: |
| 430 |
C<error_trace>, |
| 431 |
C<human> |
| 432 |
|
| 433 |
See the L<post_calendar_events docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-events.html> |
| 434 |
for more information. |
| 435 |
|
| 436 |
=head2 C<delete_calendar_event()> |
| 437 |
|
| 438 |
$response = $es->ml->delete_calendar_event( |
| 439 |
calendar_id => $id, # required |
| 440 |
event_id => $id # required |
| 441 |
) |
| 442 |
|
| 443 |
The C<delete_calendar_event()> method deletes an event from a calendar. |
| 444 |
|
| 445 |
Query string parameters: |
| 446 |
C<error_trace>, |
| 447 |
C<human> |
| 448 |
|
| 449 |
See the L<delete_calendar_event docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html> |
| 450 |
for more information. |
| 451 |
|
| 452 |
=head2 C<get_calendars()> |
| 453 |
|
| 454 |
$response = $es->ml->get_calendars( |
| 455 |
calendar_id => $id, # optional |
| 456 |
) |
| 457 |
|
| 458 |
The C<get_calendars()> method returns the specified calendar or all calendars. |
| 459 |
|
| 460 |
Query string parameters: |
| 461 |
C<error_trace>, |
| 462 |
C<from>, |
| 463 |
C<human>, |
| 464 |
C<size> |
| 465 |
|
| 466 |
See the L<get_calendars docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html> |
| 467 |
for more information. |
| 468 |
|
| 469 |
=head2 C<get_calendar_events()> |
| 470 |
|
| 471 |
$response = $es->ml->get_calendar_events( |
| 472 |
calendar_id => $id, # required |
| 473 |
) |
| 474 |
|
| 475 |
The C<get_calendar_events()> method retrieves events from a calendar. |
| 476 |
|
| 477 |
Query string parameters: |
| 478 |
C<end>, |
| 479 |
C<error_trace>, |
| 480 |
C<from>, |
| 481 |
C<human>, |
| 482 |
C<job_id>, |
| 483 |
C<size>, |
| 484 |
C<start> |
| 485 |
|
| 486 |
See the L<get_calendar_events docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html> |
| 487 |
for more information. |
| 488 |
|
| 489 |
=head1 FILTER METHODS |
| 490 |
|
| 491 |
=head2 C<put_filter()> |
| 492 |
|
| 493 |
$response = $es->ml->put_filter( |
| 494 |
filter_id => $id, # required |
| 495 |
body => {...} # required |
| 496 |
) |
| 497 |
|
| 498 |
The C<put_filter()> method creates a named filter. |
| 499 |
|
| 500 |
Query string parameters: |
| 501 |
C<error_trace>, |
| 502 |
C<human> |
| 503 |
|
| 504 |
See the L<put_filter docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html> |
| 505 |
for more information. |
| 506 |
|
| 507 |
=head2 C<update_filter()> |
| 508 |
|
| 509 |
$response = $es->ml->update_filter( |
| 510 |
filter_id => $id, # required |
| 511 |
body => {...} # required |
| 512 |
) |
| 513 |
|
| 514 |
The C<update_filter()> method updates the description of a filter, adds items, or removes items. |
| 515 |
|
| 516 |
Query string parameters: |
| 517 |
C<error_trace>, |
| 518 |
C<human> |
| 519 |
|
| 520 |
See the L<update_filter docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html> |
| 521 |
for more information. |
| 522 |
|
| 523 |
=head2 C<get_filters()> |
| 524 |
|
| 525 |
$response = $es->ml->get_filters( |
| 526 |
filter_id => $id, # optional |
| 527 |
) |
| 528 |
|
| 529 |
The C<get_filters()> method retrieves a named filter or all filters. |
| 530 |
|
| 531 |
Query string parameters: |
| 532 |
C<error_trace>, |
| 533 |
C<from>, |
| 534 |
C<human>, |
| 535 |
C<size> |
| 536 |
|
| 537 |
See the L<get_filters docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filters.html> |
| 538 |
for more information. |
| 539 |
|
| 540 |
=head2 C<delete_filter()> |
| 541 |
|
| 542 |
$response = $es->ml->delete_filter( |
| 543 |
filter_id => $id, # required |
| 544 |
) |
| 545 |
|
| 546 |
The C<delete_filter()> method deletes a named filter. |
| 547 |
|
| 548 |
Query string parameters: |
| 549 |
C<error_trace>, |
| 550 |
C<human> |
| 551 |
|
| 552 |
See the L<delete_filters docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html> |
| 553 |
for more information. |
| 554 |
|
| 555 |
=head1 FORECAST METHODS |
| 556 |
|
| 557 |
=head2 C<forecast()> |
| 558 |
|
| 559 |
$response = $es->ml->forecast( |
| 560 |
job_id => $id # required |
| 561 |
) |
| 562 |
|
| 563 |
The C<forecast()> method enables you to create a new forecast |
| 564 |
|
| 565 |
See the L<forecast docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html> |
| 566 |
for more information. |
| 567 |
|
| 568 |
Query string parameters: |
| 569 |
C<duration>, |
| 570 |
C<error_trace>, |
| 571 |
C<expires_in>, |
| 572 |
C<human> |
| 573 |
|
| 574 |
=head2 C<delete_forecast()> |
| 575 |
|
| 576 |
$response = $es->ml->delete_forecast( |
| 577 |
forecast_id => $id, # required |
| 578 |
job_id => $id # required |
| 579 |
) |
| 580 |
|
| 581 |
The C<delete_forecast()> method enables you to delete an existing forecast. |
| 582 |
|
| 583 |
See the L<delete_forecast docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html> |
| 584 |
for more information. |
| 585 |
|
| 586 |
Query string parameters: |
| 587 |
C<allow_no_forecasts>, |
| 588 |
C<error_trace>, |
| 589 |
C<human>, |
| 590 |
C<timeout> |
| 591 |
|
| 592 |
=head1 MODEL SNAPSHOT METHODS |
| 593 |
|
| 594 |
=head2 C<delete_model_snapshot()> |
| 595 |
|
| 596 |
$response = $es->ml->delete_model_snapshot( |
| 597 |
snapshot_id => $id # required |
| 598 |
) |
| 599 |
|
| 600 |
The C<delete_model_snapshot()> method enables you to delete an existing model snapshot. |
| 601 |
|
| 602 |
See the L<delete_model_snapshot docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html> |
| 603 |
for more information. |
| 604 |
|
| 605 |
Query string parameters: |
| 606 |
C<error_trace>, |
| 607 |
C<human> |
| 608 |
|
| 609 |
=head2 C<get_model_snapshots()> |
| 610 |
|
| 611 |
$response = $es->ml->get_model_snapshots( |
| 612 |
job_id => $job_id, # required |
| 613 |
snapshot_id => $snapshot_id # optional |
| 614 |
) |
| 615 |
|
| 616 |
The C<get_model_snapshots()> method enables you to retrieve information about model snapshots. |
| 617 |
|
| 618 |
See the L<get_model_snapshots docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html> |
| 619 |
for more information. |
| 620 |
|
| 621 |
Query string parameters: |
| 622 |
C<desc>, |
| 623 |
C<end>, |
| 624 |
C<error_trace>, |
| 625 |
C<from>, |
| 626 |
C<human>, |
| 627 |
C<size>, |
| 628 |
C<sort>, |
| 629 |
C<start> |
| 630 |
|
| 631 |
=head2 C<revert_model_snapshot()> |
| 632 |
|
| 633 |
$response = $es->ml->revert_model_snapshot( |
| 634 |
job_id => $job_id, # required |
| 635 |
snapshot_id => $snapshot_id # required |
| 636 |
) |
| 637 |
|
| 638 |
The C<revert_model_snapshots()> method enables you to revert to a specific snapshot. |
| 639 |
|
| 640 |
See the L<revert_model_snapshot docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html> |
| 641 |
for more information. |
| 642 |
|
| 643 |
Query string parameters: |
| 644 |
C<delete_intervening_results>, |
| 645 |
C<error_trace>, |
| 646 |
C<human> |
| 647 |
|
| 648 |
=head2 C<update_model_snapshot()> |
| 649 |
|
| 650 |
$response = $es->ml->update_model_snapshot( |
| 651 |
job_id => $job_id, # required |
| 652 |
snapshot_id => $snapshot_id # required |
| 653 |
) |
| 654 |
|
| 655 |
The C<update_model_snapshots()> method enables you to update certain properties of a snapshot. |
| 656 |
|
| 657 |
See the L<update_model_snapshot docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html> |
| 658 |
for more information. |
| 659 |
|
| 660 |
Query string parameters: |
| 661 |
C<error_trace>, |
| 662 |
C<human> |
| 663 |
|
| 664 |
=head1 RESULT METHODS |
| 665 |
|
| 666 |
=head2 C<get_buckets()> |
| 667 |
|
| 668 |
$response = $es->ml->get_buckets( |
| 669 |
job_id => $job_id, # required |
| 670 |
timestamp => $timestamp # optional |
| 671 |
) |
| 672 |
|
| 673 |
The C<get_buckets()> method enables you to retrieve job results for one or more buckets. |
| 674 |
|
| 675 |
See the L<get_buckets docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html> |
| 676 |
for more information. |
| 677 |
|
| 678 |
Query string parameters: |
| 679 |
C<anomaly_score>, |
| 680 |
C<desc>, |
| 681 |
C<end>, |
| 682 |
C<error_trace>, |
| 683 |
C<exclude_interim>, |
| 684 |
C<expand>, |
| 685 |
C<from>, |
| 686 |
C<human>, |
| 687 |
C<size>, |
| 688 |
C<sort>, |
| 689 |
C<start> |
| 690 |
|
| 691 |
=head2 C<get_overall_buckets()> |
| 692 |
|
| 693 |
$response = $es->ml->get_overall_buckets( |
| 694 |
job_id => $job_id, # required |
| 695 |
) |
| 696 |
|
| 697 |
The C<get_overall_buckets()> method retrieves overall bucket results that summarize the bucket results of multiple jobs. |
| 698 |
|
| 699 |
See the L<get_overall_buckets docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html> |
| 700 |
for more information. |
| 701 |
|
| 702 |
Query string parameters: |
| 703 |
C<allow_no_jobs>, |
| 704 |
C<bucket_span>, |
| 705 |
C<end>, |
| 706 |
C<error_trace>, |
| 707 |
C<exclude_interim>, |
| 708 |
C<human>, |
| 709 |
C<overall_score>, |
| 710 |
C<start>, |
| 711 |
C<top_n> |
| 712 |
|
| 713 |
=head2 C<get_categories()> |
| 714 |
|
| 715 |
$response = $es->ml->get_categories( |
| 716 |
job_id => $job_id, # required |
| 717 |
category_id => $category_id # optional |
| 718 |
) |
| 719 |
|
| 720 |
The C<get_categories()> method enables you to retrieve job results for one or more categories. |
| 721 |
|
| 722 |
See the L<get_categories docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html> |
| 723 |
for more information. |
| 724 |
|
| 725 |
Query string parameters: |
| 726 |
C<error_trace>, |
| 727 |
C<from>, |
| 728 |
C<human>, |
| 729 |
C<size> |
| 730 |
|
| 731 |
=head2 C<get_influencers()> |
| 732 |
|
| 733 |
$response = $es->ml->get_influencers( |
| 734 |
job_id => $job_id, # required |
| 735 |
) |
| 736 |
|
| 737 |
The C<get_influencers()> method enables you to retrieve job results for one or more influencers. |
| 738 |
|
| 739 |
See the L<get_influencers docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html> |
| 740 |
for more information. |
| 741 |
|
| 742 |
Query string parameters: |
| 743 |
C<desc>, |
| 744 |
C<end>, |
| 745 |
C<error_trace>, |
| 746 |
C<exclude_interim>, |
| 747 |
C<expand>, |
| 748 |
C<from>, |
| 749 |
C<human>, |
| 750 |
C<influencer_score>, |
| 751 |
C<size>, |
| 752 |
C<sort>, |
| 753 |
C<start> |
| 754 |
|
| 755 |
=head2 C<get_records()> |
| 756 |
|
| 757 |
$response = $es->ml->get_records( |
| 758 |
job_id => $job_id, # required |
| 759 |
) |
| 760 |
|
| 761 |
The C<get_records()> method enables you to retrieve anomaly records for a job. |
| 762 |
|
| 763 |
See the L<get_records docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html> |
| 764 |
for more information. |
| 765 |
|
| 766 |
Query string parameters: |
| 767 |
C<desc>, |
| 768 |
C<end>, |
| 769 |
C<error_trace>, |
| 770 |
C<exclude_interim>, |
| 771 |
C<expand>, |
| 772 |
C<from>, |
| 773 |
C<human>, |
| 774 |
C<record_score>, |
| 775 |
C<size>, |
| 776 |
C<sort>, |
| 777 |
C<start> |
| 778 |
|
| 779 |
=head1 FILE STRUCTURE METHODS |
| 780 |
|
| 781 |
=head2 C<find_file_structure> |
| 782 |
|
| 783 |
$response = $es->ml->find_file_structure( |
| 784 |
body => { ... }, # required |
| 785 |
) |
| 786 |
|
| 787 |
The C<find_file_structure()> method finds the structure of a text file which contains data |
| 788 |
that is suitable to be ingested into Elasticsearch. |
| 789 |
|
| 790 |
See the L<find_file_structure docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html> |
| 791 |
for more information. |
| 792 |
|
| 793 |
Query string parameters: |
| 794 |
C<charset>, |
| 795 |
C<column_names>, |
| 796 |
C<delimiter>, |
| 797 |
C<error_trace>, |
| 798 |
C<explain>, |
| 799 |
C<format>, |
| 800 |
C<grok_pattern>, |
| 801 |
C<has_header_row>, |
| 802 |
C<human>, |
| 803 |
C<lines_to_sample>, |
| 804 |
C<quote>, |
| 805 |
C<should_trim_fields>, |
| 806 |
C<timeout>, |
| 807 |
C<timestamp_field>, |
| 808 |
C<timestamp_format> |
| 809 |
|
| 810 |
=head1 INFO METHODS |
| 811 |
|
| 812 |
=head2 C<info> |
| 813 |
|
| 814 |
$response = $es->ml->info(); |
| 815 |
|
| 816 |
The C<info()> method returns defaults and limits used by machine learning. |
| 817 |
|
| 818 |
See the L<find_file_structure docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html> |
| 819 |
for more information. |
| 820 |
|
| 821 |
Query string parameters: |
| 822 |
C<error_trace>, |
| 823 |
C<human> |
| 824 |
|
| 825 |
=head1 UPGRADE METHODS |
| 826 |
|
| 827 |
=head2 C<set_upgrade_mode> |
| 828 |
|
| 829 |
$response = $es->ml->set_upgrade_mode(); |
| 830 |
|
| 831 |
The C<set_upgrade_mode()> method sets a cluster wide C<upgrade_mode> setting that prepares |
| 832 |
machine learning indices for an upgrade. |
| 833 |
|
| 834 |
See the L<set_upgrade_mode docs|https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html> |
| 835 |
for more information. |
| 836 |
|
| 837 |
Query string parameters: |
| 838 |
C<enabled>, |
| 839 |
C<error_trace>, |
| 840 |
C<human>, |
| 841 |
C<timeout> |
| 842 |
|
| 843 |
=head1 AUTHOR |
| 844 |
|
| 845 |
Enrico Zimuel <[email protected]> |
| 846 |
|
| 847 |
=head1 COPYRIGHT AND LICENSE |
| 848 |
|
| 849 |
This software is Copyright (c) 2024 by Elasticsearch BV. |
| 850 |
|
| 851 |
This is free software, licensed under: |
| 852 |
|
| 853 |
The Apache License, Version 2.0, January 2004 |
| 854 |
|
| 855 |
=cut |
| 856 |
|
| 857 |
__END__ |
| 858 |
|
| 859 |
# ABSTRACT: Plugin providing ML API for Search::Elasticsearch 8.x |
| 860 |
|