Skip to content

Commit 98d69d9

Browse files
chore: Auto-generated code for main (#72)
Auto-generated API code
1 parent af63257 commit 98d69d9

File tree

3 files changed

+44
-18
lines changed

3 files changed

+44
-18
lines changed

docs/reference.asciidoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2572,7 +2572,7 @@ a new date field is added instead of string.
25722572
not used at all by Elasticsearch, but can be used to store
25732573
application-specific metadata.
25742574
** *`numeric_detection` (Optional, boolean)*: Automatically map strings into numeric data types for all fields.
2575-
** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, script, on_script_error, normalizer, norms, null_value, split_queries_on_whitespace, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { positive_score_impact, type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, element_type, dims, similarity, index, index_options } | { type } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, subobjects, type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, index, on_script_error, script, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type } | { type, norms, index_options, index, null_value, rules, language, country, variant, strength, decomposition, alternate, case_level, case_first, numeric, variable_top, hiragana_quaternary_mode }>)*: Mapping for a field. For new fields, this mapping can include:
2575+
** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, type } | { type, enabled, null_value, boost, coerce, script, on_script_error, ignore_malformed, time_series_metric, analyzer, eager_global_ordinals, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, format, precision_step, locale } | { relations, eager_global_ordinals, type } | { boost, eager_global_ordinals, index, index_options, script, on_script_error, normalizer, norms, null_value, split_queries_on_whitespace, type } | { type, fields, meta, copy_to } | { type } | { positive_score_impact, type } | { positive_score_impact, type } | { analyzer, index, index_options, max_shingle_size, norms, search_analyzer, search_quote_analyzer, term_vector, type } | { analyzer, boost, eager_global_ordinals, fielddata, fielddata_frequency_filter, index, index_options, index_phrases, index_prefixes, norms, position_increment_gap, search_analyzer, search_quote_analyzer, term_vector, type } | { type } | { type } | { boost, format, ignore_malformed, index, null_value, precision_step, type } | { boost, fielddata, format, ignore_malformed, index, null_value, precision_step, locale, type } | { type, default_metric, metrics, time_series_metric } | { type, element_type, dims, similarity, index, index_options } | { boost, depth_limit, doc_values, eager_global_ordinals, index, index_options, null_value, similarity, split_queries_on_whitespace, type } | { enabled, include_in_parent, include_in_root, type } | { enabled, subobjects, type } | { type, meta, inference_id } | { type } | { analyzer, contexts, max_input_length, preserve_position_increments, preserve_separators, search_analyzer, type } | { value, type } | { path, type } | { ignore_malformed, type } | { boost, index, ignore_malformed, null_value, on_script_error, script, type } | { type } | { analyzer, boost, index, null_value, enable_position_increments, type } | { ignore_malformed, ignore_z_value, null_value, index, on_script_error, script, type } | { coerce, ignore_malformed, ignore_z_value, orientation, strategy, type } | { ignore_malformed, ignore_z_value, null_value, type } | { coerce, ignore_malformed, ignore_z_value, orientation, type } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value } | { type, null_value, scaling_factor } | { type, null_value } | { type, null_value } | { format, type } | { type } | { type } | { type } | { type } | { type } | { type, norms, index_options, index, null_value, rules, language, country, variant, strength, decomposition, alternate, case_level, case_first, numeric, variable_top, hiragana_quaternary_mode }>)*: Mapping for a field. For new fields, this mapping can include:
25762576

25772577
- Field name
25782578
- Field data type
@@ -3651,7 +3651,11 @@ client.ml.getTrainedModels({ ... })
36513651
==== Arguments
36523652

36533653
* *Request (object):*
3654-
** *`model_id` (Optional, string)*: The unique identifier of the trained model.
3654+
** *`model_id` (Optional, string | string[])*: The unique identifier of the trained model or a model alias.
3655+
3656+
You can get information for multiple trained models in a single API
3657+
request by using a list of model IDs or a wildcard
3658+
expression.
36553659
** *`allow_no_match` (Optional, boolean)*: Specifies what to do when the request:
36563660

36573661
- Contains wildcard expressions and there are no models that match.
@@ -3669,7 +3673,7 @@ be retrieved and then added to another cluster.
36693673
** *`include` (Optional, Enum("definition" | "feature_importance_baseline" | "hyperparameters" | "total_feature_importance" | "definition_status"))*: A comma delimited string of optional fields to include in the response
36703674
body.
36713675
** *`size` (Optional, number)*: Specifies the maximum number of models to obtain.
3672-
** *`tags` (Optional, string)*: A comma delimited string of tags. A trained model can have many tags, or
3676+
** *`tags` (Optional, string | string[])*: A comma delimited string of tags. A trained model can have many tags, or
36733677
none. When supplied, only trained models that contain all the supplied
36743678
tags are returned.
36753679

