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

Auto-generated code for 8.13 (#2263)

Browse Source
This commit is contained in:
Elastic Machine
2024-06-03 19:33:01 +01:00
committed by GitHub
parent a8d015e6c3
commit 5d36257241
4 changed files with 69 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/reference.asciidoc
View File

@ -4243,7 +4243,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, normalizer, norms, null_value, 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, 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, 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, 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, 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 }>)*: Mapping for a field. For new fields, this mapping can include:
** *`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, 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, 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, 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, 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, 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 }>)*: Mapping for a field. For new fields, this mapping can include:
- Field name
- Field data type
@ -6935,9 +6935,20 @@ Updates certain properties of trained model deployment.
{ref}/update-trained-model-deployment.html[Endpoint documentation]
[source,ts]
----
client.ml.updateTrainedModelDeployment()
client.ml.updateTrainedModelDeployment({ model_id })
----
[discrete]
==== Arguments
* *Request (object):*
** *`model_id` (string)*: The unique identifier of the trained model. Currently, only PyTorch models are supported.
** *`number_of_allocations` (Optional, number)*: The number of model allocations on each node where the model is deployed.
All allocations on a node share the same copy of the model in memory but use
a separate set of threads to evaluate the model.
Increasing this value generally increases the throughput.
If this setting is greater than the number of hardware threads
it will automatically be changed to a value less than the number of hardware threads.
[discrete]
==== upgrade_job_snapshot

26
src/api/api/ml.ts
View File

@ -2417,19 +2417,31 @@ export default class Ml {
* Updates certain properties of trained model deployment.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/8.13/update-trained-model-deployment.html | Elasticsearch API documentation}
*/
async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async updateTrainedModelDeployment (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlUpdateTrainedModelDeploymentResponse>
async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.MlUpdateTrainedModelDeploymentResponse, unknown>>
async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlUpdateTrainedModelDeploymentResponse>
async updateTrainedModelDeployment (this: That, params: T.MlUpdateTrainedModelDeploymentRequest | TB.MlUpdateTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['model_id']
const acceptedBody: string[] = ['number_of_allocations']
const querystring: Record<string, any> = {}
const body = undefined
// @ts-expect-error
const userBody: any = params?.body
let body: Record<string, any> | string
if (typeof userBody === 'string') {
body = userBody
} else {
body = userBody != null ? { ...userBody } : undefined
}
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
if (acceptedBody.includes(key)) {
body = body ?? {}
// @ts-expect-error
body[key] = params[key]
} else if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}

23
src/api/types.ts
View File

@ -810,7 +810,7 @@ export interface MsearchTemplateTemplateConfig {
}
export interface MtermvectorsOperation {
_id: Id
_id?: Id
_index?: IndexName
doc?: any
fields?: Fields
@ -1412,7 +1412,7 @@ export type SearchHighlighterType = 'plain' | 'fvh' | 'unified' | string
export interface SearchHit<TDocument = unknown> {
_index: IndexName
_id: Id
_id?: Id
_score?: double | null
_explanation?: ExplainExplanation
fields?: Record<string, any>
@ -4963,7 +4963,7 @@ export interface MappingFieldNamesField {
enabled: boolean
}
export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | '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'
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'
export interface MappingFlattenedProperty extends MappingPropertyBase {
boost?: double
@ -5061,6 +5061,8 @@ export interface MappingKeywordProperty extends MappingDocValuesPropertyBase {
eager_global_ordinals?: boolean
index?: boolean
index_options?: MappingIndexOptions
script?: Script
on_script_error?: MappingOnScriptError
normalizer?: string
norms?: boolean
null_value?: string
@ -14465,6 +14467,15 @@ export interface MlUpdateModelSnapshotResponse {
model: MlModelSnapshot
}
export interface MlUpdateTrainedModelDeploymentRequest extends RequestBase {
model_id: Id
number_of_allocations?: integer
}
export interface MlUpdateTrainedModelDeploymentResponse {
assignment: MlTrainedModelAssignment
}
export interface MlUpgradeJobSnapshotRequest extends RequestBase {
job_id: Id
snapshot_id: Id
@ -15145,7 +15156,7 @@ export interface NodesInfoNodeInfoRepositoriesUrl {
export interface NodesInfoNodeInfoScript {
allowed_types: string
disable_max_compilations_rate: string
disable_max_compilations_rate?: string
}
export interface NodesInfoNodeInfoSearch {
@ -15163,7 +15174,7 @@ export interface NodesInfoNodeInfoSettings {
repositories?: NodesInfoNodeInfoRepositories
discovery?: NodesInfoNodeInfoDiscover
action?: NodesInfoNodeInfoAction
client: NodesInfoNodeInfoClient
client?: NodesInfoNodeInfoClient
http: NodesInfoNodeInfoSettingsHttp
bootstrap?: NodesInfoNodeInfoBootstrap
transport: NodesInfoNodeInfoSettingsTransport
@ -15235,7 +15246,7 @@ export interface NodesInfoNodeInfoSettingsIngest {
}
export interface NodesInfoNodeInfoSettingsNetwork {
host: Host
host?: Host
}
export interface NodesInfoNodeInfoSettingsNode {

26
src/api/typesWithBodyKey.ts
View File

@ -840,7 +840,7 @@ export interface MsearchTemplateTemplateConfig {
}
export interface MtermvectorsOperation {
_id: Id
_id?: Id
_index?: IndexName
doc?: any
fields?: Fields
@ -1467,7 +1467,7 @@ export type SearchHighlighterType = 'plain' | 'fvh' | 'unified' | string
export interface SearchHit<TDocument = unknown> {
_index: IndexName
_id: Id
_id?: Id
_score?: double | null
_explanation?: ExplainExplanation
fields?: Record<string, any>
@ -5036,7 +5036,7 @@ export interface MappingFieldNamesField {
enabled: boolean
}
export type MappingFieldType = 'none' | 'geo_point' | 'geo_shape' | 'ip' | 'binary' | 'keyword' | 'text' | 'search_as_you_type' | 'date' | 'date_nanos' | 'boolean' | 'completion' | 'nested' | 'object' | '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'
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'
export interface MappingFlattenedProperty extends MappingPropertyBase {
boost?: double
@ -5134,6 +5134,8 @@ export interface MappingKeywordProperty extends MappingDocValuesPropertyBase {
eager_global_ordinals?: boolean
index?: boolean
index_options?: MappingIndexOptions
script?: Script
on_script_error?: MappingOnScriptError
normalizer?: string
norms?: boolean
null_value?: string
@ -14759,6 +14761,18 @@ export interface MlUpdateModelSnapshotResponse {
model: MlModelSnapshot
}
export interface MlUpdateTrainedModelDeploymentRequest extends RequestBase {
model_id: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
number_of_allocations?: integer
}
}
export interface MlUpdateTrainedModelDeploymentResponse {
assignment: MlTrainedModelAssignment
}
export interface MlUpgradeJobSnapshotRequest extends RequestBase {
job_id: Id
snapshot_id: Id
@ -15444,7 +15458,7 @@ export interface NodesInfoNodeInfoRepositoriesUrl {
export interface NodesInfoNodeInfoScript {
allowed_types: string
disable_max_compilations_rate: string
disable_max_compilations_rate?: string
}
export interface NodesInfoNodeInfoSearch {
@ -15462,7 +15476,7 @@ export interface NodesInfoNodeInfoSettings {
repositories?: NodesInfoNodeInfoRepositories
discovery?: NodesInfoNodeInfoDiscover
action?: NodesInfoNodeInfoAction
client: NodesInfoNodeInfoClient
client?: NodesInfoNodeInfoClient
http: NodesInfoNodeInfoSettingsHttp
bootstrap?: NodesInfoNodeInfoBootstrap
transport: NodesInfoNodeInfoSettingsTransport
@ -15534,7 +15548,7 @@ export interface NodesInfoNodeInfoSettingsIngest {
}
export interface NodesInfoNodeInfoSettingsNetwork {
host: Host
host?: Host
}
export interface NodesInfoNodeInfoSettingsNode {