Auto-generated code for main (#2127)

This commit is contained in:
Elastic Machine
2024-03-05 14:51:24 -05:00
committed by GitHub
parent 352f73e7c2
commit abd15eb111
13 changed files with 1202 additions and 144 deletions

View File

@ -71,7 +71,7 @@ export default class Eql {
/**
* Returns async results from previously executed Event Query Language (EQL) search
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-search-api.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-search-api.html | Elasticsearch API documentation}
*/
async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetResponse<TEvent>>
async get<TEvent = unknown> (this: That, params: T.EqlGetRequest | TB.EqlGetRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetResponse<TEvent>, unknown>>
@ -97,7 +97,7 @@ export default class Eql {
/**
* Returns the status of a previously submitted async or stored Event Query Language (EQL) search
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-status-api.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-async-eql-status-api.html | Elasticsearch API documentation}
*/
async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EqlGetStatusResponse>
async getStatus (this: That, params: T.EqlGetStatusRequest | TB.EqlGetStatusRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EqlGetStatusResponse, unknown>>

83
src/api/api/esql.ts Normal file
View File

@ -0,0 +1,83 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* eslint-disable import/export */
/* eslint-disable @typescript-eslint/no-misused-new */
/* eslint-disable @typescript-eslint/no-extraneous-class */
/* eslint-disable @typescript-eslint/no-unused-vars */
// This file was automatically generated by elastic/elastic-client-generator-js
// DO NOT MODIFY IT BY HAND. Instead, modify the source open api file,
// and elastic/elastic-client-generator-js to regenerate this file again.
import {
Transport,
TransportRequestOptions,
TransportRequestOptionsWithMeta,
TransportRequestOptionsWithOutMeta,
TransportResult
} from '@elastic/transport'
import * as T from '../types'
import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
export default class Esql {
transport: Transport
constructor (transport: Transport) {
this.transport = transport
}
/**
* Executes an ESQL request
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/esql-rest.html | Elasticsearch API documentation}
*/
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.EsqlQueryResponse>
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.EsqlQueryResponse, unknown>>
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptions): Promise<T.EsqlQueryResponse>
async query (this: That, params: T.EsqlQueryRequest | TB.EsqlQueryRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'query']
const querystring: Record<string, any> = {}
// @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
}
for (const key in params) {
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]
}
}
const method = 'POST'
const path = '/_query'
return await this.transport.request({ path, method, querystring, body }, options)
}
}

View File

@ -43,6 +43,56 @@ export default class Fleet {
this.transport = transport
}
/**
* Deletes a secret stored by Fleet.
*/
async deleteSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async deleteSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async deleteSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async deleteSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id']
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
querystring[key] = params[key]
}
}
const method = 'DELETE'
const path = `/_fleet/secret/${encodeURIComponent(params.id.toString())}`
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Retrieves a secret stored by Fleet.
*/
async getSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async getSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async getSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async getSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id']
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
querystring[key] = params[key]
}
}
const method = 'GET'
const path = `/_fleet/secret/${encodeURIComponent(params.id.toString())}`
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-global-checkpoints.html | Elasticsearch API documentation}
@ -106,6 +156,31 @@ export default class Fleet {
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
}
/**
* Creates a secret stored by Fleet.
*/
async postSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async postSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async postSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async postSecret (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
querystring[key] = params[key]
}
}
const method = 'POST'
const path = '/_fleet/secret'
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project.
*/

View File

