Skip to content

Commit 1430e52

Browse files
authored
[DOCS] Adds model alias to inference processor and agg (#69576) (#69577)
1 parent 08a9589 commit 1430e52

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/reference/aggregations/pipeline/inference-bucket-aggregation.asciidoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ A parent pipeline aggregation which loads a pre-trained model and performs
1212
{infer} on the collated result fields from the parent bucket aggregation.
1313

1414
To use the {infer} bucket aggregation, you need to have the same security
15-
privileges that are required for using the <<get-trained-models>>.
15+
privileges that are required for using the <<get-trained-models,get trained models API>>.
1616

1717
[[inference-bucket-agg-syntax]]
1818
==== Syntax
@@ -37,7 +37,7 @@ A `inference` aggregation looks like this in isolation:
3737
}
3838
--------------------------------------------------
3939
// NOTCONSOLE
40-
<1> The ID of model to use.
40+
<1> The unique identifier or alias for the trained model.
4141
<2> The optional inference config which overrides the model's default settings
4242
<3> Map the value of `avg_agg` to the model's input field `avg_cost`
4343

@@ -47,7 +47,7 @@ A `inference` aggregation looks like this in isolation:
4747
[options="header"]
4848
|===
4949
|Parameter Name |Description |Required |Default Value
50-
| `model_id` | The ID of the model to load and infer against | Required | -
50+
| `model_id` | The ID or alias for the trained model. | Required | -
5151
| `inference_config` | Contains the inference type and its options. There are two types: <<inference-agg-regression-opt,`regression`>> and <<inference-agg-classification-opt,`classification`>> | Optional | -
5252
| `buckets_path` | Defines the paths to the input aggregations and maps the aggregation names to the field names expected by the model.
5353
See <<buckets-path-syntax>> for more details | Required | -
@@ -181,5 +181,5 @@ GET kibana_sample_data_logs/_search
181181

182182
<1> A composite bucket aggregation that aggregates the data by `client_ip`.
183183
<2> A series of metrics and bucket sub-aggregations.
184-
<3> {infer-cap} bucket aggregation that contains the model ID and maps the
184+
<3> {infer-cap} bucket aggregation that specifies the trained model and maps the
185185
aggregation names to the model's input fields.

docs/reference/ingest/processors/inference.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ ingested in the pipeline.
1717
[options="header"]
1818
|======
1919
| Name | Required | Default | Description
20-
| `model_id` | yes | - | (String) The ID of the model to load and infer against.
20+
| `model_id` | yes | - | (String) The ID or alias for the trained model.
2121
| `target_field` | no | `ml.inference.<processor_tag>` | (String) Field added to incoming documents to contain results objects.
2222
| `field_map` | no | If defined the model's default field map | (Object) Maps the document field names to the known field names of the model. This mapping takes precedence over any default mappings provided in the model configuration.
2323
| `inference_config` | no | The default settings defined in the model | (Object) Contains the inference type and its options. There are two types: <<inference-processor-regression-opt,`regression`>> and <<inference-processor-classification-opt,`classification`>>.

0 commit comments

Comments
 (0)