@@ -3833,7 +3837,7 @@ client.ml.putCalendarJob({ calendar_id, job_id })
38333837

38343838
* *Request (object):*
38353839
** *`calendar_id` (string)*: A string that uniquely identifies a calendar.
3836-
** *`job_id` (string)*: An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a list of jobs or groups.
3840+
** *`job_id` (string | string[])*: An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a list of jobs or groups.
38373841

38383842
[discrete]
38393843
==== put_data_frame_analytics

src/api/types.ts

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4990,7 +4990,7 @@ export interface MappingFieldNamesField {
49904990
enabled: boolean
49914991
}
49924992

4993-
export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'version' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'sparse_vector' | 'match_only_text' | 'icu_collation_keyword'
4993+
export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'version' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'semantic_text' | 'sparse_vector' | 'match_only_text' | 'icu_collation_keyword'
49944994

49954995
export interface MappingFlattenedProperty extends MappingPropertyBase {
49964996
boost?: double
@@ -5173,7 +5173,7 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase {
51735173
type: 'point'
51745174
}
51755175

5176-
export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingSparseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty | MappingIcuCollationProperty
5176+
export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingSemanticTextProperty | MappingSparseVectorProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty | MappingIcuCollationProperty
51775177

51785178
export interface MappingPropertyBase {
51795179
meta?: Record<string, string>
@@ -5240,6 +5240,12 @@ export interface MappingSearchAsYouTypeProperty extends MappingCorePropertyBase
52405240
type: 'search_as_you_type'
52415241
}
52425242

5243+
export interface MappingSemanticTextProperty {
5244+
type: 'semantic_text'
5245+
meta?: Record<string, string>
5246+
inference_id: Id
5247+
}
5248+
52435249
export interface MappingShapeProperty extends MappingDocValuesPropertyBase {
52445250
coerce?: boolean
52455251
ignore_malformed?: boolean
@@ -5960,6 +5966,11 @@ export interface QueryDslScriptScoreQuery extends QueryDslQueryBase {
59605966
script: Script
59615967
}
59625968

5969+
export interface QueryDslSemanticQuery extends QueryDslQueryBase {
5970+
field: string
5971+
query: string
5972+
}
5973+
59635974
export interface QueryDslShapeFieldQuery {
59645975
indexed_shape?: QueryDslFieldLookup
59655976
relation?: GeoShapeRelation
@@ -12820,8 +12831,8 @@ export interface MlDatafeedConfig {
1282012831
datafeed_id?: Id
1282112832
delayed_data_check_config?: MlDelayedDataCheckConfig
1282212833
frequency?: Duration
12823-
indices?: string[]
12824-
indexes?: string[]
12834+
indices?: Indices
12835+
indexes?: Indices
1282512836
indices_options?: IndicesOptions
1282612837
job_id?: Id
1282712838
max_empty_searches?: integer
@@ -14318,14 +14329,14 @@ export interface MlGetRecordsResponse {
1431814329
}
1431914330

1432014331
export interface MlGetTrainedModelsRequest extends RequestBase {
14321-
model_id?: Id
14332+
model_id?: Ids
1432214333
allow_no_match?: boolean
1432314334
decompress_definition?: boolean
1432414335
exclude_generated?: boolean
1432514336
from?: integer
1432614337
include?: MlInclude
1432714338
size?: integer
14328-
tags?: string
14339+
tags?: string | string[]
1432914340
}
1433014341

1433114342
export interface MlGetTrainedModelsResponse {
@@ -14479,7 +14490,7 @@ export interface MlPutCalendarResponse {
1447914490

1448014491
export interface MlPutCalendarJobRequest extends RequestBase {
1448114492
calendar_id: Id
14482-
job_id: Id
14493+
job_id: Ids
1448314494
}
1448414495

1448514496
export interface MlPutCalendarJobResponse {

src/api/typesWithBodyKey.ts

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5063,7 +5063,7 @@ export interface MappingFieldNamesField {
50635063
enabled: boolean
50645064
}
50655065

5066-
export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'version' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'sparse_vector' | 'match_only_text' | 'icu_collation_keyword'
5066+
export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | 'version' | 'murmur3' | 'token_count' | 'percolator' | 'integer' | 'long' | 'short' | 'byte' | 'float' | 'half_float' | 'scaled_float' | 'double' | 'integer_range' | 'float_range' | 'long_range' | 'double_range' | 'date_range' | 'ip_range' | 'alias' | 'join' | 'rank_feature' | 'rank_features' | 'flattened' | 'shape' | 'histogram' | 'constant_keyword' | 'aggregate_metric_double' | 'dense_vector' | 'semantic_text' | 'sparse_vector' | 'match_only_text' | 'icu_collation_keyword'
50675067

50685068
export interface MappingFlattenedProperty extends MappingPropertyBase {
50695069
boost?: double
@@ -5246,7 +5246,7 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase {
52465246
type: 'point'
52475247
}
52485248

5249-
export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingSparseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty | MappingIcuCollationProperty
5249+
export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | MappingFlattenedProperty | MappingNestedProperty | MappingObjectProperty | MappingSemanticTextProperty | MappingSparseVectorProperty | MappingCompletionProperty | MappingConstantKeywordProperty | MappingFieldAliasProperty | MappingHistogramProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingTokenCountProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingPointProperty | MappingShapeProperty | MappingByteNumberProperty | MappingDoubleNumberProperty | MappingFloatNumberProperty | MappingHalfFloatNumberProperty | MappingIntegerNumberProperty | MappingLongNumberProperty | MappingScaledFloatNumberProperty | MappingShortNumberProperty | MappingUnsignedLongNumberProperty | MappingDateRangeProperty | MappingDoubleRangeProperty | MappingFloatRangeProperty | MappingIntegerRangeProperty | MappingIpRangeProperty | MappingLongRangeProperty | MappingIcuCollationProperty
52505250

52515251
export interface MappingPropertyBase {
52525252
meta?: Record<string, string>
@@ -5313,6 +5313,12 @@ export interface MappingSearchAsYouTypeProperty extends MappingCorePropertyBase
53135313
type: 'search_as_you_type'
53145314
}
53155315

5316+
export interface MappingSemanticTextProperty {
5317+
type: 'semantic_text'
5318+
meta?: Record<string, string>
5319+
inference_id: Id
5320+
}
5321+
53165322
export interface MappingShapeProperty extends MappingDocValuesPropertyBase {
53175323
coerce?: boolean
53185324
ignore_malformed?: boolean
@@ -6033,6 +6039,11 @@ export interface QueryDslScriptScoreQuery extends QueryDslQueryBase {
60336039
script: Script
60346040
}
60356041

6042+
export interface QueryDslSemanticQuery extends QueryDslQueryBase {
6043+
field: string
6044+
query: string
6045+
}
6046+
60366047
export interface QueryDslShapeFieldQuery {
60376048
indexed_shape?: QueryDslFieldLookup
60386049
relation?: GeoShapeRelation
@@ -13055,8 +13066,8 @@ export interface MlDatafeedConfig {
1305513066
datafeed_id?: Id
1305613067
delayed_data_check_config?: MlDelayedDataCheckConfig
1305713068
frequency?: Duration
13058-
indices?: string[]
13059-
indexes?: string[]
13069+
indices?: Indices
13070+
indexes?: Indices
1306013071
indices_options?: IndicesOptions
1306113072
job_id?: Id
1306213073
max_empty_searches?: integer
@@ -14595,14 +14606,14 @@ export interface MlGetRecordsResponse {
1459514606
}
1459614607

1459714608
export interface MlGetTrainedModelsRequest extends RequestBase {
14598-
model_id?: Id
14609+
model_id?: Ids
1459914610
allow_no_match?: boolean
1460014611
decompress_definition?: boolean
1460114612
exclude_generated?: boolean
1460214613
from?: integer
1460314614
include?: MlInclude
1460414615
size?: integer
14605-
tags?: string
14616+
tags?: string | string[]
1460614617
}
1460714618

1460814619
export interface MlGetTrainedModelsResponse {
@@ -14775,7 +14786,7 @@ export interface MlPutCalendarResponse {
1477514786

1477614787
export interface MlPutCalendarJobRequest extends RequestBase {
1477714788
calendar_id: Id
14778-
job_id: Id
14789+
job_id: Ids
1477914790
}
1478014791

1478114792
export interface MlPutCalendarJobResponse {

0 commit comments

Comments
 (0)