@ -424,7 +424,7 @@ export default class Indices {
/**
* Deletes an index template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template.html | Elasticsearch API documentation}
*/
async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteIndexTemplateResponse>
async deleteIndexTemplate (this: That, params: T.IndicesDeleteIndexTemplateRequest | TB.IndicesDeleteIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteIndexTemplateResponse, unknown>>
@ -450,7 +450,7 @@ export default class Indices {
/**
* Deletes an index template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-template-v1.html | Elasticsearch API documentation}
*/
async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesDeleteTemplateResponse>
async deleteTemplate (this: That, params: T.IndicesDeleteTemplateRequest | TB.IndicesDeleteTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesDeleteTemplateResponse, unknown>>
@ -592,7 +592,7 @@ export default class Indices {
/**
* Returns information about whether a particular index template exists.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/index-templates.html | Elasticsearch API documentation}
*/
async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsIndexTemplateResponse>
async existsIndexTemplate (this: That, params: T.IndicesExistsIndexTemplateRequest | TB.IndicesExistsIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExistsIndexTemplateResponse, unknown>>
@ -618,7 +618,7 @@ export default class Indices {
/**
* Returns information about whether a particular index template exists.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-template-exists-v1.html | Elasticsearch API documentation}
*/
async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesExistsTemplateResponse>
async existsTemplate (this: That, params: T.IndicesExistsTemplateRequest | TB.IndicesExistsTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesExistsTemplateResponse, unknown>>
@ -923,7 +923,7 @@ export default class Indices {
/**
* Returns an index template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template.html | Elasticsearch API documentation}
*/
async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetIndexTemplateResponse>
async getIndexTemplate (this: That, params?: T.IndicesGetIndexTemplateRequest | TB.IndicesGetIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetIndexTemplateResponse, unknown>>
@ -1031,7 +1031,7 @@ export default class Indices {
/**
* Returns an index template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-template-v1.html | Elasticsearch API documentation}
*/
async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesGetTemplateResponse>
async getTemplate (this: That, params?: T.IndicesGetTemplateRequest | TB.IndicesGetTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesGetTemplateResponse, unknown>>
@ -1264,7 +1264,7 @@ export default class Indices {
/**
* Creates or updates an index template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-template.html | Elasticsearch API documentation}
*/
async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutIndexTemplateResponse>
async putIndexTemplate (this: That, params: T.IndicesPutIndexTemplateRequest | TB.IndicesPutIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutIndexTemplateResponse, unknown>>
@ -1378,7 +1378,7 @@ export default class Indices {
/**
* Creates or updates an index template.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates-v1.html | Elasticsearch API documentation}
*/
async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesPutTemplateResponse>
async putTemplate (this: That, params: T.IndicesPutTemplateRequest | TB.IndicesPutTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesPutTemplateResponse, unknown>>
@ -1508,6 +1508,32 @@ export default class Indices {
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Resolves the specified index expressions to return information about each cluster, including the local cluster, if included.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-cluster-api.html | Elasticsearch API documentation}
*/
async resolveCluster (this: That, params: T.IndicesResolveClusterRequest | TB.IndicesResolveClusterRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesResolveClusterResponse>
async resolveCluster (this: That, params: T.IndicesResolveClusterRequest | TB.IndicesResolveClusterRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesResolveClusterResponse, unknown>>
async resolveCluster (this: That, params: T.IndicesResolveClusterRequest | TB.IndicesResolveClusterRequest, options?: TransportRequestOptions): Promise<T.IndicesResolveClusterResponse>
async resolveCluster (this: That, params: T.IndicesResolveClusterRequest | TB.IndicesResolveClusterRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['name']
const querystring: Record<string, any> = {}
const body = undefined
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
const method = 'GET'
const path = `/_resolve/cluster/${encodeURIComponent(params.name.toString())}`
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Returns information about any matching indices, aliases, and data streams
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-resolve-index-api.html | Elasticsearch API documentation}
@ -1687,7 +1713,7 @@ export default class Indices {
/**
* Simulate matching the given index name against the index templates in the system
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-index.html | Elasticsearch API documentation}
*/
async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesSimulateIndexTemplateResponse>
async simulateIndexTemplate (this: That, params: T.IndicesSimulateIndexTemplateRequest | TB.IndicesSimulateIndexTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesSimulateIndexTemplateResponse, unknown>>
@ -1725,7 +1751,7 @@ export default class Indices {
/**
* Simulate resolving the given template name or body
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-simulate-template.html | Elasticsearch API documentation}
*/
async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesSimulateTemplateResponse>
async simulateTemplate (this: That, params: T.IndicesSimulateTemplateRequest | TB.IndicesSimulateTemplateRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesSimulateTemplateResponse, unknown>>

194
src/api/api/inference.ts Normal file
View File

@ -0,0 +1,194 @@
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/* eslint-disable import/export */
/* eslint-disable @typescript-eslint/no-misused-new */
/* eslint-disable @typescript-eslint/no-extraneous-class */
/* eslint-disable @typescript-eslint/no-unused-vars */
// This file was automatically generated by elastic/elastic-client-generator-js
// DO NOT MODIFY IT BY HAND. Instead, modify the source open api file,
// and elastic/elastic-client-generator-js to regenerate this file again.
import {
Transport,
TransportRequestOptions,
TransportRequestOptionsWithMeta,
TransportRequestOptionsWithOutMeta,
TransportResult
} from '@elastic/transport'
import * as T from '../types'
import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
export default class Inference {
transport: Transport
constructor (transport: Transport) {
this.transport = transport
}
/**
* Delete model in the Inference API
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-inference-api.html | Elasticsearch API documentation}
*/
async deleteModel (this: That, params: T.InferenceDeleteModelRequest | TB.InferenceDeleteModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferenceDeleteModelResponse>
async deleteModel (this: That, params: T.InferenceDeleteModelRequest | TB.InferenceDeleteModelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferenceDeleteModelResponse, unknown>>
async deleteModel (this: That, params: T.InferenceDeleteModelRequest | TB.InferenceDeleteModelRequest, options?: TransportRequestOptions): Promise<T.InferenceDeleteModelResponse>
async deleteModel (this: That, params: T.InferenceDeleteModelRequest | TB.InferenceDeleteModelRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['task_type', 'inference_id']
const querystring: Record<string, any> = {}
const body = undefined
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
let method = ''
let path = ''
if (params.task_type != null && params.inference_id != null) {
method = 'DELETE'
path = `/_inference/${encodeURIComponent(params.task_type.toString())}/${encodeURIComponent(params.inference_id.toString())}`
} else {
method = 'DELETE'
path = `/_inference/${encodeURIComponent(params.inference_id.toString())}`
}
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Get a model in the Inference API
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/get-inference-api.html | Elasticsearch API documentation}
*/
async getModel (this: That, params: T.InferenceGetModelRequest | TB.InferenceGetModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferenceGetModelResponse>
async getModel (this: That, params: T.InferenceGetModelRequest | TB.InferenceGetModelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferenceGetModelResponse, unknown>>
async getModel (this: That, params: T.InferenceGetModelRequest | TB.InferenceGetModelRequest, options?: TransportRequestOptions): Promise<T.InferenceGetModelResponse>
async getModel (this: That, params: T.InferenceGetModelRequest | TB.InferenceGetModelRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['task_type', 'inference_id']
const querystring: Record<string, any> = {}
const body = undefined
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
let method = ''
let path = ''
if (params.task_type != null && params.inference_id != null) {
method = 'GET'
path = `/_inference/${encodeURIComponent(params.task_type.toString())}/${encodeURIComponent(params.inference_id.toString())}`
} else {
method = 'GET'
path = `/_inference/${encodeURIComponent(params.inference_id.toString())}`
}
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Perform inference on a model
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/post-inference-api.html | Elasticsearch API documentation}
*/
async inference (this: That, params: T.InferenceInferenceRequest | TB.InferenceInferenceRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferenceInferenceResponse>
async inference (this: That, params: T.InferenceInferenceRequest | TB.InferenceInferenceRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferenceInferenceResponse, unknown>>
async inference (this: That, params: T.InferenceInferenceRequest | TB.InferenceInferenceRequest, options?: TransportRequestOptions): Promise<T.InferenceInferenceResponse>
async inference (this: That, params: T.InferenceInferenceRequest | TB.InferenceInferenceRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['task_type', 'inference_id']
const acceptedBody: string[] = ['input', 'task_settings']
const querystring: Record<string, any> = {}
// @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
}
for (const key in params) {
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]
}
}
let method = ''
let path = ''
if (params.task_type != null && params.inference_id != null) {
method = 'POST'
path = `/_inference/${encodeURIComponent(params.task_type.toString())}/${encodeURIComponent(params.inference_id.toString())}`
} else {
method = 'POST'
path = `/_inference/${encodeURIComponent(params.inference_id.toString())}`
}
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Configure a model for use in the Inference API
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/put-inference-api.html | Elasticsearch API documentation}
*/
async putModel (this: That, params: T.InferencePutModelRequest | TB.InferencePutModelRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.InferencePutModelResponse>
async putModel (this: That, params: T.InferencePutModelRequest | TB.InferencePutModelRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.InferencePutModelResponse, unknown>>
async putModel (this: That, params: T.InferencePutModelRequest | TB.InferencePutModelRequest, options?: TransportRequestOptions): Promise<T.InferencePutModelResponse>
async putModel (this: That, params: T.InferencePutModelRequest | TB.InferencePutModelRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['task_type', 'inference_id']
const acceptedBody: string[] = ['model_config']
const querystring: Record<string, any> = {}
// @ts-expect-error
let body: any = params.body ?? undefined
for (const key in params) {
if (acceptedBody.includes(key)) {
// @ts-expect-error
body = params[key]
} else if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
let method = ''
let path = ''
if (params.task_type != null && params.inference_id != null) {
method = 'PUT'
path = `/_inference/${encodeURIComponent(params.task_type.toString())}/${encodeURIComponent(params.inference_id.toString())}`
} else {
method = 'PUT'
path = `/_inference/${encodeURIComponent(params.inference_id.toString())}`
}
return await this.transport.request({ path, method, querystring, body }, options)
}
}

View File

@ -45,7 +45,7 @@ export default class SearchApplication {
/**
* Deletes a search application.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/put-search-application.html | Elasticsearch API documentation}
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-search-application.html | Elasticsearch API documentation}
*/
async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SearchApplicationDeleteResponse>
async delete (this: That, params: T.SearchApplicationDeleteRequest | TB.SearchApplicationDeleteRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SearchApplicationDeleteResponse, unknown>>

View File

@ -918,6 +918,32 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Retrieve settings for the security system indices
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-settings.html | Elasticsearch API documentation}
*/
async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async getSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
querystring[key] = params[key]
}
}
const method = 'GET'
const path = '/_security/settings'
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Creates a bearer token for access without requiring basic authentication.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-get-token.html | Elasticsearch API documentation}
@ -1400,7 +1426,7 @@ export default class Security {
async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<T.SecurityPutRoleMappingResponse>
async putRoleMapping (this: That, params: T.SecurityPutRoleMappingRequest | TB.SecurityPutRoleMappingRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['name']
const acceptedBody: string[] = ['enabled', 'metadata', 'roles', 'rules', 'run_as']
const acceptedBody: string[] = ['enabled', 'metadata', 'roles', 'role_templates', 'rules', 'run_as']
const querystring: Record<string, any> = {}
// @ts-expect-error
const userBody: any = params?.body
@ -1771,7 +1797,7 @@ export default class Security {
async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateApiKeyResponse>
async updateApiKey (this: That, params: T.SecurityUpdateApiKeyRequest | TB.SecurityUpdateApiKeyRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['id']
const acceptedBody: string[] = ['role_descriptors', 'metadata']
const acceptedBody: string[] = ['role_descriptors', 'metadata', 'expiration']
const querystring: Record<string, any> = {}
// @ts-expect-error
const userBody: any = params?.body
@ -1826,6 +1852,32 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Update settings for the security system index
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-settings.html | Elasticsearch API documentation}
*/
async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async updateSettings (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
querystring[key] = params[key]
}
}
const method = 'PUT'
const path = '/_security/settings'
return await this.transport.request({ path, method, querystring, body }, options)
}
/**
* Update application specific data for the user profile of the given unique ID.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/security-api-update-user-profile-data.html | Elasticsearch API documentation}

View File

@ -73,4 +73,42 @@ export default class TextStructure {
const path = '/_text_structure/find_structure'
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
}
/**
* Tests a Grok pattern on some text.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/test-grok-pattern.html | Elasticsearch API documentation}
*/
async testGrokPattern (this: That, params: T.TextStructureTestGrokPatternRequest | TB.TextStructureTestGrokPatternRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.TextStructureTestGrokPatternResponse>
async testGrokPattern (this: That, params: T.TextStructureTestGrokPatternRequest | TB.TextStructureTestGrokPatternRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TextStructureTestGrokPatternResponse, unknown>>
async testGrokPattern (this: That, params: T.TextStructureTestGrokPatternRequest | TB.TextStructureTestGrokPatternRequest, options?: TransportRequestOptions): Promise<T.TextStructureTestGrokPatternResponse>
async testGrokPattern (this: That, params: T.TextStructureTestGrokPatternRequest | TB.TextStructureTestGrokPatternRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const acceptedBody: string[] = ['grok_pattern', 'text']
const querystring: Record<string, any> = {}
// @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
}
for (const key in params) {
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]
}
}
const method = body != null ? 'POST' : 'GET'
const path = '/_text_structure/test_grok_pattern'
return await this.transport.request({ path, method, querystring, body }, options)
}
}

View File

@ -38,7 +38,7 @@ import * as TB from '../typesWithBodyKey'
interface That { transport: Transport }
/**
* Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
* Updates documents that match the specified query. If no query is specified, performs an update on every document in the index without changing the source, for example to pick up a mapping change.
* @see {@link https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update-by-query.html | Elasticsearch API documentation}
*/
export default async function UpdateByQueryApi (this: That, params: T.UpdateByQueryRequest | TB.UpdateByQueryRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.UpdateByQueryResponse>

View File

@ -43,6 +43,7 @@ import deleteByQueryRethrottleApi from './api/delete_by_query_rethrottle'
import deleteScriptApi from './api/delete_script'
import EnrichApi from './api/enrich'
import EqlApi from './api/eql'
import EsqlApi from './api/esql'
import existsApi from './api/exists'
import existsSourceApi from './api/exists_source'
import explainApi from './api/explain'
@ -59,6 +60,7 @@ import healthReportApi from './api/health_report'
import IlmApi from './api/ilm'
import indexApi from './api/index'
import IndicesApi from './api/indices'
import InferenceApi from './api/inference'
import infoApi from './api/info'
import IngestApi from './api/ingest'
import knnSearchApi from './api/knn_search'
@ -126,6 +128,7 @@ export default interface API {
deleteScript: typeof deleteScriptApi
enrich: EnrichApi
eql: EqlApi
esql: EsqlApi
exists: typeof existsApi
existsSource: typeof existsSourceApi
explain: typeof explainApi
@ -142,6 +145,7 @@ export default interface API {
ilm: IlmApi
index: typeof indexApi
indices: IndicesApi
inference: InferenceApi
info: typeof infoApi
ingest: IngestApi
knnSearch: typeof knnSearchApi
@ -199,11 +203,13 @@ const kCluster = Symbol('Cluster')
const kDanglingIndices = Symbol('DanglingIndices')
const kEnrich = Symbol('Enrich')
const kEql = Symbol('Eql')
const kEsql = Symbol('Esql')
const kFeatures = Symbol('Features')
const kFleet = Symbol('Fleet')
const kGraph = Symbol('Graph')
const kIlm = Symbol('Ilm')
const kIndices = Symbol('Indices')
const kInference = Symbol('Inference')
const kIngest = Symbol('Ingest')
const kLicense = Symbol('License')
const kLogstash = Symbol('Logstash')
@ -237,11 +243,13 @@ export default class API {
[kDanglingIndices]: symbol | null
[kEnrich]: symbol | null
[kEql]: symbol | null
[kEsql]: symbol | null
[kFeatures]: symbol | null
[kFleet]: symbol | null
[kGraph]: symbol | null
[kIlm]: symbol | null
[kIndices]: symbol | null
[kInference]: symbol | null
[kIngest]: symbol | null
[kLicense]: symbol | null
[kLogstash]: symbol | null
@ -274,11 +282,13 @@ export default class API {
this[kDanglingIndices] = null
this[kEnrich] = null
this[kEql] = null
this[kEsql] = null
this[kFeatures] = null
this[kFleet] = null
this[kGraph] = null
this[kIlm] = null
this[kIndices] = null
this[kInference] = null
this[kIngest] = null
this[kLicense] = null
this[kLogstash] = null
@ -375,6 +385,9 @@ Object.defineProperties(API.prototype, {
eql: {
get () { return this[kEql] === null ? (this[kEql] = new EqlApi(this.transport)) : this[kEql] }
},
esql: {
get () { return this[kEsql] === null ? (this[kEsql] = new EsqlApi(this.transport)) : this[kEsql] }
},
features: {
get () { return this[kFeatures] === null ? (this[kFeatures] = new FeaturesApi(this.transport)) : this[kFeatures] }
},
@ -390,6 +403,9 @@ Object.defineProperties(API.prototype, {
indices: {
get () { return this[kIndices] === null ? (this[kIndices] = new IndicesApi(this.transport)) : this[kIndices] }
},
inference: {
get () { return this[kInference] === null ? (this[kInference] = new InferenceApi(this.transport)) : this[kInference] }
},
ingest: {
get () { return this[kIngest] === null ? (this[kIngest] = new IngestApi(this.transport)) : this[kIngest] }
},

View File

@ -347,6 +347,7 @@ export interface FieldCapsRequest extends RequestBase {
include_unmapped?: boolean
filters?: string
types?: string[]
include_empty_fields?: boolean
fields?: Fields
index_filter?: QueryDslQueryContainer
runtime_mappings?: MappingRuntimeFields
@ -1146,6 +1147,7 @@ export interface SearchRequest extends RequestBase {
_source_includes?: Fields
q?: string
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
explain?: boolean
@ -2073,6 +2075,13 @@ export interface ElasticsearchVersionInfo {
number: string
}
export interface ElasticsearchVersionMinInfo {
build_flavor: string
minimum_index_compatibility_version: VersionString
minimum_wire_compatibility_version: VersionString
number: string
}
export interface EmptyObject {
}
@ -2094,6 +2103,8 @@ export interface ErrorResponseBase {
status: integer
}
export type EsqlColumns = ArrayBuffer
export type ExpandWildcard = 'all' | 'open' | 'closed' | 'hidden' | 'none'
export type ExpandWildcards = ExpandWildcard | ExpandWildcard[]
@ -2275,6 +2286,7 @@ export interface KnnQuery {
boost?: float
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
similarity?: float
inner_hits?: SearchInnerHits
}
export interface LatLonGeoLocation {
@ -2286,8 +2298,6 @@ export type Level = 'cluster' | 'indices' | 'shards'
export type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED'
export type ManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged'
export type MapboxVectorTiles = ArrayBuffer
export interface MergesStats {
@ -2467,6 +2477,8 @@ export interface RrfRank {
window_size?: long
}
export type ScalarValue = long | double | string | boolean | null
export interface ScoreSort {
order?: SortOrder
}
@ -4508,11 +4520,11 @@ export type AnalysisNormalizer = AnalysisLowercaseNormalizer | AnalysisCustomNor
export interface AnalysisPathHierarchyTokenizer extends AnalysisTokenizerBase {
type: 'path_hierarchy'
buffer_size: SpecUtilsStringified<integer>
delimiter: string
replacement: string
reverse: SpecUtilsStringified<boolean>
skip: SpecUtilsStringified<integer>
buffer_size?: SpecUtilsStringified<integer>
delimiter?: string
replacement?: string
reverse?: SpecUtilsStringified<boolean>
skip?: SpecUtilsStringified<integer>
}
export interface AnalysisPatternAnalyzer {
@ -4688,7 +4700,7 @@ export interface AnalysisTokenFilterBase {
version?: VersionString
}
export type AnalysisTokenFilterDefinition = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuTokenizer | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter
export type AnalysisTokenFilterDefinition = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter
export type AnalysisTokenizer = string | AnalysisTokenizerDefinition
@ -5096,7 +5108,7 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase {
type: 'point'
}
export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | 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
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
export interface MappingPropertyBase {
meta?: Record<string, string>
@ -5190,6 +5202,10 @@ export interface MappingSourceField {
export type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic'
export interface MappingSparseVectorProperty extends MappingPropertyBase {
type: 'sparse_vector'
}
export interface MappingSuggestContext {
name: Name
path?: Field
@ -5432,9 +5448,10 @@ export interface QueryDslGeoDistanceQueryKeys extends QueryDslQueryBase {
distance: Distance
distance_type?: GeoDistanceType
validation_method?: QueryDslGeoValidationMethod
ignore_unmapped?: boolean
}
export type QueryDslGeoDistanceQuery = QueryDslGeoDistanceQueryKeys
& { [property: string]: GeoLocation | Distance | GeoDistanceType | QueryDslGeoValidationMethod | float | string }
& { [property: string]: GeoLocation | Distance | GeoDistanceType | QueryDslGeoValidationMethod | boolean | float | string }
export type QueryDslGeoExecution = 'memory' | 'indexed'
@ -5746,6 +5763,7 @@ export interface QueryDslQueryContainer {
has_parent?: QueryDslHasParentQuery
ids?: QueryDslIdsQuery
intervals?: Partial<Record<Field, QueryDslIntervalsQuery>>
knn?: KnnQuery
match?: Partial<Record<Field, QueryDslMatchQuery | string | float | boolean>>
match_all?: QueryDslMatchAllQuery
match_bool_prefix?: Partial<Record<Field, QueryDslMatchBoolPrefixQuery | string>>
@ -5781,6 +5799,7 @@ export interface QueryDslQueryContainer {
terms?: QueryDslTermsQuery
terms_set?: Partial<Record<Field, QueryDslTermsSetQuery>>
text_expansion?: Partial<Record<Field, QueryDslTextExpansionQuery>>
weighted_tokens?: Partial<Record<Field, QueryDslWeightedTokensQuery>>
wildcard?: Partial<Record<Field, QueryDslWildcardQuery | string>>
wrapper?: QueryDslWrapperQuery
type?: QueryDslTypeQuery
@ -6003,14 +6022,26 @@ export interface QueryDslTermsSetQuery extends QueryDslQueryBase {
export interface QueryDslTextExpansionQuery extends QueryDslQueryBase {
model_id: string
model_text: string
pruning_config?: QueryDslTokenPruningConfig
}
export type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix'
export interface QueryDslTokenPruningConfig {
tokens_freq_ratio_threshold?: integer
tokens_weight_threshold?: float
only_score_pruned_tokens?: boolean
}
export interface QueryDslTypeQuery extends QueryDslQueryBase {
value: string
}
export interface QueryDslWeightedTokensQuery extends QueryDslQueryBase {
tokens: Record<string, float>
pruning_config?: QueryDslTokenPruningConfig
}
export interface QueryDslWildcardQuery extends QueryDslQueryBase {
case_insensitive?: boolean
rewrite?: MultiTermQueryRewrite
@ -6119,6 +6150,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
_source_includes?: Fields
q?: string
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
explain?: boolean
@ -8952,7 +8984,7 @@ export interface EnrichPolicy {
enrich_fields: Fields
indices: Indices
match_field: Field
query?: string
query?: QueryDslQueryContainer
name?: Name
elasticsearch_version?: string
}
@ -9111,6 +9143,18 @@ export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEven
export type EqlSearchResultPosition = 'tail' | 'head'
export interface EsqlQueryRequest extends RequestBase {
format?: string
delimiter?: string
columnar?: boolean
filter?: QueryDslQueryContainer
locale?: string
params?: ScalarValue[]
query: string
}
export type EsqlQueryResponse = EsqlColumns
export interface FeaturesFeature {
name: string
description: string
@ -9200,6 +9244,7 @@ export interface FleetSearchRequest extends RequestBase {
wait_for_checkpoints?: FleetCheckpoint[]
allow_partial_search_results?: boolean
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
explain?: boolean
@ -9525,7 +9570,7 @@ export interface IndicesDataStream {
generation: integer
hidden: boolean
ilm_policy?: Name
next_generation_managed_by: ManagedBy
next_generation_managed_by: IndicesManagedBy
prefer_ilm: boolean
indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataStreamLifecycleWithRollover
@ -9541,7 +9586,7 @@ export interface IndicesDataStreamIndex {
index_name: IndexName
index_uuid: Uuid
ilm_policy?: Name
managed_by: ManagedBy
managed_by: IndicesManagedBy
prefer_ilm: boolean
}
@ -9697,7 +9742,6 @@ export interface IndicesIndexSettingsKeys {
analysis?: IndicesIndexSettingsAnalysis
settings?: IndicesIndexSettings
time_series?: IndicesIndexSettingsTimeSeries
shards?: integer
queries?: IndicesQueries
similarity?: IndicesSettingsSimilarity
mapping?: IndicesMappingLimitSettings
@ -9790,6 +9834,8 @@ export interface IndicesIndexingSlowlogTresholds {
index?: IndicesSlowlogTresholdLevels
}
export type IndicesManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged'
export interface IndicesMappingLimitSettings {
coerce?: boolean
total_fields?: IndicesMappingLimitSettingsTotalFields
@ -10791,6 +10837,24 @@ export interface IndicesReloadSearchAnalyzersRequest extends RequestBase {
export type IndicesReloadSearchAnalyzersResponse = IndicesReloadSearchAnalyzersReloadResult
export interface IndicesResolveClusterRequest extends RequestBase {
name: Names
allow_no_indices?: boolean
expand_wildcards?: ExpandWildcards
ignore_throttled?: boolean
ignore_unavailable?: boolean
}
export interface IndicesResolveClusterResolveClusterInfo {
connected: boolean
skip_unavailable: boolean
matching_indices?: boolean
error?: string
version?: ElasticsearchVersionMinInfo
}
export type IndicesResolveClusterResponse = Record<ClusterAlias, IndicesResolveClusterResolveClusterInfo>
export interface IndicesResolveIndexRequest extends RequestBase {
name: Names
expand_wildcards?: ExpandWildcards
@ -11263,6 +11327,80 @@ export interface IndicesValidateQueryResponse {
error?: string
}
export type InferenceDenseByteVector = byte[]
export type InferenceDenseVector = float[]
export interface InferenceInferenceResult {
text_embedding_bytes?: InferenceTextEmbeddingByteResult[]
text_embedding?: InferenceTextEmbeddingResult[]
sparse_embedding?: InferenceSparseEmbeddingResult[]
}
export interface InferenceModelConfig {
service: string
service_settings: InferenceServiceSettings
task_settings: InferenceTaskSettings
}
export interface InferenceModelConfigContainer extends InferenceModelConfig {
model_id: string
task_type: InferenceTaskType
}
export type InferenceServiceSettings = any
export interface InferenceSparseEmbeddingResult {
embedding: InferenceSparseVector
}
export type InferenceSparseVector = Record<string, float>
export type InferenceTaskSettings = any
export type InferenceTaskType = 'sparse_embedding' | 'text_embedding'
export interface InferenceTextEmbeddingByteResult {
embedding: InferenceDenseByteVector
}
export interface InferenceTextEmbeddingResult {
embedding: InferenceDenseVector
}
export interface InferenceDeleteModelRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
}
export type InferenceDeleteModelResponse = AcknowledgedResponseBase
export interface InferenceGetModelRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
}
export interface InferenceGetModelResponse {
models: InferenceModelConfigContainer[]
}
export interface InferenceInferenceRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
input: string | string[]
task_settings?: InferenceTaskSettings
}
export type InferenceInferenceResponse = InferenceInferenceResult
export interface InferencePutModelRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
model_config?: InferenceModelConfig
}
export type InferencePutModelResponse = InferenceModelConfigContainer
export interface IngestAppendProcessor extends IngestProcessorBase {
field: Field
value: any[]
@ -11276,6 +11414,7 @@ export interface IngestAttachmentProcessor extends IngestProcessorBase {
indexed_chars_field?: Field
properties?: string[]
target_field?: Field
remove_binary?: boolean
resource_name?: string
}
@ -11456,6 +11595,7 @@ export interface IngestPipeline {
on_failure?: IngestProcessorContainer[]
processors?: IngestProcessorContainer[]
version?: VersionNumber
_meta: Metadata
}
export interface IngestPipelineConfig {
@ -11498,7 +11638,8 @@ export interface IngestProcessorContainer {
lowercase?: IngestLowercaseProcessor
remove?: IngestRemoveProcessor
rename?: IngestRenameProcessor
script?: Script
reroute?: IngestRerouteProcessor
script?: IngestScriptProcessor
set?: IngestSetProcessor
sort?: IngestSortProcessor
split?: IngestSplitProcessor
@ -11525,6 +11666,19 @@ export interface IngestRenameProcessor extends IngestProcessorBase {
target_field: Field
}
export interface IngestRerouteProcessor extends IngestProcessorBase {
destination?: string
dataset?: string | string[]
namespace?: string | string[]
}
export interface IngestScriptProcessor extends IngestProcessorBase {
id?: Id
lang?: string
params?: Record<string, any>
source?: string
}
export interface IngestSetProcessor extends IngestProcessorBase {
copy_from?: Field
field: Field
@ -12969,6 +13123,7 @@ export interface MlTrainedModelConfig {
metadata?: MlTrainedModelConfigMetadata
model_size_bytes?: ByteSize
location?: MlTrainedModelLocation
prefix_strings?: MlTrainedModelPrefixStrings
}
export interface MlTrainedModelConfigInput {
@ -13056,6 +13211,11 @@ export interface MlTrainedModelLocationIndex {
name: IndexName
}
export interface MlTrainedModelPrefixStrings {
ingest: string
search: string
}
export interface MlTrainedModelSizeStats {
model_size_bytes: ByteSize
required_native_memory_bytes: integer
@ -13851,6 +14011,7 @@ export interface MlPutDatafeedRequest extends RequestBase {
delayed_data_check_config?: MlDelayedDataCheckConfig
frequency?: Duration
indices?: Indices
/** @alias indices */
indexes?: Indices
indices_options?: IndicesOptions
job_id?: Id
@ -14185,6 +14346,7 @@ export interface MlUpdateDatafeedRequest extends RequestBase {
delayed_data_check_config?: MlDelayedDataCheckConfig
frequency?: Duration
indices?: string[]
/** @alias indices */
indexes?: string[]
indices_options?: IndicesOptions
job_id?: Id
@ -14874,9 +15036,13 @@ export interface NodesInfoNodeInfoClient {
type: string
}
export interface NodesInfoNodeInfoDiscover {
seed_hosts: string
export interface NodesInfoNodeInfoDiscoverKeys {
seed_hosts?: string[]
type?: string
seed_providers?: string[]
}
export type NodesInfoNodeInfoDiscover = NodesInfoNodeInfoDiscoverKeys
& { [property: string]: any }
export interface NodesInfoNodeInfoHttp {
bound_address: string[]
@ -14942,9 +15108,9 @@ export interface NodesInfoNodeInfoOSCPU {
}
export interface NodesInfoNodeInfoPath {
logs: string
home: string
repo: string[]
logs?: string
home?: string
repo?: string[]
data?: string[]
}
@ -14972,7 +15138,7 @@ export interface NodesInfoNodeInfoSearchRemote {
export interface NodesInfoNodeInfoSettings {
cluster: NodesInfoNodeInfoSettingsCluster
node: NodesInfoNodeInfoSettingsNode
path: NodesInfoNodeInfoPath
path?: NodesInfoNodeInfoPath
repositories?: NodesInfoNodeInfoRepositories
discovery?: NodesInfoNodeInfoDiscover
action?: NodesInfoNodeInfoAction
@ -14991,7 +15157,7 @@ export interface NodesInfoNodeInfoSettingsCluster {
name: Name
routing?: IndicesIndexRouting
election: NodesInfoNodeInfoSettingsClusterElection
initial_master_nodes?: string
initial_master_nodes?: string[]
deprecation_indexing?: NodesInfoDeprecationIndexing
}
@ -15454,6 +15620,7 @@ export interface RollupRollupSearchRequest extends RequestBase {
rest_total_hits_as_int?: boolean
typed_keys?: boolean
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
query?: QueryDslQueryContainer
size?: integer
@ -15679,11 +15846,9 @@ export interface SecurityCreatedStatus {
}
export interface SecurityFieldRule {
username?: Name
username?: Names
dn?: Names
groups?: Names
metadata?: any
realm?: SecurityRealm
}
export interface SecurityFieldSecurity {
@ -15713,10 +15878,6 @@ export interface SecurityManageUserPrivileges {
applications: string[]
}
export interface SecurityRealm {
name: Name
}
export interface SecurityRealmInfo {
name: Name
type: string
@ -15749,7 +15910,7 @@ export interface SecurityRoleMapping {
metadata: Metadata
roles: string[]
rules: SecurityRoleMappingRule
role_templates?: SecurityGetRoleRoleTemplate[]
role_templates?: SecurityRoleTemplate[]
}
export interface SecurityRoleMappingRule {
@ -15759,6 +15920,11 @@ export interface SecurityRoleMappingRule {
except?: SecurityRoleMappingRule
}
export interface SecurityRoleTemplate {
format?: SecurityTemplateFormat
template: Script
}
export type SecurityRoleTemplateInlineQuery = string | QueryDslQueryContainer
export interface SecurityRoleTemplateInlineScript extends ScriptBase {
@ -15773,6 +15939,8 @@ export interface SecurityRoleTemplateQuery {
export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | SecurityRoleTemplateInlineQuery | StoredScriptId
export type SecurityTemplateFormat = 'string' | 'json'
export interface SecurityTransientMetadataConfig {
enabled: boolean
}
@ -16063,6 +16231,7 @@ export interface SecurityGetApiKeyRequest extends RequestBase {
realm_name?: Name
username?: Username
with_limited_by?: boolean
active_only?: boolean
}
export interface SecurityGetApiKeyResponse {
@ -16097,17 +16266,10 @@ export interface SecurityGetRoleRole {
run_as: string[]
transient_metadata: SecurityTransientMetadataConfig
applications: SecurityApplicationPrivileges[]
role_templates?: SecurityGetRoleRoleTemplate[]
role_templates?: SecurityRoleTemplate[]
global?: Record<string, Record<string, Record<string, string[]>>>
}
export interface SecurityGetRoleRoleTemplate {
format?: SecurityGetRoleTemplateFormat
template: Script
}
export type SecurityGetRoleTemplateFormat = 'string' | 'json'
export interface SecurityGetRoleMappingRequest extends RequestBase {
name?: Names
}
@ -16366,6 +16528,7 @@ export interface SecurityPutRoleMappingRequest extends RequestBase {
enabled?: boolean
metadata?: Metadata
roles?: string[]
role_templates?: SecurityRoleTemplate[]
rules?: SecurityRoleMappingRule
run_as?: string[]
}
@ -16497,6 +16660,7 @@ export interface SecurityUpdateApiKeyRequest extends RequestBase {
id: Id
role_descriptors?: Record<string, SecurityRoleDescriptor>
metadata?: Metadata
expiration?: Duration
}
export interface SecurityUpdateApiKeyResponse {
@ -17180,7 +17344,7 @@ export interface SynonymsPutSynonymResponse {
export interface SynonymsPutSynonymRuleRequest extends RequestBase {
set_id: Id
rule_id: Id
synonyms: SynonymsSynonymString[]
synonyms: SynonymsSynonymString
}
export type SynonymsPutSynonymRuleResponse = SynonymsSynonymsUpdateResult
@ -17278,6 +17442,7 @@ export interface TextStructureFindStructureRequest<TJsonDocument = unknown> {
charset?: string
column_names?: string
delimiter?: string
ecs_compatibility?: string
explain?: boolean
format?: string
grok_pattern?: string
@ -17322,6 +17487,27 @@ export interface TextStructureFindStructureTopHit {
value: any
}
export interface TextStructureTestGrokPatternMatchedField {
match: string
offset: integer
length: integer
}
export interface TextStructureTestGrokPatternMatchedText {
matched: boolean
fields?: Record<string, TextStructureTestGrokPatternMatchedField[]>
}
export interface TextStructureTestGrokPatternRequest extends RequestBase {
ecs_compatibility?: string
grok_pattern: string
text: string[]
}
export interface TextStructureTestGrokPatternResponse {
matches: TextStructureTestGrokPatternMatchedText[]
}
export interface TransformDestination {
index?: IndexName
pipeline?: string

View File

@ -365,6 +365,7 @@ export interface FieldCapsRequest extends RequestBase {
include_unmapped?: boolean
filters?: string
types?: string[]
include_empty_fields?: boolean
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
fields?: Fields
@ -1200,6 +1201,7 @@ export interface SearchRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
explain?: boolean
@ -2146,6 +2148,13 @@ export interface ElasticsearchVersionInfo {
number: string
}
export interface ElasticsearchVersionMinInfo {
build_flavor: string
minimum_index_compatibility_version: VersionString
minimum_wire_compatibility_version: VersionString
number: string
}
export interface EmptyObject {
}
@ -2167,6 +2176,8 @@ export interface ErrorResponseBase {
status: integer
}
export type EsqlColumns = ArrayBuffer
export type ExpandWildcard = 'all' | 'open' | 'closed' | 'hidden' | 'none'
export type ExpandWildcards = ExpandWildcard | ExpandWildcard[]
@ -2348,6 +2359,7 @@ export interface KnnQuery {
boost?: float
filter?: QueryDslQueryContainer | QueryDslQueryContainer[]
similarity?: float
inner_hits?: SearchInnerHits
}
export interface LatLonGeoLocation {
@ -2359,8 +2371,6 @@ export type Level = 'cluster' | 'indices' | 'shards'
export type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED'
export type ManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged'
export type MapboxVectorTiles = ArrayBuffer
export interface MergesStats {
@ -2540,6 +2550,8 @@ export interface RrfRank {
window_size?: long
}
export type ScalarValue = long | double | string | boolean | null
export interface ScoreSort {
order?: SortOrder
}
@ -4581,11 +4593,11 @@ export type AnalysisNormalizer = AnalysisLowercaseNormalizer | AnalysisCustomNor
export interface AnalysisPathHierarchyTokenizer extends AnalysisTokenizerBase {
type: 'path_hierarchy'
buffer_size: SpecUtilsStringified<integer>
delimiter: string
replacement: string
reverse: SpecUtilsStringified<boolean>
skip: SpecUtilsStringified<integer>
buffer_size?: SpecUtilsStringified<integer>
delimiter?: string
replacement?: string
reverse?: SpecUtilsStringified<boolean>
skip?: SpecUtilsStringified<integer>
}
export interface AnalysisPatternAnalyzer {
@ -4761,7 +4773,7 @@ export interface AnalysisTokenFilterBase {
version?: VersionString
}
export type AnalysisTokenFilterDefinition = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuTokenizer | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter
export type AnalysisTokenFilterDefinition = AnalysisAsciiFoldingTokenFilter | AnalysisCommonGramsTokenFilter | AnalysisConditionTokenFilter | AnalysisDelimitedPayloadTokenFilter | AnalysisEdgeNGramTokenFilter | AnalysisElisionTokenFilter | AnalysisFingerprintTokenFilter | AnalysisHunspellTokenFilter | AnalysisHyphenationDecompounderTokenFilter | AnalysisKeepTypesTokenFilter | AnalysisKeepWordsTokenFilter | AnalysisKeywordMarkerTokenFilter | AnalysisKStemTokenFilter | AnalysisLengthTokenFilter | AnalysisLimitTokenCountTokenFilter | AnalysisLowercaseTokenFilter | AnalysisMultiplexerTokenFilter | AnalysisNGramTokenFilter | AnalysisNoriPartOfSpeechTokenFilter | AnalysisPatternCaptureTokenFilter | AnalysisPatternReplaceTokenFilter | AnalysisPorterStemTokenFilter | AnalysisPredicateTokenFilter | AnalysisRemoveDuplicatesTokenFilter | AnalysisReverseTokenFilter | AnalysisShingleTokenFilter | AnalysisSnowballTokenFilter | AnalysisStemmerOverrideTokenFilter | AnalysisStemmerTokenFilter | AnalysisStopTokenFilter | AnalysisSynonymGraphTokenFilter | AnalysisSynonymTokenFilter | AnalysisTrimTokenFilter | AnalysisTruncateTokenFilter | AnalysisUniqueTokenFilter | AnalysisUppercaseTokenFilter | AnalysisWordDelimiterGraphTokenFilter | AnalysisWordDelimiterTokenFilter | AnalysisKuromojiStemmerTokenFilter | AnalysisKuromojiReadingFormTokenFilter | AnalysisKuromojiPartOfSpeechTokenFilter | AnalysisIcuCollationTokenFilter | AnalysisIcuFoldingTokenFilter | AnalysisIcuNormalizationTokenFilter | AnalysisIcuTransformTokenFilter | AnalysisPhoneticTokenFilter | AnalysisDictionaryDecompounderTokenFilter
export type AnalysisTokenizer = string | AnalysisTokenizerDefinition
@ -5169,7 +5181,7 @@ export interface MappingPointProperty extends MappingDocValuesPropertyBase {
type: 'point'
}
export type MappingProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDynamicProperty | MappingJoinProperty | MappingKeywordProperty | MappingMatchOnlyTextProperty | MappingPercolatorProperty | MappingRankFeatureProperty | MappingRankFeaturesProperty | MappingSearchAsYouTypeProperty | MappingTextProperty | MappingVersionProperty | MappingWildcardProperty | MappingDateNanosProperty | MappingDateProperty | MappingAggregateMetricDoubleProperty | MappingDenseVectorProperty | 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
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
export interface MappingPropertyBase {
meta?: Record<string, string>
@ -5263,6 +5275,10 @@ export interface MappingSourceField {
export type MappingSourceFieldMode = 'disabled' | 'stored' | 'synthetic'
export interface MappingSparseVectorProperty extends MappingPropertyBase {
type: 'sparse_vector'
}
export interface MappingSuggestContext {
name: Name
path?: Field
@ -5505,9 +5521,10 @@ export interface QueryDslGeoDistanceQueryKeys extends QueryDslQueryBase {
distance: Distance
distance_type?: GeoDistanceType
validation_method?: QueryDslGeoValidationMethod
ignore_unmapped?: boolean
}
export type QueryDslGeoDistanceQuery = QueryDslGeoDistanceQueryKeys
& { [property: string]: GeoLocation | Distance | GeoDistanceType | QueryDslGeoValidationMethod | float | string }
& { [property: string]: GeoLocation | Distance | GeoDistanceType | QueryDslGeoValidationMethod | boolean | float | string }
export type QueryDslGeoExecution = 'memory' | 'indexed'
@ -5819,6 +5836,7 @@ export interface QueryDslQueryContainer {
has_parent?: QueryDslHasParentQuery
ids?: QueryDslIdsQuery
intervals?: Partial<Record<Field, QueryDslIntervalsQuery>>
knn?: KnnQuery
match?: Partial<Record<Field, QueryDslMatchQuery | string | float | boolean>>
match_all?: QueryDslMatchAllQuery
match_bool_prefix?: Partial<Record<Field, QueryDslMatchBoolPrefixQuery | string>>
@ -5854,6 +5872,7 @@ export interface QueryDslQueryContainer {
terms?: QueryDslTermsQuery
terms_set?: Partial<Record<Field, QueryDslTermsSetQuery>>
text_expansion?: Partial<Record<Field, QueryDslTextExpansionQuery>>
weighted_tokens?: Partial<Record<Field, QueryDslWeightedTokensQuery>>
wildcard?: Partial<Record<Field, QueryDslWildcardQuery | string>>
wrapper?: QueryDslWrapperQuery
type?: QueryDslTypeQuery
@ -6076,14 +6095,26 @@ export interface QueryDslTermsSetQuery extends QueryDslQueryBase {
export interface QueryDslTextExpansionQuery extends QueryDslQueryBase {
model_id: string
model_text: string
pruning_config?: QueryDslTokenPruningConfig
}
export type QueryDslTextQueryType = 'best_fields' | 'most_fields' | 'cross_fields' | 'phrase' | 'phrase_prefix' | 'bool_prefix'
export interface QueryDslTokenPruningConfig {
tokens_freq_ratio_threshold?: integer
tokens_weight_threshold?: float
only_score_pruned_tokens?: boolean
}
export interface QueryDslTypeQuery extends QueryDslQueryBase {
value: string
}
export interface QueryDslWeightedTokensQuery extends QueryDslQueryBase {
tokens: Record<string, float>
pruning_config?: QueryDslTokenPruningConfig
}
export interface QueryDslWildcardQuery extends QueryDslQueryBase {
case_insensitive?: boolean
rewrite?: MultiTermQueryRewrite
@ -6194,6 +6225,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
explain?: boolean
@ -9053,7 +9085,7 @@ export interface EnrichPolicy {
enrich_fields: Fields
indices: Indices
match_field: Field
query?: string
query?: QueryDslQueryContainer
name?: Name
elasticsearch_version?: string
}
@ -9218,6 +9250,21 @@ export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEven
export type EqlSearchResultPosition = 'tail' | 'head'
export interface EsqlQueryRequest extends RequestBase {
format?: string
delimiter?: string
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
columnar?: boolean
filter?: QueryDslQueryContainer
locale?: string
params?: ScalarValue[]
query: string
}
}
export type EsqlQueryResponse = EsqlColumns
export interface FeaturesFeature {
name: string
description: string
@ -9310,6 +9357,7 @@ export interface FleetSearchRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
collapse?: SearchFieldCollapse
explain?: boolean
@ -9648,7 +9696,7 @@ export interface IndicesDataStream {
generation: integer
hidden: boolean
ilm_policy?: Name
next_generation_managed_by: ManagedBy
next_generation_managed_by: IndicesManagedBy
prefer_ilm: boolean
indices: IndicesDataStreamIndex[]
lifecycle?: IndicesDataStreamLifecycleWithRollover
@ -9664,7 +9712,7 @@ export interface IndicesDataStreamIndex {
index_name: IndexName
index_uuid: Uuid
ilm_policy?: Name
managed_by: ManagedBy
managed_by: IndicesManagedBy
prefer_ilm: boolean
}
@ -9820,7 +9868,6 @@ export interface IndicesIndexSettingsKeys {
analysis?: IndicesIndexSettingsAnalysis
settings?: IndicesIndexSettings
time_series?: IndicesIndexSettingsTimeSeries
shards?: integer
queries?: IndicesQueries
similarity?: IndicesSettingsSimilarity
mapping?: IndicesMappingLimitSettings
@ -9913,6 +9960,8 @@ export interface IndicesIndexingSlowlogTresholds {
index?: IndicesSlowlogTresholdLevels
}
export type IndicesManagedBy = 'Index Lifecycle Management' | 'Data stream lifecycle' | 'Unmanaged'
export interface IndicesMappingLimitSettings {
coerce?: boolean
total_fields?: IndicesMappingLimitSettingsTotalFields
@ -10943,6 +10992,24 @@ export interface IndicesReloadSearchAnalyzersRequest extends RequestBase {
export type IndicesReloadSearchAnalyzersResponse = IndicesReloadSearchAnalyzersReloadResult
export interface IndicesResolveClusterRequest extends RequestBase {
name: Names
allow_no_indices?: boolean
expand_wildcards?: ExpandWildcards
ignore_throttled?: boolean
ignore_unavailable?: boolean
}
export interface IndicesResolveClusterResolveClusterInfo {
connected: boolean
skip_unavailable: boolean
matching_indices?: boolean
error?: string
version?: ElasticsearchVersionMinInfo
}
export type IndicesResolveClusterResponse = Record<ClusterAlias, IndicesResolveClusterResolveClusterInfo>
export interface IndicesResolveIndexRequest extends RequestBase {
name: Names
expand_wildcards?: ExpandWildcards
@ -11434,6 +11501,84 @@ export interface IndicesValidateQueryResponse {
error?: string
}
export type InferenceDenseByteVector = byte[]
export type InferenceDenseVector = float[]
export interface InferenceInferenceResult {
text_embedding_bytes?: InferenceTextEmbeddingByteResult[]
text_embedding?: InferenceTextEmbeddingResult[]
sparse_embedding?: InferenceSparseEmbeddingResult[]
}
export interface InferenceModelConfig {
service: string
service_settings: InferenceServiceSettings
task_settings: InferenceTaskSettings
}
export interface InferenceModelConfigContainer extends InferenceModelConfig {
model_id: string
task_type: InferenceTaskType
}
export type InferenceServiceSettings = any
export interface InferenceSparseEmbeddingResult {
embedding: InferenceSparseVector
}
export type InferenceSparseVector = Record<string, float>
export type InferenceTaskSettings = any
export type InferenceTaskType = 'sparse_embedding' | 'text_embedding'
export interface InferenceTextEmbeddingByteResult {
embedding: InferenceDenseByteVector
}
export interface InferenceTextEmbeddingResult {
embedding: InferenceDenseVector
}
export interface InferenceDeleteModelRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
}
export type InferenceDeleteModelResponse = AcknowledgedResponseBase
export interface InferenceGetModelRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
}
export interface InferenceGetModelResponse {
models: InferenceModelConfigContainer[]
}
export interface InferenceInferenceRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
input: string | string[]
task_settings?: InferenceTaskSettings
}
}
export type InferenceInferenceResponse = InferenceInferenceResult
export interface InferencePutModelRequest extends RequestBase {
task_type?: InferenceTaskType
inference_id: Id
/** @deprecated The use of the 'body' key has been deprecated, use 'model_config' instead. */
body?: InferenceModelConfig
}
export type InferencePutModelResponse = InferenceModelConfigContainer
export interface IngestAppendProcessor extends IngestProcessorBase {
field: Field
value: any[]
@ -11447,6 +11592,7 @@ export interface IngestAttachmentProcessor extends IngestProcessorBase {
indexed_chars_field?: Field
properties?: string[]
target_field?: Field
remove_binary?: boolean
resource_name?: string
}
@ -11627,6 +11773,7 @@ export interface IngestPipeline {
on_failure?: IngestProcessorContainer[]
processors?: IngestProcessorContainer[]
version?: VersionNumber
_meta: Metadata
}
export interface IngestPipelineConfig {
@ -11669,7 +11816,8 @@ export interface IngestProcessorContainer {
lowercase?: IngestLowercaseProcessor
remove?: IngestRemoveProcessor
rename?: IngestRenameProcessor
script?: Script
reroute?: IngestRerouteProcessor
script?: IngestScriptProcessor
set?: IngestSetProcessor
sort?: IngestSortProcessor
split?: IngestSplitProcessor
@ -11696,6 +11844,19 @@ export interface IngestRenameProcessor extends IngestProcessorBase {
target_field: Field
}
export interface IngestRerouteProcessor extends IngestProcessorBase {
destination?: string
dataset?: string | string[]
namespace?: string | string[]
}
export interface IngestScriptProcessor extends IngestProcessorBase {
id?: Id
lang?: string
params?: Record<string, any>
source?: string
}
export interface IngestSetProcessor extends IngestProcessorBase {
copy_from?: Field
field: Field
@ -13150,6 +13311,7 @@ export interface MlTrainedModelConfig {
metadata?: MlTrainedModelConfigMetadata
model_size_bytes?: ByteSize
location?: MlTrainedModelLocation
prefix_strings?: MlTrainedModelPrefixStrings
}
export interface MlTrainedModelConfigInput {
@ -13237,6 +13399,11 @@ export interface MlTrainedModelLocationIndex {
name: IndexName
}
export interface MlTrainedModelPrefixStrings {
ingest: string
search: string
}
export interface MlTrainedModelSizeStats {
model_size_bytes: ByteSize
required_native_memory_bytes: integer
@ -14098,6 +14265,7 @@ export interface MlPutDatafeedRequest extends RequestBase {
delayed_data_check_config?: MlDelayedDataCheckConfig
frequency?: Duration
indices?: Indices
/** @alias indices */
indexes?: Indices
indices_options?: IndicesOptions
job_id?: Id
@ -14462,6 +14630,7 @@ export interface MlUpdateDatafeedRequest extends RequestBase {
delayed_data_check_config?: MlDelayedDataCheckConfig
frequency?: Duration
indices?: string[]
/** @alias indices */
indexes?: string[]
indices_options?: IndicesOptions
job_id?: Id
@ -15166,9 +15335,13 @@ export interface NodesInfoNodeInfoClient {
type: string
}
export interface NodesInfoNodeInfoDiscover {
seed_hosts: string
export interface NodesInfoNodeInfoDiscoverKeys {
seed_hosts?: string[]
type?: string
seed_providers?: string[]
}
export type NodesInfoNodeInfoDiscover = NodesInfoNodeInfoDiscoverKeys
& { [property: string]: any }
export interface NodesInfoNodeInfoHttp {
bound_address: string[]
@ -15234,9 +15407,9 @@ export interface NodesInfoNodeInfoOSCPU {
}
export interface NodesInfoNodeInfoPath {
logs: string
home: string
repo: string[]
logs?: string
home?: string
repo?: string[]
data?: string[]
}
@ -15264,7 +15437,7 @@ export interface NodesInfoNodeInfoSearchRemote {
export interface NodesInfoNodeInfoSettings {
cluster: NodesInfoNodeInfoSettingsCluster
node: NodesInfoNodeInfoSettingsNode
path: NodesInfoNodeInfoPath
path?: NodesInfoNodeInfoPath
repositories?: NodesInfoNodeInfoRepositories
discovery?: NodesInfoNodeInfoDiscover
action?: NodesInfoNodeInfoAction
@ -15283,7 +15456,7 @@ export interface NodesInfoNodeInfoSettingsCluster {
name: Name
routing?: IndicesIndexRouting
election: NodesInfoNodeInfoSettingsClusterElection
initial_master_nodes?: string
initial_master_nodes?: string[]
deprecation_indexing?: NodesInfoDeprecationIndexing
}
@ -15757,6 +15930,7 @@ export interface RollupRollupSearchRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
aggregations?: Record<string, AggregationsAggregationContainer>
/** @alias aggregations */
aggs?: Record<string, AggregationsAggregationContainer>
query?: QueryDslQueryContainer
size?: integer
@ -15990,11 +16164,9 @@ export interface SecurityCreatedStatus {
}
export interface SecurityFieldRule {
username?: Name
username?: Names
dn?: Names
groups?: Names
metadata?: any
realm?: SecurityRealm
}
export interface SecurityFieldSecurity {
@ -16024,10 +16196,6 @@ export interface SecurityManageUserPrivileges {
applications: string[]
}
export interface SecurityRealm {
name: Name
}
export interface SecurityRealmInfo {
name: Name
type: string
@ -16060,7 +16228,7 @@ export interface SecurityRoleMapping {
metadata: Metadata
roles: string[]
rules: SecurityRoleMappingRule
role_templates?: SecurityGetRoleRoleTemplate[]
role_templates?: SecurityRoleTemplate[]
}
export interface SecurityRoleMappingRule {
@ -16070,6 +16238,11 @@ export interface SecurityRoleMappingRule {
except?: SecurityRoleMappingRule
}
export interface SecurityRoleTemplate {
format?: SecurityTemplateFormat
template: Script
}
export type SecurityRoleTemplateInlineQuery = string | QueryDslQueryContainer
export interface SecurityRoleTemplateInlineScript extends ScriptBase {
@ -16084,6 +16257,8 @@ export interface SecurityRoleTemplateQuery {
export type SecurityRoleTemplateScript = SecurityRoleTemplateInlineScript | SecurityRoleTemplateInlineQuery | StoredScriptId
export type SecurityTemplateFormat = 'string' | 'json'
export interface SecurityTransientMetadataConfig {
enabled: boolean
}
@ -16383,6 +16558,7 @@ export interface SecurityGetApiKeyRequest extends RequestBase {
realm_name?: Name
username?: Username
with_limited_by?: boolean
active_only?: boolean
}
export interface SecurityGetApiKeyResponse {
@ -16417,17 +16593,10 @@ export interface SecurityGetRoleRole {
run_as: string[]
transient_metadata: SecurityTransientMetadataConfig
applications: SecurityApplicationPrivileges[]
role_templates?: SecurityGetRoleRoleTemplate[]
role_templates?: SecurityRoleTemplate[]
global?: Record<string, Record<string, Record<string, string[]>>>
}
export interface SecurityGetRoleRoleTemplate {
format?: SecurityGetRoleTemplateFormat
template: Script
}
export type SecurityGetRoleTemplateFormat = 'string' | 'json'
export interface SecurityGetRoleMappingRequest extends RequestBase {
name?: Names
}
@ -16710,6 +16879,7 @@ export interface SecurityPutRoleMappingRequest extends RequestBase {
enabled?: boolean
metadata?: Metadata
roles?: string[]
role_templates?: SecurityRoleTemplate[]
rules?: SecurityRoleMappingRule
run_as?: string[]
}
@ -16869,6 +17039,7 @@ export interface SecurityUpdateApiKeyRequest extends RequestBase {
body?: {
role_descriptors?: Record<string, SecurityRoleDescriptor>
metadata?: Metadata
expiration?: Duration
}
}
@ -17588,7 +17759,7 @@ export interface SynonymsPutSynonymRuleRequest extends RequestBase {
rule_id: Id
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
synonyms: SynonymsSynonymString[]
synonyms: SynonymsSynonymString
}
}
@ -17687,6 +17858,7 @@ export interface TextStructureFindStructureRequest<TJsonDocument = unknown> {
charset?: string
column_names?: string
delimiter?: string
ecs_compatibility?: string
explain?: boolean
format?: string
grok_pattern?: string
@ -17732,6 +17904,30 @@ export interface TextStructureFindStructureTopHit {
value: any
}
export interface TextStructureTestGrokPatternMatchedField {
match: string
offset: integer
length: integer
}
export interface TextStructureTestGrokPatternMatchedText {
matched: boolean
fields?: Record<string, TextStructureTestGrokPatternMatchedField[]>
}
export interface TextStructureTestGrokPatternRequest extends RequestBase {
ecs_compatibility?: string
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
grok_pattern: string
text: string[]
}
}
export interface TextStructureTestGrokPatternResponse {
matches: TextStructureTestGrokPatternMatchedText[]
}
export interface TransformDestination {
index?: IndexName
pipeline?: string