Skip to content

Commit 5a55849

Browse files
committed
[OpenAPI] Add x-model to some ML schemas
1 parent e7547bb commit 5a55849

File tree

1 file changed

+14
-62
lines changed

1 file changed

+14
-62
lines changed

docs/overlays/elasticsearch-shared-overlays.yaml

Lines changed: 14 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -286,76 +286,28 @@ actions:
286286
externalDocs:
287287
description: Templating a role query
288288
url: https://www.elastic.co/guide/en/elasticsearch/reference/master/field-and-document-access-control.html#templating-role-query
289-
# Abbreviate and annotate items that are not shown in Bump.sh due to depth limits
290-
- target: "$.components['schemas']['ml._types:Datafeed'].properties.query"
291-
description: Remove query object from anomaly detection datafeed
292-
remove: true
293-
- target: "$.components['schemas']['ml._types:Datafeed'].properties"
294-
description: Re-add a simplified query object in anomaly detection datafeed
289+
# Annotate items that are not shown in Bump.sh due to depth limits
290+
# These hopefully can be fixed by adding branch levels in Bump.sh since the info doesn't exist elsewhere
291+
- target: "$.components['schemas']['ml._types:TrainedModelConfigMetadata'].properties"
292+
description: Add x-model to trained_model_configs > metadata > total_feature_importance
295293
update:
296-
query:
294+
total_feature_importance:
297295
x-model: true
298-
type: object
299-
description: >
300-
The Elasticsearch query domain-specific language (DSL).
301-
This value corresponds to the query object in an Elasticsearch search POST body.
302-
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
303-
By default, this property has the following value: `{"match_all": {"boost": 1}}`.
304-
externalDocs:
305-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
306-
description: Query DSL
307-
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties.tokenizer"
308-
description: Remove tokenizer object from ML anomaly detection analysis config
309-
remove: true
310-
- target: "$.components['schemas']['ml._types:CategorizationAnalyzerDefinition'].properties"
311-
description: Re-add a simplified tokenizer object in anomaly detection analysis config
296+
- target: "$.components['schemas']['ml._types:Detector'].properties"
297+
description: Add x-model to anomaly detection job > analysis_config > detectors > custom_rules
312298
update:
313-
tokenizer:
299+
custom_rules:
314300
x-model: true
315-
oneOf:
316-
- type: object
317-
- type: string
318-
description: >
319-
The name or definition of the tokenizer to use after character filters are applied.
320-
This property is compulsory if `categorization_analyzer` is specified as an object.
321-
Machine learning provides a tokenizer called `ml_standard` that tokenizes in a way that has been determined to produce good categorization results on a variety of log file formats for logs in English.
322-
If you want to use that tokenizer but change the character or token filters, specify `"tokenizer": "ml_standard"` in your `categorization_analyzer`.
323-
Additionally, the `ml_classic` tokenizer is available, which tokenizes in the same way as the non-customizable tokenizer in old versions of the product (before 6.2).
324-
`ml_classic` was the default categorization tokenizer in versions 6.2 to 7.13, so if you need categorization identical to the default for jobs created in these versions, specify `"tokenizer": "ml_classic"` in your `categorization_analyzer`.
325-
externalDocs:
326-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-tokenizers.html
327-
description: Tokenizer reference
328-
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties.query"
329-
description: Remove query object from data frame analytics source
330-
remove: true
331-
- target: "$.components['schemas']['ml._types:DataframeAnalyticsSource'].properties"
332-
description: Re-add a simplified query object in data frame analytics source
301+
- target: "$.components['schemas']['ml._types:DetectorRead'].properties"
302+
description: Add x-model to anomaly detection jobs > analysis_config > detectors > custom_rules
333303
update:
334-
query:
304+
custom_rules:
335305
x-model: true
336-
type: object
337-
description: >
338-
The Elasticsearch query domain-specific language (DSL).
339-
This value corresponds to the query object in an Elasticsearch search POST body.
340-
All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.
341-
By default, this property has the following value: `{"match_all": {}}`.
342-
externalDocs:
343-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
344-
description: Query DSL
345-
- target: "$.components['schemas']['transform._types:Source'].properties.query"
346-
description: Remove query object from transform source
347-
remove: true
348-
- target: "$.components['schemas']['transform._types:Source'].properties"
349-
description: Re-add a simplified query object in transform source
306+
- target: "$.components['schemas']['ml.put_trained_model:TargetMeanEncodingPreprocessor'].properties"
307+
description: Add x-model to data frame analytics job > analysis> classification > feature_processors > target_mean_encoding > target_map
350308
update:
351-
query:
309+
target_map:
352310
x-model: true
353-
type: object
354-
description: >
355-
A query clause that retrieves a subset of data from the source index.
356-
externalDocs:
357-
url: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html
358-
description: Query DSL
359311
# Examples
360312
- target: "$.components['requestBodies']['async_search.submit']"
361313
description: "Add example for asynch search submit request"

0 commit comments

Comments
 (0)