@@ -27,7 +27,7 @@ Retrieves configuration information for a trained model.
2727[[ml-get-trained-models-prereq]]
2828== {api-prereq-title}
2929
30- Requires the `monitor_ml` cluster privilege. This privilege is included in the
30+ Requires the `monitor_ml` cluster privilege. This privilege is included in the
3131`machine_learning_user` built-in role.
3232
3333
@@ -71,9 +71,9 @@ default value is empty, indicating no optional fields are included. Valid
7171options are:
7272 - `definition`: Includes the model definition.
7373 - `feature_importance_baseline`: Includes the baseline for {feat-imp} values.
74- - `hyperparameters`: Includes the information about hyperparameters used to
75- train the model. This information consists of the value, the absolute and
76- relative importance of the hyperparameter as well as an indicator of whether
74+ - `hyperparameters`: Includes the information about hyperparameters used to
75+ train the model. This information consists of the value, the absolute and
76+ relative importance of the hyperparameter as well as an indicator of whether
7777 it was specified by the user or tuned during hyperparameter optimization.
7878 - `total_feature_importance`: Includes the total {feat-imp} for the training
7979 data set.
@@ -222,8 +222,8 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-ner]
222222[%collapsible%open]
223223======
224224`classification_labels`::::
225- (Optional, string)
226- An array of classification labels. NER supports only
225+ (Optional, string)
226+ An array of classification labels. NER supports only
227227Inside-Outside-Beginning labels (IOB) and only persons, organizations, locations,
228228and miscellaneous. For example:
229229`["O", "B-PER", "I-PER", "B-ORG", "I-ORG", "B-LOC", "I-LOC", "B-MISC", "I-MISC"]`.
@@ -338,7 +338,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-text-classific
338338[%collapsible%open]
339339======
340340`classification_labels`::::
341- (Optional, string)
341+ (Optional, string)
342342An array of classification labels.
343343
344344`num_top_classes`::::
@@ -414,6 +414,68 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenizati
414414(Optional, integer)
415415include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-max-sequence-length]
416416
417+ `with_special_tokens`::::
418+ (Optional, boolean)
419+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens]
420+ ========
421+ =======
422+ `vocabulary`::::
423+ (Optional, object)
424+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-vocabulary]
425+ +
426+ .Properties of vocabulary
427+ [%collapsible%open]
428+ =======
429+ `index`::::
430+ (Required, string)
431+ The index where the vocabulary is stored.
432+ =======
433+ ======
434+ `zero_shot_classification`::::
435+ (Object, optional)
436+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification]
437+ +
438+ .Properties of zero_shot_classification inference
439+ [%collapsible%open]
440+ ======
441+ `classification_labels`::::
442+ (Required, array)
443+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-classification-labels]
444+
445+ `hypothesis_template`::::
446+ (Optional, string)
447+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-hypothesis-template]
448+
449+ `labels`::::
450+ (Optional, array)
451+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-labels]
452+
453+ `multi_label`::::
454+ (Optional, boolean)
455+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-zero-shot-classification-multi-label]
456+
457+ `tokenization`::::
458+ (Optional, object)
459+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization]
460+ +
461+ .Properties of tokenization
462+ [%collapsible%open]
463+ =======
464+ `bert`::::
465+ (Optional, object)
466+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert]
467+ +
468+ .Properties of bert
469+ [%collapsible%open]
470+ ========
471+ `do_lower_case`::::
472+ (Optional, boolean)
473+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-do-lower-case]
474+
475+ `max_sequence_length`::::
476+ (Optional, integer)
477+ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-max-sequence-length]
478+
417479`with_special_tokens`::::
418480(Optional, boolean)
419481include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=inference-config-nlp-tokenization-bert-with-special-tokens]
@@ -456,7 +518,7 @@ provided.
456518=====
457519`index`:::
458520(Required, object)
459- Indicates that the model definition is stored in an index. It is required to be empty as
521+ Indicates that the model definition is stored in an index. It is required to be empty as
460522the index for storing model definitions is configured automatically.
461523=====
462524// End location
@@ -480,18 +542,18 @@ it is a single value. For {classanalysis}, there is a value for each class.
480542
481543`hyperparameters`:::
482544(array)
483- List of the available hyperparameters optimized during the
545+ List of the available hyperparameters optimized during the
484546`fine_parameter_tuning` phase as well as specified by the user.
485547+
486548.Properties of hyperparameters
487549[%collapsible%open]
488550======
489551`absolute_importance`::::
490552(double)
491- A positive number showing how much the parameter influences the variation of the
492- {ml-docs}/dfa-regression-lossfunction.html[loss function]. For
493- hyperparameters with values that are not specified by the user but tuned during
494- hyperparameter optimization.
553+ A positive number showing how much the parameter influences the variation of the
554+ {ml-docs}/dfa-regression-lossfunction.html[loss function]. For
555+ hyperparameters with values that are not specified by the user but tuned during
556+ hyperparameter optimization.
495557
496558`max_trees`::::
497559(integer)
@@ -503,14 +565,14 @@ Name of the hyperparameter.
503565
504566`relative_importance`::::
505567(double)
506- A number between 0 and 1 showing the proportion of influence on the variation of
507- the loss function among all tuned hyperparameters. For hyperparameters with
508- values that are not specified by the user but tuned during hyperparameter
568+ A number between 0 and 1 showing the proportion of influence on the variation of
569+ the loss function among all tuned hyperparameters. For hyperparameters with
570+ values that are not specified by the user but tuned during hyperparameter
509571optimization.
510572
511573`supplied`::::
512574(Boolean)
513- Indicates if the hyperparameter is specified by the user (`true`) or optimized
575+ Indicates if the hyperparameter is specified by the user (`true`) or optimized
514576(`false`).
515577
516578`value`::::
@@ -602,7 +664,7 @@ Identifier for the trained model.
602664`model_type`::
603665(Optional, string)
604666The created model type. By default the model type is `tree_ensemble`.
605- Appropriate types are:
667+ Appropriate types are:
606668+
607669--
608670* `tree_ensemble`: The model definition is an ensemble model of decision trees.
0 commit comments