Skip to content

Commit 655d62b

Browse files
elasticmachineelasticmachine
authored
Auto-generated API code (#2690)
1 parent 7e7176f commit 655d62b

File tree

3 files changed

+60
-8
lines changed

3 files changed

+60
-8
lines changed

‎docs/reference.asciidoc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5153,7 +5153,7 @@ a new date field is added instead of string.
51535153
not used at all by Elasticsearch, but can be used to store
51545154
application-specific metadata.
51555155
** *`numeric_detection` (Optional, boolean)*: Automatically map strings into numeric data types for all fields.
5156-
** *`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, similarity, split_queries_on_whitespace, time_series_dimension, 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, similarity, 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, similarity, term_vector, type } | { type } | { type, null_value } | { 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, time_series_dimension, 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:
5156+
** *`properties` (Optional, Record<string, { type } | { boost, fielddata, index, null_value, ignore_malformed, script, on_script_error, time_series_dimension, 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, similarity, split_queries_on_whitespace, time_series_dimension, 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, similarity, 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, similarity, term_vector, type } | { type } | { type, null_value } | { 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, time_series_dimension, 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:
51575157

51585158
- Field name
51595159
- Field data type
@@ -7680,7 +7680,7 @@ specified.
76807680
** *`definition` (Optional, { preprocessors, trained_model })*: The inference definition for the model. If definition is specified, then
76817681
compressed_definition cannot be specified.
76827682
** *`description` (Optional, string)*: A human-readable description of the inference trained model.
7683-
** *`inference_config` (Optional, { regression, classification, text_classification, zero_shot_classification, fill_mask, ner, pass_through, text_embedding, text_expansion, question_answering })*: The default configuration for inference. This can be either a regression
7683+
** *`inference_config` (Optional, { regression, classification, text_classification, zero_shot_classification, fill_mask, learning_to_rank, ner, pass_through, text_embedding, text_expansion, question_answering })*: The default configuration for inference. This can be either a regression
76847684
or classification configuration. It must match the underlying
76857685
definition.trained_model's target_type. For pre-packaged models such as
76867686
ELSER the config is not required.

‎src/api/types.ts‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5284,6 +5284,10 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase {
52845284
fielddata?: IndicesNumericFielddata
52855285
index?: boolean
52865286
null_value?: boolean
5287+
ignore_malformed?: boolean
5288+
script?: Script | string
5289+
on_script_error?: MappingOnScriptError
5290+
time_series_dimension?: boolean
52875291
type: 'boolean'
52885292
}
52895293

@@ -10062,10 +10066,11 @@ export interface EnrichDeletePolicyRequest extends RequestBase {
1006210066

1006310067
export type EnrichDeletePolicyResponse = AcknowledgedResponseBase
1006410068

10065-
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED'
10069+
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCELLED'
1006610070

1006710071
export interface EnrichExecutePolicyExecuteEnrichPolicyStatus {
1006810072
phase: EnrichExecutePolicyEnrichPolicyPhase
10073+
step?: string
1006910074
}
1007010075

1007110076
export interface EnrichExecutePolicyRequest extends RequestBase {
@@ -10075,7 +10080,7 @@ export interface EnrichExecutePolicyRequest extends RequestBase {
1007510080

1007610081
export interface EnrichExecutePolicyResponse {
1007710082
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
10078-
task_id?: TaskId
10083+
task?: TaskId
1007910084
}
1008010085

1008110086
export interface EnrichGetPolicyRequest extends RequestBase {
@@ -12507,7 +12512,7 @@ export type InferenceDenseByteVector = byte[]
1250712512

1250812513
export type InferenceDenseVector = float[]
1250912514

12510-
export interface InferenceInferenceChunkingSettings extends InferenceInferenceEndpoint {
12515+
export interface InferenceInferenceChunkingSettings {
1251112516
max_chunk_size?: integer
1251212517
overlap?: integer
1251312518
sentence_overlap?: integer
@@ -14085,6 +14090,8 @@ export interface MlExponentialAverageCalculationContext {
1408514090
previous_exponential_average_ms?: DurationValue<UnitFloatMillis>
1408614091
}
1408714092

14093+
export type MlFeatureExtractor = MlQueryFeatureExtractor
14094+
1408814095
export interface MlFillMaskInferenceOptions {
1408914096
mask_token?: string
1409014097
num_top_classes?: integer
@@ -14150,6 +14157,7 @@ export interface MlInferenceConfigCreateContainer {
1415014157
text_classification?: MlTextClassificationInferenceOptions
1415114158
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
1415214159
fill_mask?: MlFillMaskInferenceOptions
14160+
learning_to_rank?: MlLearningToRankConfig
1415314161
ner?: MlNerInferenceOptions
1415414162
pass_through?: MlPassThroughInferenceOptions
1415514163
text_embedding?: MlTextEmbeddingInferenceOptions
@@ -14296,6 +14304,12 @@ export interface MlJobTimingStats {
1429614304
minimum_bucket_processing_time_ms?: DurationValue<UnitFloatMillis>
1429714305
}
1429814306

14307+
export interface MlLearningToRankConfig {
14308+
default_params?: Record<string, any>
14309+
feature_extractors?: Record<string, MlFeatureExtractor>[]
14310+
num_top_feature_importance_values: integer
14311+
}
14312+
1429914313
export type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit'
1430014314

1430114315
export interface MlModelPackageConfig {
@@ -14438,6 +14452,12 @@ export interface MlPerPartitionCategorization {
1443814452

1443914453
export type MlPredictedValue = ScalarValue | ScalarValue[]
1444014454

14455+
export interface MlQueryFeatureExtractor {
14456+
default_score?: float
14457+
feature_name: string
14458+
query: QueryDslQueryContainer
14459+
}
14460+
1444114461
export interface MlQuestionAnsweringInferenceOptions {
1444214462
num_top_classes?: integer
1444314463
tokenization?: MlTokenizationConfigContainer
@@ -14482,6 +14502,7 @@ export interface MlTextClassificationInferenceOptions {
1448214502
tokenization?: MlTokenizationConfigContainer
1448314503
results_field?: string
1448414504
classification_labels?: string[]
14505+
vocabulary?: MlVocabulary
1448514506
}
1448614507

1448714508
export interface MlTextClassificationInferenceUpdateOptions {
@@ -14524,6 +14545,7 @@ export interface MlTokenizationConfigContainer {
1452414545
bert_ja?: MlNlpBertTokenizationConfig
1452514546
mpnet?: MlNlpBertTokenizationConfig
1452614547
roberta?: MlNlpRobertaTokenizationConfig
14548+
xlm_roberta?: MlXlmRobertaTokenizationConfig
1452714549
}
1452814550

1452914551
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
@@ -14601,6 +14623,7 @@ export interface MlTrainedModelConfig {
1460114623
model_size_bytes?: ByteSize
1460214624
model_package?: MlModelPackageConfig
1460314625
location?: MlTrainedModelLocation
14626+
platform_architecture?: string
1460414627
prefix_strings?: MlTrainedModelPrefixStrings
1460514628
}
1460614629

@@ -14736,6 +14759,9 @@ export interface MlVocabulary {
1473614759
index: IndexName
1473714760
}
1473814761

14762+
export interface MlXlmRobertaTokenizationConfig extends MlCommonTokenizationConfig {
14763+
}
14764+
1473914765
export interface MlZeroShotClassificationInferenceOptions {
1474014766
tokenization?: MlTokenizationConfigContainer
1474114767
hypothesis_template?: string

‎src/api/typesWithBodyKey.ts‎

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5360,6 +5360,10 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase {
53605360
fielddata?: IndicesNumericFielddata
53615361
index?: boolean
53625362
null_value?: boolean
5363+
ignore_malformed?: boolean
5364+
script?: Script | string
5365+
on_script_error?: MappingOnScriptError
5366+
time_series_dimension?: boolean
53635367
type: 'boolean'
53645368
}
53655369

@@ -10214,10 +10218,11 @@ export interface EnrichDeletePolicyRequest extends RequestBase {
1021410218

1021510219
export type EnrichDeletePolicyResponse = AcknowledgedResponseBase
1021610220

10217-
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED'
10221+
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCELLED'
1021810222

1021910223
export interface EnrichExecutePolicyExecuteEnrichPolicyStatus {
1022010224
phase: EnrichExecutePolicyEnrichPolicyPhase
10225+
step?: string
1022110226
}
1022210227

1022310228
export interface EnrichExecutePolicyRequest extends RequestBase {
@@ -10227,7 +10232,7 @@ export interface EnrichExecutePolicyRequest extends RequestBase {
1022710232

1022810233
export interface EnrichExecutePolicyResponse {
1022910234
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
10230-
task_id?: TaskId
10235+
task?: TaskId
1023110236
}
1023210237

1023310238
export interface EnrichGetPolicyRequest extends RequestBase {
@@ -12731,7 +12736,7 @@ export type InferenceDenseByteVector = byte[]
1273112736

1273212737
export type InferenceDenseVector = float[]
1273312738

12734-
export interface InferenceInferenceChunkingSettings extends InferenceInferenceEndpoint {
12739+
export interface InferenceInferenceChunkingSettings {
1273512740
max_chunk_size?: integer
1273612741
overlap?: integer
1273712742
sentence_overlap?: integer
@@ -14327,6 +14332,8 @@ export interface MlExponentialAverageCalculationContext {
1432714332
previous_exponential_average_ms?: DurationValue<UnitFloatMillis>
1432814333
}
1432914334

14335+
export type MlFeatureExtractor = MlQueryFeatureExtractor
14336+
1433014337
export interface MlFillMaskInferenceOptions {
1433114338
mask_token?: string
1433214339
num_top_classes?: integer
@@ -14392,6 +14399,7 @@ export interface MlInferenceConfigCreateContainer {
1439214399
text_classification?: MlTextClassificationInferenceOptions
1439314400
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
1439414401
fill_mask?: MlFillMaskInferenceOptions
14402+
learning_to_rank?: MlLearningToRankConfig
1439514403
ner?: MlNerInferenceOptions
1439614404
pass_through?: MlPassThroughInferenceOptions
1439714405
text_embedding?: MlTextEmbeddingInferenceOptions
@@ -14538,6 +14546,12 @@ export interface MlJobTimingStats {
1453814546
minimum_bucket_processing_time_ms?: DurationValue<UnitFloatMillis>
1453914547
}
1454014548

14549+
export interface MlLearningToRankConfig {
14550+
default_params?: Record<string, any>
14551+
feature_extractors?: Record<string, MlFeatureExtractor>[]
14552+
num_top_feature_importance_values: integer
14553+
}
14554+
1454114555
export type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit'
1454214556

1454314557
export interface MlModelPackageConfig {
@@ -14680,6 +14694,12 @@ export interface MlPerPartitionCategorization {
1468014694

1468114695
export type MlPredictedValue = ScalarValue | ScalarValue[]
1468214696

14697+
export interface MlQueryFeatureExtractor {
14698+
default_score?: float
14699+
feature_name: string
14700+
query: QueryDslQueryContainer
14701+
}
14702+
1468314703
export interface MlQuestionAnsweringInferenceOptions {
1468414704
num_top_classes?: integer
1468514705
tokenization?: MlTokenizationConfigContainer
@@ -14724,6 +14744,7 @@ export interface MlTextClassificationInferenceOptions {
1472414744
tokenization?: MlTokenizationConfigContainer
1472514745
results_field?: string
1472614746
classification_labels?: string[]
14747+
vocabulary?: MlVocabulary
1472714748
}
1472814749

1472914750
export interface MlTextClassificationInferenceUpdateOptions {
@@ -14766,6 +14787,7 @@ export interface MlTokenizationConfigContainer {
1476614787
bert_ja?: MlNlpBertTokenizationConfig
1476714788
mpnet?: MlNlpBertTokenizationConfig
1476814789
roberta?: MlNlpRobertaTokenizationConfig
14790+
xlm_roberta?: MlXlmRobertaTokenizationConfig
1476914791
}
1477014792

1477114793
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
@@ -14843,6 +14865,7 @@ export interface MlTrainedModelConfig {
1484314865
model_size_bytes?: ByteSize
1484414866
model_package?: MlModelPackageConfig
1484514867
location?: MlTrainedModelLocation
14868+
platform_architecture?: string
1484614869
prefix_strings?: MlTrainedModelPrefixStrings
1484714870
}
1484814871

@@ -14978,6 +15001,9 @@ export interface MlVocabulary {
1497815001
index: IndexName
1497915002
}
1498015003

15004+
export interface MlXlmRobertaTokenizationConfig extends MlCommonTokenizationConfig {
15005+
}
15006+
1498115007
export interface MlZeroShotClassificationInferenceOptions {
1498215008
tokenization?: MlTokenizationConfigContainer
1498315009
hypothesis_template?: string

0 commit comments

Comments
 (0)