Commit graph

610 commits

Author SHA1 Message Date
David Kyle
547a567c13
[DOCS][ML] Document the text_expansion task type (#119581) 2025-01-09 15:44:01 +00:00
James Baiera
c3839e1f76
Add selector syntax to index expressions (#118614)
This PR introduces a new syntactical feature to index expression resolution: The selector.

Selectors, denoted with a :: followed by a recognized suffix will allow users to specify which component of 
an index abstraction they would like to operate on within an API call. In this case, an index abstraction is a 
concrete index, data stream, or alias; Any abstraction that can be resolved to a set of indices/shards. We 
define a component of an index abstraction to be some searchable unit of the index abstraction.
2025-01-08 11:37:03 -05:00
Lisa Cawley
ba8beecdb0
[DOCS] More links to new API site (#119377) 2024-12-31 11:32:29 -08:00
Pius Fung
1054503ba8
Update start-trained-model-deployment.asciidoc (#118887)
Updating with changes in https://github.com/elastic/elasticsearch/pull/115041
2024-12-17 13:03:28 -08:00
kosabogi
ba1d5be199
Updates minimum_number_of_allocations description (#117746) 2024-12-04 14:22:26 +01:00
kosabogi
79d70686b3
Fixes typo (#117684) 2024-11-28 09:26:16 +01:00
Craig Taverner
c9c1765986
Remove duplicate 'the the' (#116023)
There were many places where `the the` was typed, in comments, docs and messages. All were incorrect and replaces with a single `the`
2024-10-31 19:14:58 +01:00
István Zoltán Szabó
f95d3f8d43
[DOCS] Updates adaptive allocations reference docs. (#114986) 2024-10-17 12:58:52 +02:00
Stef Nestor
612ce0f996
(Doc+) Link API doc to parent object - part2 (#113541)
* (Doc+) Cross-link CAT APIs to parent object

---------

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
2024-10-09 14:21:56 -06:00
István Zoltán Szabó
40bddafd92
[DOCS] Adds DeBERTa v2 tokenization params to infer trained model API docs (#114242)
* [DOCS] Adds DeBERTa v2 tokenization params to infer trained model API docs.

* [DOCS] Mode edits.
2024-10-08 08:41:11 +02:00
István Zoltán Szabó
57955cb8d4
[DOCS] Adds DeBERTA v2 to the tokenizers list in API docs (#112752)
Co-authored-by: Max Hniebergall <137079448+maxhniebergall@users.noreply.github.com>
2024-10-07 10:23:46 +02:00
Valeriy Khakhutskyy
7b7dd91f62
[ML] Add documentation for post calendar events API (#113188)
This PR updates the documentation for the extension of the POST calendar events API implemented in #112837.
2024-09-24 09:46:42 +02:00
István Zoltán Szabó
e54f46e4eb
[DOCS] Fixes indentation issue on PUT trained models docs page. (#112538) 2024-09-05 10:46:41 +02:00
Simon Cooper
a36d90cf34
Use CLDR locale provider on JDK 23+ (#110222)
JDK 23 removes the COMPAT locale provider, leaving CLDR as the only option. This commit configures Elasticsearch
to use the CLDR provider when on JDK 23, but still use the existing COMPAT provider when on JDK 22 and below.

This causes some differences in locale behaviour; this also adapts various tests to still work whether run on COMPAT or CLDR.
2024-09-04 13:42:40 +01:00
Valeriy Khakhutskyy
5a7a032cea
[ML] Force time shift documentation (#111668)
Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2024-08-09 11:12:46 +02:00
István Zoltán Szabó
d6c532135e
[DOCS] Adds adaptive_allocations to inference and trained model API docs (#111476) 2024-08-01 12:37:07 +02:00
Valeriy Khakhutskyy
87d9a0b268
[ML] Extend lat_long documentation (#111239)
This PR adds the explanation of what "typical" means for the lat_long function.
2024-07-25 10:32:36 +02:00
Ed Savage
c214457b39
[ML] Handle the "output memory allocator bytes" field (#109653)
Handle the "output memory allocator bytes" field if and only if it is present in the model size stats, as reported by the C++ backend.

This PR _must_ be merged prior to the corresponding `ml-cpp` one, to keep CI tests happy.
2024-06-18 15:25:05 +12:00
David Kyle
d38d1af242
[ML] GA the update trained model action (#108868)
Accidentally missed when the other trained model APIs went GA
2024-05-22 13:30:25 +01:00
Max Hniebergall
a2008bd190
[ML] Add option to disable inference process cache by default (#108784)
* Add option to disable inference process cache by default

* Add test

* improve tests

* Update docs and improve code

---------

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
2024-05-19 11:11:02 -04:00
Lisa Cawley
a079cdc17d
[DOCS] Update transform and anomaly detection rule creation steps (#107975) 2024-05-07 07:52:45 -07:00
Liam Thompson
33a71e3289
[DOCS] Refactor book-scoped variables in docs/reference/index.asciidoc (#107413)
* Remove `es-test-dir` book-scoped variable

* Remove `plugins-examples-dir` book-scoped variable

* Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables

- In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed.
- In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path
- In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem

* Replace `es-repo-dir` with `es-ref-dir`

* Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
2024-04-17 14:37:07 +02:00
Niels Bauman
0f3ac367ac
Rename values of FailureStoreOptions (#107062)
With these new values, there's a better match between selecting failure stores in read and write operations.
2024-04-06 08:46:38 +02:00
David Kyle
50dcfdc726
[ML] Document wait_for_completion parameter to PUT trained models (#106769) 2024-03-27 16:55:06 +00:00
István Zoltán Szabó
de7e8980d1
[DOCS] Amends important note on delayed data detection. (#106610) 2024-03-21 16:41:31 +01:00
István Zoltán Szabó
5d7549c2c8
[DOCS] Documents scripted metric aggregation limitation in datafeeds (#106059) 2024-03-07 14:07:14 +01:00
Mary Gouseti
6fbf9892aa
Add the parameter failure_store to multi-target syntax APIs (#105386)
In this PR we introduce a new query parameter behind the failure store feature flag. The query param, `faliure_store` allows the multi-syntax supporting APIs to choose the failure store indices as well. If an API should not support failure store, the `allowFailureStore` flag should be `false`.
2024-03-06 14:04:18 +02:00
Lisa Cawley
1cfa86ee13
[DOCS] Update anomaly detection jobs health rule details (#105716) 2024-02-22 08:26:31 -08:00
István Zoltán Szabó
cfa2b2a2e2
[DOCS] Rephrases sentence in data_description param of PUT job API docs (#104792)
* [DOCS] Rephrase sentence in data_description param of PUT job API docs.

* [DOCS] Further edits.
2024-01-26 14:27:02 +01:00
David Roberts
35aff34912
[ML] Add an important note about a gotcha with the delayed data check (#104725)
Recently a user saw spurious delayed data warnings. These turned
out to be due to accidentally setting `summary_count_field` to a
field that was always zero. This meant that every document was
considered delayed.
2024-01-25 14:31:24 +00:00
István Zoltán Szabó
e48b549588
[DOCS] Fixes asciidoc syntax in PUT trained models API docs. (#104741) 2024-01-25 14:22:17 +01:00
István Zoltán Szabó
56be53adac
[DOCS] Fixes link in PUT datafeeds API docs. (#102684) 2023-11-28 10:47:24 +01:00
István Zoltán Szabó
cb5a702174
[DOCS] Expands anomaly alerts docs with info on Anomaly Explorer integration. (#102477) 2023-11-23 14:33:06 +01:00
David Kyle
330e8b99bf
[ML] Add prefix strings option to trained models (#102089)
Certain NLP models such as multilingual-e5-large require a prefix 
string to be applied to the input text. For asymmetric tasks such as 
information retrieval the prefix can be different when ingesting the
data and when searching it. For example text embedding model can
have a one prefix applied when the model is evaluated as part of an
knn search and a different prefix when ingesting documents.
2023-11-14 13:02:02 +00:00
István Zoltán Szabó
481ebd2e21
[DOCS] Improves readability of PUT trained models API docs page (#101880)
* [DOCS] Improves readability of PUT trained models API docs page.

* [DOCS] Fixes URLs.
2023-11-08 17:57:57 +01:00
Abdon Pijpelink
70128f5b74
[DOCS] Mark 'ignore_throttled' deprecated in all docs (#101838) 2023-11-07 13:03:49 +01:00
David Roberts
9286716660
[ML] Include ML processor limits in _ml/info response (#101392)
The _ml/info response now includes two extra fields in its
`limits`:

1. `max_single_ml_node_processors`
2. `total_ml_processors`

These fields are _only_ included if they can be accurately
calculated. If autoscaling is enabled and the ML nodes are
not at their maximum size then these fields _cannot_
currently be accurately calculated. (This could potentially
be improved in the future with additional settings set by
the control plane.)
2023-10-27 13:52:03 +01:00
István Zoltán Szabó
c34e0c0746
[DOCS] Clarifies that inference input must be single string (#101301) 2023-10-25 17:18:05 +02:00
Lisa Cawley
3418c6a2af
[DOCS] Alerts-as-data for anomaly detection rules (#100864) 2023-10-17 07:37:22 -07:00
Max Hniebergall
7c21ce3f1b
Platform specific models (#99584)
* Added platform architecture field to TrainedModelMetadata and users of TrainedModelMetadata

* Added TransportVersions guarding for TrainedModelMetadata

* Prevent platform-specific models from being deployed on the wrong architecture

* Added logic to only verify node architectures for models which are platform specific

* Handle null platform architecture

* Added logging for the detection of heterogeneous platform architectures among ML nodes and refactoring to support this

* Added platform architecture field to TrainedModelConfig

* Stop platform-speficic model when rebalance occurs and the cluster has a heterogeneous architecture among ML nodes

* Added logic to TransportPutTrainedModelAction to return a warning response header when the model is paltform-specific and cannot be depoloyed on the cluster at that time due to heterogenous architectures among ML nodes

* Added MlPlatformArchitecturesUtilTests

* Updated Create Trained Models API docs to describe the new platform_architecture optional field.

* Updated/incremented InferenceIndexConstants

* Added special override to make  models with linux-x86_64 in the model ID to be platform specific
2023-09-28 13:56:45 -04:00
DeDe Morton
e3f1c15788
Update ml-delayed-data-detection.asciidoc (#99843) 2023-09-26 11:18:24 +02:00
James Rodewig
255c9a7f95
[DOCS] Move x-pack docs to docs/reference dir (#99209)
**Problem:**
For historical reasons, source files for the Elasticsearch Guide's security, watcher, and Logstash API docs are housed in the `x-pack/docs` directory. This can confuse new contributors who expect Elasticsearch Guide docs to be located in `docs/reference`. 

**Solution:**
- Move the security, watcher, and Logstash API doc source files to the `docs/reference` directory
- Update doc snippet tests to use security

Rel: https://github.com/elastic/platform-docs-team/issues/208
2023-09-12 14:53:41 -04:00
Jonathan Buttner
1ca66bde91
[ML] Safely drain deployment request queues before allowing node to shutdown (#98406)
* isSafeToShutdown checks routing table

* Rebalancer changes and tests

* Update docs/changelog/98406.yaml

* Forcing lifecycle tests to avoid over time case

* Changes and remaining tests

* Adding node service changes

* Finishing unit tests

* Adding wait for completion paramater

* Adding stop deployment integration tests

* Cleaning up code

* Fixing stop deployment test

* Fixing string formatter issue and timeout

* Investigating deadlock

* More testing

* More logging

* Prevent model reloading while stopping

* Fixing compile error

* More code clean up

* Adding test for loading model after stopping

* Addressing review feedback

* Fixing a couple shutdown -> shutdownNow tests

* Adding doc changes and refactoring
2023-08-31 15:37:11 -04:00
István Zoltán Szabó
947128e76d
[DOCS] Fixes NOTE display error. (#98783) 2023-08-23 12:18:54 +02:00
Ed Savage
3682a88199
[ML] Update documentation regarding versioning. (#98320)
Update the ml and transform reference documentation to provide information regarding the new versioning schemes independent from the product versions.

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2023-08-10 11:20:58 +01:00
István Zoltán Szabó
3fd94678e6
[DOCS] Adds important admonition to handling delayed data page (#97753) 2023-07-19 13:32:06 +02:00
David Roberts
e810d7b77b
[ML] inference_config is optional for the infer trained model API (#97464)
It was made optional in #92359 which was released in version 8.6.1,
but the docs weren't updated to reflect this.
2023-07-12 08:35:06 +01:00
Max Hniebergall
3a4113801c
[NLP] Support the different mask tokens used by NLP models for Fill Mask (#97453)
Add mask_token field to fill_mask of _ml/trained_models.

This change will enable users and Kibana to get the particular mask tokens needed for deployed models by adding a mask_token field to the GET _ml/trained_models API, as an enhancement to support kibana#159577.
2023-07-11 14:42:44 -04:00
István Zoltán Szabó
8d5b803bff
[DOCS] Adds API docs for bert_ja text embedding tokenizer option (#96873) 2023-06-26 11:36:08 +02:00
Benjamin Trent
14ca8fee20
[ML] add support for xlm_roberta tokenized models (#94089)
Many multi-lingual and newer models use a tokenization scheme similar to
sentence-piece. This PR adds support for one of those tokenization
schemes, XLMRoBERTa. 

The main changes are:  - Support for xlm_roberta tokenization
configuration  - Adding `scores` to the vocabulary document stored,
requiring that scores be the same size as the vocabulary  - Adding a new
flat text file to resources that is the spm char normalizer.
2023-06-13 08:40:55 -04:00