habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Auto-generated API code (#2690)

Browse Source
This commit is contained in:
Elastic Machine
2025-03-31 17:17:29 +01:00
committed by GitHub
parent 7e7176fbf9
commit 655d62b7b5
3 changed files with 60 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference.asciidoc
View File

@ -5153,7 +5153,7 @@ a new date field is added instead of string.
not used at all by Elasticsearch, but can be used to store
application-specific metadata.
** *`numeric_detection` (Optional, boolean)*: Automatically map strings into numeric data types for all fields.
** *`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:
** *`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:
- Field name
- Field data type
@ -7680,7 +7680,7 @@ specified.
** *`definition` (Optional, { preprocessors, trained_model })*: The inference definition for the model. If definition is specified, then
compressed_definition cannot be specified.
** *`description` (Optional, string)*: A human-readable description of the inference trained model.
** *`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
** *`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
or classification configuration. It must match the underlying
definition.trained_model's target_type. For pre-packaged models such as
ELSER the config is not required.

32
src/api/types.ts
View File

@ -5284,6 +5284,10 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase {
fielddata?: IndicesNumericFielddata
index?: boolean
null_value?: boolean
ignore_malformed?: boolean
script?: Script | string
on_script_error?: MappingOnScriptError
time_series_dimension?: boolean
type: 'boolean'
}
@ -10062,10 +10066,11 @@ export interface EnrichDeletePolicyRequest extends RequestBase {
export type EnrichDeletePolicyResponse = AcknowledgedResponseBase
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED'
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCELLED'
export interface EnrichExecutePolicyExecuteEnrichPolicyStatus {
phase: EnrichExecutePolicyEnrichPolicyPhase
step?: string
}
export interface EnrichExecutePolicyRequest extends RequestBase {
@ -10075,7 +10080,7 @@ export interface EnrichExecutePolicyRequest extends RequestBase {
export interface EnrichExecutePolicyResponse {
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
task_id?: TaskId
task?: TaskId
}
export interface EnrichGetPolicyRequest extends RequestBase {
@ -12507,7 +12512,7 @@ export type InferenceDenseByteVector = byte[]
export type InferenceDenseVector = float[]
export interface InferenceInferenceChunkingSettings extends InferenceInferenceEndpoint {
export interface InferenceInferenceChunkingSettings {
max_chunk_size?: integer
overlap?: integer
sentence_overlap?: integer
@ -14085,6 +14090,8 @@ export interface MlExponentialAverageCalculationContext {
previous_exponential_average_ms?: DurationValue<UnitFloatMillis>
}
export type MlFeatureExtractor = MlQueryFeatureExtractor
export interface MlFillMaskInferenceOptions {
mask_token?: string
num_top_classes?: integer
@ -14150,6 +14157,7 @@ export interface MlInferenceConfigCreateContainer {
text_classification?: MlTextClassificationInferenceOptions
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
fill_mask?: MlFillMaskInferenceOptions
learning_to_rank?: MlLearningToRankConfig
ner?: MlNerInferenceOptions
pass_through?: MlPassThroughInferenceOptions
text_embedding?: MlTextEmbeddingInferenceOptions
@ -14296,6 +14304,12 @@ export interface MlJobTimingStats {
minimum_bucket_processing_time_ms?: DurationValue<UnitFloatMillis>
}
export interface MlLearningToRankConfig {
default_params?: Record<string, any>
feature_extractors?: Record<string, MlFeatureExtractor>[]
num_top_feature_importance_values: integer
}
export type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit'
export interface MlModelPackageConfig {
@ -14438,6 +14452,12 @@ export interface MlPerPartitionCategorization {
export type MlPredictedValue = ScalarValue | ScalarValue[]
export interface MlQueryFeatureExtractor {
default_score?: float
feature_name: string
query: QueryDslQueryContainer
}
export interface MlQuestionAnsweringInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
@ -14482,6 +14502,7 @@ export interface MlTextClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
vocabulary?: MlVocabulary
}
export interface MlTextClassificationInferenceUpdateOptions {
@ -14524,6 +14545,7 @@ export interface MlTokenizationConfigContainer {
bert_ja?: MlNlpBertTokenizationConfig
mpnet?: MlNlpBertTokenizationConfig
roberta?: MlNlpRobertaTokenizationConfig
xlm_roberta?: MlXlmRobertaTokenizationConfig
}
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
@ -14601,6 +14623,7 @@ export interface MlTrainedModelConfig {
model_size_bytes?: ByteSize
model_package?: MlModelPackageConfig
location?: MlTrainedModelLocation
platform_architecture?: string
prefix_strings?: MlTrainedModelPrefixStrings
}
@ -14736,6 +14759,9 @@ export interface MlVocabulary {
index: IndexName
}
export interface MlXlmRobertaTokenizationConfig extends MlCommonTokenizationConfig {
}
export interface MlZeroShotClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
hypothesis_template?: string

32
src/api/typesWithBodyKey.ts
View File

@ -5360,6 +5360,10 @@ export interface MappingBooleanProperty extends MappingDocValuesPropertyBase {
fielddata?: IndicesNumericFielddata
index?: boolean
null_value?: boolean
ignore_malformed?: boolean
script?: Script | string
on_script_error?: MappingOnScriptError
time_series_dimension?: boolean
type: 'boolean'
}
@ -10214,10 +10218,11 @@ export interface EnrichDeletePolicyRequest extends RequestBase {
export type EnrichDeletePolicyResponse = AcknowledgedResponseBase
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED'
export type EnrichExecutePolicyEnrichPolicyPhase = 'SCHEDULED' | 'RUNNING' | 'COMPLETE' | 'FAILED' | 'CANCELLED'
export interface EnrichExecutePolicyExecuteEnrichPolicyStatus {
phase: EnrichExecutePolicyEnrichPolicyPhase
step?: string
}
export interface EnrichExecutePolicyRequest extends RequestBase {
@ -10227,7 +10232,7 @@ export interface EnrichExecutePolicyRequest extends RequestBase {
export interface EnrichExecutePolicyResponse {
status?: EnrichExecutePolicyExecuteEnrichPolicyStatus
task_id?: TaskId
task?: TaskId
}
export interface EnrichGetPolicyRequest extends RequestBase {
@ -12731,7 +12736,7 @@ export type InferenceDenseByteVector = byte[]
export type InferenceDenseVector = float[]
export interface InferenceInferenceChunkingSettings extends InferenceInferenceEndpoint {
export interface InferenceInferenceChunkingSettings {
max_chunk_size?: integer
overlap?: integer
sentence_overlap?: integer
@ -14327,6 +14332,8 @@ export interface MlExponentialAverageCalculationContext {
previous_exponential_average_ms?: DurationValue<UnitFloatMillis>
}
export type MlFeatureExtractor = MlQueryFeatureExtractor
export interface MlFillMaskInferenceOptions {
mask_token?: string
num_top_classes?: integer
@ -14392,6 +14399,7 @@ export interface MlInferenceConfigCreateContainer {
text_classification?: MlTextClassificationInferenceOptions
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
fill_mask?: MlFillMaskInferenceOptions
learning_to_rank?: MlLearningToRankConfig
ner?: MlNerInferenceOptions
pass_through?: MlPassThroughInferenceOptions
text_embedding?: MlTextEmbeddingInferenceOptions
@ -14538,6 +14546,12 @@ export interface MlJobTimingStats {
minimum_bucket_processing_time_ms?: DurationValue<UnitFloatMillis>
}
export interface MlLearningToRankConfig {
default_params?: Record<string, any>
feature_extractors?: Record<string, MlFeatureExtractor>[]
num_top_feature_importance_values: integer
}
export type MlMemoryStatus = 'ok' | 'soft_limit' | 'hard_limit'
export interface MlModelPackageConfig {
@ -14680,6 +14694,12 @@ export interface MlPerPartitionCategorization {
export type MlPredictedValue = ScalarValue | ScalarValue[]
export interface MlQueryFeatureExtractor {
default_score?: float
feature_name: string
query: QueryDslQueryContainer
}
export interface MlQuestionAnsweringInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
@ -14724,6 +14744,7 @@ export interface MlTextClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
vocabulary?: MlVocabulary
}
export interface MlTextClassificationInferenceUpdateOptions {
@ -14766,6 +14787,7 @@ export interface MlTokenizationConfigContainer {
bert_ja?: MlNlpBertTokenizationConfig
mpnet?: MlNlpBertTokenizationConfig
roberta?: MlNlpRobertaTokenizationConfig
xlm_roberta?: MlXlmRobertaTokenizationConfig
}
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
@ -14843,6 +14865,7 @@ export interface MlTrainedModelConfig {
model_size_bytes?: ByteSize
model_package?: MlModelPackageConfig
location?: MlTrainedModelLocation
platform_architecture?: string
prefix_strings?: MlTrainedModelPrefixStrings
}
@ -14978,6 +15001,9 @@ export interface MlVocabulary {
index: IndexName
}
export interface MlXlmRobertaTokenizationConfig extends MlCommonTokenizationConfig {
}
export interface MlZeroShotClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
hypothesis_template?: string