Compare commits

...

5 Commits

Author SHA1 Message Date
2cc0fd4df9 API generation 2022-05-03 19:40:27 +02:00
603e4695cb [Backport 8.2] Updated dependencies (#1685)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-05-03 19:32:19 +02:00
2c6e0ddb62 API generation 2022-05-03 19:18:55 +02:00
de27dd9697 [Backport 8.2] Update TypeScript docs and export estypes (#1676)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-04-12 10:34:56 +02:00
295553c249 [Backport 8.2] Drop Node.js v12 (#1671)
Co-authored-by: Tomas Della Vedova <delvedor@users.noreply.github.com>
2022-03-31 09:38:19 +02:00
21 changed files with 761 additions and 244 deletions

View File

@ -2,9 +2,9 @@
source /usr/local/bin/bash_standard_lib.sh
DOCKER_IMAGES="node:16-alpine
DOCKER_IMAGES="node:17-alpine
node:16-alpine
node:14-alpine
node:12-alpine
"
for di in ${DOCKER_IMAGES}

View File

@ -9,7 +9,7 @@ script_path=$(dirname $(realpath -s $0))
source $script_path/functions/imports.sh
set -euo pipefail
NODE_JS_VERSION=${NODE_JS_VERSION-12}
NODE_JS_VERSION=${NODE_JS_VERSION-16}
ELASTICSEARCH_URL=${ELASTICSEARCH_URL-"$elasticsearch_url"}
elasticsearch_container=${elasticsearch_container-}

View File

@ -3,9 +3,9 @@ STACK_VERSION:
- 8.2.0-SNAPSHOT
NODE_JS_VERSION:
- 18
- 16
- 14
- 12
TEST_SUITE:
- free

View File

@ -51,5 +51,6 @@ Paste the results here:
- *node version*: 6,8,10
- `@elastic/elasticsearch` *version*: >=7.0.0
- *typescript version*: 4.x (if applicable)
- *os*: Mac, Windows, Linux
- *any other relevant information*

View File

@ -9,7 +9,7 @@ jobs:
strategy:
matrix:
node-version: [12.x, 14.x, 16.x]
node-version: [14.x, 16.x, 18.x]
os: [ubuntu-latest, windows-latest, macOS-latest]
steps:
@ -176,7 +176,7 @@ jobs:
strategy:
matrix:
node-version: [14.x]
node-version: [16.x]
steps:
- uses: actions/checkout@v2

View File

@ -22,7 +22,7 @@ npm install @elastic/elasticsearch
### Node.js support
NOTE: The minimum supported version of Node.js is `v12`.
NOTE: The minimum supported version of Node.js is `v14`.
The client versioning follows the Elastic Stack versioning, this means that
major, minor, and patch releases are done following a precise schedule that
@ -44,8 +44,9 @@ of `^7.10.0`).
| Node.js Version | Node.js EOL date | End of support |
| --------------- |------------------| ---------------------- |
| `8.x` | `December 2019` | `7.11` (early 2021) |
| `10.x` | `April 2021` | `7.12` (mid 2021) |
| `12.x` | `April 2022` | `8.2` (early 2022) |
| `10.x` | `April 2021` | `7.12` (mid 2021) |
| `12.x` | `April 2022` | `8.2` (early 2022) |
| `14.x` | `April 2023` | `8.8` (early 2023) |
### Compatibility

View File

@ -24,7 +24,7 @@ To learn more about the supported major versions, please refer to the
[[nodejs-support]]
=== Node.js support
NOTE: The minimum supported version of Node.js is `v12`.
NOTE: The minimum supported version of Node.js is `v14`.
The client versioning follows the {stack} versioning, this means that
major, minor, and patch releases are done following a precise schedule that
@ -60,6 +60,10 @@ of `^7.10.0`).
|`12.x`
|April 2022
|`8.2` (early 2022)
|`14.x`
|April 2023
|`8.8` (early 2023)
|===
[discrete]

View File

@ -7,6 +7,10 @@ of type definitions of Elasticsearch's API surface.
The types are not 100% complete yet. Some APIs are missing (the newest ones, e.g. EQL),
and others may contain some errors, but we are continuously pushing fixes & improvements.
NOTE: The client is developed against the https://www.npmjs.com/package/typescript?activeTab=versions[latest]
version of TypeScript. Furthermore, unless you have set `skipLibCheck` to `true`,
you should configure `esModuleInterop` to `true`.
[discrete]
==== Example
@ -77,3 +81,10 @@ You can import the full TypeScript requests & responses definitions as it follow
----
import { estypes } from '@elastic/elasticsearch'
----
If you need the legacy definitions with the body, you can do the following:
[source,ts]
----
import { estypesWithBody } from '@elastic/elasticsearch'
----

2
index.d.ts vendored
View File

@ -21,5 +21,7 @@ import Client from './lib/client'
import SniffingTransport from './lib/sniffingTransport'
export * from '@elastic/transport'
export * as estypes from './lib/api/types'
export * as estypesWithBody from './lib/api/types'
export { Client, SniffingTransport }
export type { ClientOptions, NodeOptions } from './lib/client'

View File

@ -45,43 +45,42 @@
},
"homepage": "http://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current/index.html",
"engines": {
"node": ">=12"
"node": ">=14"
},
"devDependencies": {
"@sinonjs/fake-timers": "github:sinonjs/fake-timers#0bfffc1",
"@types/debug": "^4.1.6",
"@types/debug": "^4.1.7",
"@types/ms": "^0.7.31",
"@types/node": "^16.4.1",
"@types/sinonjs__fake-timers": "^6.0.3",
"@types/node": "^17.0.31",
"@types/sinonjs__fake-timers": "^8.1.2",
"@types/split2": "^3.2.1",
"@types/stoppable": "^1.1.1",
"@types/tap": "^15.0.5",
"@types/tap": "^15.0.7",
"cross-zip": "^4.0.0",
"fast-deep-equal": "^3.1.3",
"into-stream": "^6.0.0",
"into-stream": "^7.0.0",
"js-yaml": "^4.1.0",
"license-checker": "^25.0.1",
"minimist": "^1.2.5",
"minimist": "^1.2.6",
"ms": "^2.1.3",
"node-abort-controller": "^2.0.0",
"node-fetch": "^2.6.2",
"ora": "^5.4.1",
"node-abort-controller": "^3.0.1",
"node-fetch": "^2.6.7",
"ora": "^6.1.0",
"proxy": "^1.0.2",
"rimraf": "^3.0.2",
"semver": "^7.3.5",
"split2": "^3.2.2",
"standard": "^16.0.3",
"semver": "^7.3.7",
"split2": "^4.1.0",
"stoppable": "^1.1.0",
"tap": "^15.0.9",
"ts-node": "^10.1.0",
"ts-standard": "^10.0.0",
"typescript": "^4.3.5",
"tap": "^16.1.0",
"ts-node": "^10.7.0",
"ts-standard": "^11.0.0",
"typescript": "^4.6.4",
"workq": "^3.0.0",
"xmlbuilder2": "^3.0.2"
},
"dependencies": {
"@elastic/transport": "^8.0.2",
"tslib": "^2.3.0"
"@elastic/transport": "^8.2.0",
"tslib": "^2.4.0"
},
"tap": {
"ts": true,

View File

@ -68,5 +68,5 @@ export default async function BulkApi<TDocument = unknown, TPartialDocument = un
method = 'POST'
path = '/_bulk'
}
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}

View File

@ -96,7 +96,7 @@ export default class Fleet {
method = body != null ? 'POST' : 'GET'
path = '/_fleet/_fleet_msearch'
}
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}
async search<TDocument = unknown> (this: That, params: T.FleetSearchRequest | TB.FleetSearchRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.FleetSearchResponse<TDocument>>

View File

@ -860,19 +860,31 @@ export default class Indices {
return await this.transport.request({ path, method, querystring, body }, options)
}
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async modifyDataStream (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.IndicesModifyDataStreamResponse>
async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.IndicesModifyDataStreamResponse, unknown>>
async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptions): Promise<T.IndicesModifyDataStreamResponse>
async modifyDataStream (this: That, params: T.IndicesModifyDataStreamRequest | TB.IndicesModifyDataStreamRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const acceptedBody: string[] = ['actions']
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]
}
}

View File

@ -1163,7 +1163,7 @@ export default class Ml {
async inferTrainedModelDeployment (this: That, params: T.MlInferTrainedModelDeploymentRequest | TB.MlInferTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<T.MlInferTrainedModelDeploymentResponse>
async inferTrainedModelDeployment (this: That, params: T.MlInferTrainedModelDeploymentRequest | TB.MlInferTrainedModelDeploymentRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['model_id']
const acceptedBody: string[] = ['docs']
const acceptedBody: string[] = ['docs', 'inference_config']
const querystring: Record<string, any> = {}
// @ts-expect-error
const userBody: any = params?.body
@ -1307,7 +1307,7 @@ export default class Ml {
const method = 'POST'
const path = `/_ml/anomaly_detectors/${encodeURIComponent(params.job_id.toString())}/_data`
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}
async previewDataFrameAnalytics (this: That, params?: T.MlPreviewDataFrameAnalyticsRequest | TB.MlPreviewDataFrameAnalyticsRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.MlPreviewDataFrameAnalyticsResponse>

View File

@ -67,6 +67,6 @@ export default class Monitoring {
const method = 'POST'
const path = '/_monitoring/bulk'
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}
}

View File

@ -68,5 +68,5 @@ export default async function MsearchApi<TDocument = unknown, TAggregations = Re
method = body != null ? 'POST' : 'GET'
path = '/_msearch'
}
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}

View File

@ -68,5 +68,5 @@ export default async function MsearchTemplateApi<TDocument = unknown, TAggregati
method = body != null ? 'POST' : 'GET'
path = '/_msearch/template'
}
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}

View File

@ -43,19 +43,31 @@ export default class Security {
this.transport = transport
}
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async activateUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityActivateUserProfileResponse>
async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityActivateUserProfileResponse, unknown>>
async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityActivateUserProfileResponse>
async activateUserProfile (this: That, params: T.SecurityActivateUserProfileRequest | TB.SecurityActivateUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const acceptedBody: string[] = ['access_token', 'grant_type', 'password', 'username']
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]
}
}
@ -436,19 +448,19 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options)
}
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async disableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityDisableUserProfileResponse>
async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityDisableUserProfileResponse, unknown>>
async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityDisableUserProfileResponse>
async disableUserProfile (this: That, params: T.SecurityDisableUserProfileRequest | TB.SecurityDisableUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid']
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
@ -480,19 +492,19 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options)
}
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async enableUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityEnableUserProfileResponse>
async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityEnableUserProfileResponse, unknown>>
async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityEnableUserProfileResponse>
async enableUserProfile (this: That, params: T.SecurityEnableUserProfileRequest | TB.SecurityEnableUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid']
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
@ -830,19 +842,19 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options)
}
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async getUserProfile (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityGetUserProfileResponse>
async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityGetUserProfileResponse, unknown>>
async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<T.SecurityGetUserProfileResponse>
async getUserProfile (this: That, params: T.SecurityGetUserProfileRequest | TB.SecurityGetUserProfileRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid']
const querystring: Record<string, any> = {}
const body = undefined
params = params ?? {}
for (const key in params) {
if (acceptedPath.includes(key)) {
continue
} else if (key !== 'body') {
// @ts-expect-error
querystring[key] = params[key]
}
}
@ -1421,41 +1433,66 @@ export default class Security {
return await this.transport.request({ path, method, querystring, body }, options)
}
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async searchUserProfiles (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecuritySuggestUserProfilesResponse>
async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecuritySuggestUserProfilesResponse, unknown>>
async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<T.SecuritySuggestUserProfilesResponse>
async suggestUserProfiles (this: That, params?: T.SecuritySuggestUserProfilesRequest | TB.SecuritySuggestUserProfilesRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = []
const acceptedBody: string[] = ['name', 'size']
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]
}
}
const method = body != null ? 'POST' : 'GET'
const path = '/_security/profile/_search'
const path = '/_security/profile/_suggest'
return await this.transport.request({ path, method, querystring, body }, options)
}
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithOutMeta): Promise<T.TODO>
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.TODO, unknown>>
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<T.TODO>
async updateUserProfileData (this: That, params?: T.TODO | TB.TODO, options?: TransportRequestOptions): Promise<any> {
async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithOutMeta): Promise<T.SecurityUpdateUserProfileDataResponse>
async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptionsWithMeta): Promise<TransportResult<T.SecurityUpdateUserProfileDataResponse, unknown>>
async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise<T.SecurityUpdateUserProfileDataResponse>
async updateUserProfileData (this: That, params: T.SecurityUpdateUserProfileDataRequest | TB.SecurityUpdateUserProfileDataRequest, options?: TransportRequestOptions): Promise<any> {
const acceptedPath: string[] = ['uid']
const acceptedBody: string[] = ['access', 'data']
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]
}
}

View File

@ -67,6 +67,6 @@ export default class TextStructure {
const method = 'POST'
const path = '/_text_structure/find_structure'
return await this.transport.request({ path, method, querystring, bulkBody: body }, options)
return await this.transport.request({ path, method, querystring, body }, options)
}
}

View File

@ -241,7 +241,7 @@ export interface DeleteByQueryRethrottleRequest extends RequestBase {
requests_per_second?: long
}
export type DeleteByQueryRethrottleResponse = TasksListResponse
export type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
export interface DeleteScriptRequest extends RequestBase {
id: Id
@ -1088,12 +1088,13 @@ export interface SearchCompletionSuggestOption<TDocument = unknown> {
collate_match?: boolean
contexts?: Record<string, SearchContext[]>
fields?: Record<string, any>
_id: string
_index: IndexName
_id?: string
_index?: IndexName
_routing?: Routing
_score?: double
_source?: TDocument
text: string
score?: double
}
export interface SearchCompletionSuggester extends SearchSuggesterBase {
@ -1153,9 +1154,9 @@ export interface SearchFieldCollapse {
export interface SearchFieldSuggester {
completion?: SearchCompletionSuggester
phrase?: SearchPhraseSuggester
term?: SearchTermSuggester
prefix?: string
regex?: string
term?: SearchTermSuggester
text?: string
}
@ -2516,6 +2517,7 @@ export interface AggregationsAggregationContainer {
geohash_grid?: AggregationsGeoHashGridAggregation
geo_line?: AggregationsGeoLineAggregation
geotile_grid?: AggregationsGeoTileGridAggregation
geohex_grid?: AggregationsGeohexGridAggregation
global?: AggregationsGlobalAggregation
histogram?: AggregationsHistogramAggregation
ip_range?: AggregationsIpRangeAggregation
@ -2713,14 +2715,6 @@ export interface AggregationsChildrenAggregation extends AggregationsBucketAggre
type?: RelationName
}
export interface AggregationsClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase<AggregationsCompositeBucket> {
after_key?: Record<string, any>
}
@ -2989,6 +2983,14 @@ export interface AggregationsGeoTileGridBucketKeys extends AggregationsMultiBuck
export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys
& { [property: string]: AggregationsAggregate | GeoTile | long }
export interface AggregationsGeohexGridAggregation extends AggregationsBucketAggregationBase {
field: Field
precision?: integer
bounds?: GeoBounds
size?: integer
shard_size?: integer
}
export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase {
}
export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys
@ -3086,8 +3088,8 @@ export interface AggregationsInferenceClassImportance {
}
export interface AggregationsInferenceConfigContainer {
regression?: AggregationsRegressionInferenceOptions
classification?: AggregationsClassificationInferenceOptions
regression?: MlRegressionInferenceOptions
classification?: MlClassificationInferenceOptions
}
export interface AggregationsInferenceFeatureImportance {
@ -3377,11 +3379,6 @@ export interface AggregationsRateAggregation extends AggregationsFormatMetricAgg
export type AggregationsRateMode = 'sum' | 'value_count'
export interface AggregationsRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase {
}
export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys
@ -3448,7 +3445,8 @@ export interface AggregationsSignificantTermsAggregation extends AggregationsBuc
execution_hint?: AggregationsTermsAggregationExecutionHint
field?: Field
gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[]
include?: AggregationsTermsInclude
jlh?: EmptyObject
min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic
@ -3472,6 +3470,7 @@ export interface AggregationsSignificantTextAggregation extends AggregationsBuck
filter_duplicate_text?: boolean
gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[]
jlh?: EmptyObject
min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic
@ -4477,7 +4476,7 @@ export interface MappingDenseVectorProperty extends MappingPropertyBase {
index_options?: MappingDenseVectorIndexOptions
}
export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingGenericProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty
export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty
export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase {
doc_values?: boolean
@ -4542,21 +4541,6 @@ export interface MappingFloatRangeProperty extends MappingRangePropertyBase {
type: 'float_range'
}
export interface MappingGenericProperty extends MappingDocValuesPropertyBase {
analyzer: string
boost: double
fielddata: IndicesStringFielddata
ignore_malformed: boolean
index: boolean
index_options: MappingIndexOptions
norms: boolean
null_value: string
position_increment_gap: integer
search_analyzer: string
term_vector: MappingTermVectorOption
type: string
}
export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw'
export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase {
@ -4901,7 +4885,7 @@ export interface QueryDslConstantScoreQuery extends QueryDslQueryBase {
export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase {
}
export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode | QueryDslQueryContainer | double }
& { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode }
export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<DateMath, Time> {
}
@ -4919,7 +4903,7 @@ export interface QueryDslDateRangeQuery extends QueryDslRangeQueryBase {
export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction
export interface QueryDslDecayFunctionBase extends QueryDslScoreFunctionBase {
export interface QueryDslDecayFunctionBase {
multi_value_mode?: QueryDslMultiValueMode
}
@ -4962,7 +4946,7 @@ export interface QueryDslFieldLookup {
export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'
export interface QueryDslFieldValueFactorScoreFunction extends QueryDslScoreFunctionBase {
export interface QueryDslFieldValueFactorScoreFunction {
field: Field
factor?: double
missing?: double
@ -5013,7 +4997,7 @@ export type QueryDslGeoBoundingBoxQuery = QueryDslGeoBoundingBoxQueryKeys
export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase {
}
export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode | QueryDslQueryContainer | double }
& { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode }
export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<GeoLocation, Distance> {
}
@ -5279,7 +5263,7 @@ export interface QueryDslNumberRangeQuery extends QueryDslRangeQueryBase {
export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase {
}
export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode | QueryDslQueryContainer | double }
& { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode }
export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR'
@ -5409,7 +5393,7 @@ export interface QueryDslQueryStringQuery extends QueryDslQueryBase {
type?: QueryDslTextQueryType
}
export interface QueryDslRandomScoreFunction extends QueryDslScoreFunctionBase {
export interface QueryDslRandomScoreFunction {
field?: Field
seed?: long | string
}
@ -5457,16 +5441,11 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase {
value: string
}
export interface QueryDslScoreFunctionBase {
filter?: QueryDslQueryContainer
weight?: double
}
export interface QueryDslScriptQuery extends QueryDslQueryBase {
script: Script
}
export interface QueryDslScriptScoreFunction extends QueryDslScoreFunctionBase {
export interface QueryDslScriptScoreFunction {
script: Script
}
@ -5655,8 +5634,7 @@ export interface AsyncSearchGetRequest extends RequestBase {
wait_for_completion_timeout?: Time
}
export interface AsyncSearchGetResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> {
}
export type AsyncSearchGetResponse<TDocument = unknown, AsyncSearchTAggregations = unknown> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, AsyncSearchTAggregations>
export interface AsyncSearchStatusRequest extends RequestBase {
id: Id
@ -5736,8 +5714,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
runtime_mappings?: MappingRuntimeFields
}
export interface AsyncSearchSubmitResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> {
}
export type AsyncSearchSubmitResponse<TDocument = unknown, AsyncSearchTAggregations = unknown> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, AsyncSearchTAggregations>
export interface AutoscalingAutoscalingPolicy {
roles: string[]
@ -8610,8 +8587,7 @@ export interface EqlGetRequest extends RequestBase {
wait_for_completion_timeout?: Time
}
export interface EqlGetResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> {
}
export type EqlGetResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
export interface EqlGetStatusRequest extends RequestBase {
id: Id
@ -8647,8 +8623,7 @@ export interface EqlSearchRequest extends RequestBase {
runtime_mappings?: MappingRuntimeFields
}
export interface EqlSearchResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> {
}
export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
export type EqlSearchResultPosition = 'tail' | 'head'
@ -9273,6 +9248,7 @@ export interface IndicesMappingLimitSettings {
nested_objects?: IndicesMappingLimitSettingsNestedObjects
field_name_length?: IndicesMappingLimitSettingsFieldNameLength
dimension_fields?: IndicesMappingLimitSettingsDimensionFields
ignore_malformed?: boolean
}
export interface IndicesMappingLimitSettingsDepth {
@ -9430,13 +9406,7 @@ export interface IndicesStorage {
allow_mmap?: boolean
}
export type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs'
export interface IndicesStringFielddata {
format: IndicesStringFielddataFormat
}
export type IndicesStringFielddataFormat = 'paged_bytes' | 'disabled'
export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'
export interface IndicesTemplateMapping {
aliases: Record<IndexName, IndicesAlias>
@ -9454,7 +9424,7 @@ export interface IndicesTranslog {
retention?: IndicesTranslogRetention
}
export type IndicesTranslogDurability = 'request' | 'async'
export type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC'
export interface IndicesTranslogRetention {
size?: ByteSize
@ -9615,7 +9585,7 @@ export interface IndicesCreateRequest extends RequestBase {
export interface IndicesCreateResponse {
index: IndexName
shards_acknowledged: boolean
acknowledged?: boolean
acknowledged: boolean
}
export interface IndicesCreateDataStreamRequest extends RequestBase {
@ -9941,6 +9911,22 @@ export interface IndicesMigrateToDataStreamRequest extends RequestBase {
export type IndicesMigrateToDataStreamResponse = AcknowledgedResponseBase
export interface IndicesModifyDataStreamAction {
add_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
remove_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
}
export interface IndicesModifyDataStreamIndexAndDataStreamAction {
index: IndexName
data_stream: DataStreamName
}
export interface IndicesModifyDataStreamRequest extends RequestBase {
actions: IndicesModifyDataStreamAction[]
}
export type IndicesModifyDataStreamResponse = AcknowledgedResponseBase
export interface IndicesOpenRequest extends RequestBase {
index: Indices
allow_no_indices?: boolean
@ -10761,10 +10747,20 @@ export interface IngestGsubProcessor extends IngestProcessorBase {
export interface IngestInferenceConfig {
regression?: IngestInferenceConfigRegression
classification?: IngestInferenceConfigClassification
}
export interface IngestInferenceConfigClassification {
num_top_classes?: integer
num_top_feature_importance_values?: integer
results_field?: Field
top_classes_results_field?: Field
prediction_field_type?: string
}
export interface IngestInferenceConfigRegression {
results_field: string
results_field?: Field
num_top_feature_importance_values?: integer
}
export interface IngestInferenceProcessor extends IngestProcessorBase {
@ -11381,6 +11377,14 @@ export interface MlChunkingConfig {
export type MlChunkingMode = 'auto' | 'manual' | 'off'
export interface MlClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte'
export type MlCustomSettings = any
@ -11771,6 +11775,18 @@ export interface MlDiscoveryNode {
export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over'
export interface MlFillMaskInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlFillMaskInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlFilter {
description?: string
filter_id: Id
@ -11811,6 +11827,17 @@ export interface MlHyperparameters {
export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance'
export interface MlInferenceConfigCreateContainer {
regression?: MlRegressionInferenceOptions
classification?: MlClassificationInferenceOptions
text_classification?: MlTextClassificationInferenceOptions
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
fill_mask?: MlFillMaskInferenceOptions
ner?: MlNerInferenceOptions
pass_through?: MlPassThroughInferenceOptions
text_embedding?: MlTextEmbeddingInferenceOptions
}
export interface MlInfluence {
influencer_field_name: string
influencer_field_values: string[]
@ -11970,6 +11997,47 @@ export interface MlModelSnapshot {
timestamp: long
}
export interface MlNerInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlNerInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlNlpBertTokenizationConfig {
do_lower_case?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpInferenceConfigUpdateContainer {
text_classification?: MlTextClassificationInferenceUpdateOptions
zero_shot_classification?: MlZeroShotClassificationInferenceUpdateOptions
fill_mask?: MlFillMaskInferenceUpdateOptions
ner?: MlNerInferenceUpdateOptions
pass_through?: MlPassThroughInferenceUpdateOptions
text_embedding?: MlTextEmbeddingInferenceUpdateOptions
}
export interface MlNlpRobertaTokenizationConfig {
add_prefix_space?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpTokenizationUpdateOptions {
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlOutlierDetectionParameters {
compute_feature_influence?: boolean
feature_influence_threshold?: double
@ -11998,6 +12066,16 @@ export interface MlPage {
size?: integer
}
export interface MlPassThroughInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlPassThroughInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlPerPartitionCategorization {
enabled?: boolean
stop_on_warn?: boolean
@ -12005,6 +12083,11 @@ export interface MlPerPartitionCategorization {
export type MlPredictedValue = string | double
export interface MlRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping'
export type MlRuleAction = 'skip_result' | 'skip_model_update'
@ -12020,11 +12103,43 @@ export interface MlRunningStateSearchInterval {
start_ms: long
}
export interface MlTextClassificationInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlTextClassificationInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
classification_labels?: string[]
}
export interface MlTextEmbeddingInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlTextEmbeddingInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlTimingStats {
elapsed_time: integer
iteration_time?: integer
}
export interface MlTokenizationConfigContainer {
bert?: MlNlpBertTokenizationConfig
mpnet?: MlNlpBertTokenizationConfig
roberta?: MlNlpRobertaTokenizationConfig
}
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
export interface MlTopClassEntry {
class_name: string
class_probability: double
@ -12077,7 +12192,7 @@ export interface MlTrainedModelConfig {
description?: string
estimated_heap_memory_usage_bytes?: integer
estimated_operations?: integer
inference_config: AggregationsInferenceConfigContainer
inference_config: MlInferenceConfigCreateContainer
input: MlTrainedModelConfigInput
license_level?: string
metadata?: MlTrainedModelConfigMetadata
@ -12178,6 +12293,22 @@ export interface MlValidationLoss {
loss_type: string
}
export interface MlZeroShotClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
hypothesis_template?: string
classification_labels: string[]
results_field?: string
multi_label?: boolean
labels?: string[]
}
export interface MlZeroShotClassificationInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
multi_label?: boolean
labels: string[]
}
export interface MlCloseJobRequest extends RequestBase {
job_id: Id
allow_no_match?: boolean
@ -12590,42 +12721,43 @@ export interface MlGetJobsResponse {
}
export interface MlGetMemoryStatsJvmStats {
heap_max: ByteSize
heap_max?: ByteSize
heap_max_in_bytes: integer
java_inference: ByteSize
java_inference?: ByteSize
java_inference_in_bytes: integer
java_inference_max: ByteSize
java_inference_max?: ByteSize
java_inference_max_in_bytes: integer
}
export interface MlGetMemoryStatsMemMlStats {
anomaly_detectors: ByteSize
anomaly_detectors?: ByteSize
anomaly_detectors_in_bytes: integer
data_frame_analytics: ByteSize
data_frame_analytics?: ByteSize
data_frame_analytics_in_bytes: integer
max: ByteSize
max?: ByteSize
max_in_bytes: integer
native_code_overhead: ByteSize
native_code_overhead?: ByteSize
native_code_overhead_in_bytes: integer
native_inference: ByteSize
native_inference?: ByteSize
native_inference_in_bytes: integer
}
export interface MlGetMemoryStatsMemStats {
adjusted_total: ByteSize
adjusted_total?: ByteSize
adjusted_total_in_bytes: integer
total: ByteSize
total?: ByteSize
total_in_bytes: integer
ml: MlGetMemoryStatsMemMlStats
}
export interface MlGetMemoryStatsMemory {
attributes: string[]
attributes: Record<string, string>
jvm: MlGetMemoryStatsJvmStats
mem: MlGetMemoryStatsMemStats
name: Name
roles: string[]
transport_address: TransportAddress
ephemeral_id: Id
}
export interface MlGetMemoryStatsRequest extends RequestBase {
@ -12637,7 +12769,7 @@ export interface MlGetMemoryStatsRequest extends RequestBase {
export interface MlGetMemoryStatsResponse {
_nodes: NodeStatistics
cluser_name: Name
cluster_name: Name
nodes: Record<Id, MlGetMemoryStatsMemory>
}
@ -12724,6 +12856,7 @@ export interface MlInferTrainedModelDeploymentRequest extends RequestBase {
model_id: Id
timeout?: Time
docs: Record<string, string>[]
inference_config?: MlNlpInferenceConfigUpdateContainer
}
export interface MlInferTrainedModelDeploymentResponse {
@ -13036,7 +13169,7 @@ export interface MlPutTrainedModelRequest extends RequestBase {
compressed_definition?: string
definition?: MlPutTrainedModelDefinition
description?: string
inference_config: AggregationsInferenceConfigContainer
inference_config: MlInferenceConfigCreateContainer
input: MlPutTrainedModelInput
metadata?: any
model_type?: MlTrainedModelType
@ -14579,6 +14712,8 @@ export interface SecurityGlobalPrivilege {
application: SecurityApplicationGlobalUserPrivileges
}
export type SecurityGrantType = 'password' | 'access_token'
export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write'
export interface SecurityIndicesPrivileges {
@ -14642,6 +14777,41 @@ export interface SecurityUser {
enabled: boolean
}
export interface SecurityUserProfile {
uid: string
user: SecurityUserProfileUser
data?: Record<string, any>
labels?: Record<string, any>
enabled?: boolean
}
export interface SecurityUserProfileHitMetadata {
_primary_term: long
_seq_no: SequenceNumber
}
export interface SecurityUserProfileUser {
email?: string | null
full_name?: Name | null
metadata: Metadata
roles: string[]
username: Username
}
export interface SecurityUserProfileWithMetadata extends SecurityUserProfile {
last_synchronized: long
_doc?: SecurityUserProfileHitMetadata
}
export interface SecurityActivateUserProfileRequest extends RequestBase {
access_token?: string
grant_type: SecurityGrantType
password?: string
username?: string
}
export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata
export interface SecurityAuthenticateRequest extends RequestBase {
}
@ -14828,6 +14998,13 @@ export interface SecurityDisableUserRequest extends RequestBase {
export interface SecurityDisableUserResponse {
}
export interface SecurityDisableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityDisableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnableUserRequest extends RequestBase {
username: Username
refresh?: Refresh
@ -14836,6 +15013,13 @@ export interface SecurityEnableUserRequest extends RequestBase {
export interface SecurityEnableUserResponse {
}
export interface SecurityEnableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityEnableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnrollKibanaRequest extends RequestBase {
}
@ -15018,6 +15202,13 @@ export interface SecurityGetUserPrivilegesResponse {
run_as: string[]
}
export interface SecurityGetUserProfileRequest extends RequestBase {
uid: string
data?: string | string[]
}
export type SecurityGetUserProfileResponse = Record<string, SecurityUserProfileWithMetadata>
export type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password'
export interface SecurityGrantApiKeyGrantApiKey {
@ -15243,6 +15434,34 @@ export interface SecuritySamlServiceProviderMetadataResponse {
metadata: string
}
export interface SecuritySuggestUserProfilesRequest extends RequestBase {
data?: string | string[]
name?: string
size?: long
}
export interface SecuritySuggestUserProfilesResponse {
total: SecuritySuggestUserProfilesTotalUserProfiles
took: long
profiles: SecurityUserProfile[]
}
export interface SecuritySuggestUserProfilesTotalUserProfiles {
value: long
relation: RelationName
}
export interface SecurityUpdateUserProfileDataRequest extends RequestBase {
uid: string
if_seq_no?: SequenceNumber
if_primary_term?: long
refresh?: Refresh
access?: Record<string, any>
data?: Record<string, any>
}
export type SecurityUpdateUserProfileDataResponse = AcknowledgedResponseBase
export interface ShutdownDeleteNodeRequest extends RequestBase {
node_id: NodeId
}
@ -15664,7 +15883,7 @@ export interface SnapshotRestoreRequest extends RequestBase {
ignore_unavailable?: boolean
include_aliases?: boolean
include_global_state?: boolean
index_settings?: IndicesPutSettingsRequest
index_settings?: IndicesIndexSettings
indices?: Indices
partial?: boolean
rename_pattern?: string
@ -16202,7 +16421,7 @@ export interface TransformUpdateTransformRequest extends RequestBase {
source?: TransformSource
settings?: TransformSettings
sync?: TransformSyncContainer
retention_policy?: TransformRetentionPolicyContainer
retention_policy?: TransformRetentionPolicyContainer | null
}
export interface TransformUpdateTransformResponse {

View File

@ -257,7 +257,7 @@ export interface DeleteByQueryRethrottleRequest extends RequestBase {
requests_per_second?: long
}
export type DeleteByQueryRethrottleResponse = TasksListResponse
export type DeleteByQueryRethrottleResponse = TasksTaskListResponseBase
export interface DeleteScriptRequest extends RequestBase {
id: Id
@ -1160,12 +1160,13 @@ export interface SearchCompletionSuggestOption<TDocument = unknown> {
collate_match?: boolean
contexts?: Record<string, SearchContext[]>
fields?: Record<string, any>
_id: string
_index: IndexName
_id?: string
_index?: IndexName
_routing?: Routing
_score?: double
_source?: TDocument
text: string
score?: double
}
export interface SearchCompletionSuggester extends SearchSuggesterBase {
@ -1225,9 +1226,9 @@ export interface SearchFieldCollapse {
export interface SearchFieldSuggester {
completion?: SearchCompletionSuggester
phrase?: SearchPhraseSuggester
term?: SearchTermSuggester
prefix?: string
regex?: string
term?: SearchTermSuggester
text?: string
}
@ -2616,6 +2617,7 @@ export interface AggregationsAggregationContainer {
geohash_grid?: AggregationsGeoHashGridAggregation
geo_line?: AggregationsGeoLineAggregation
geotile_grid?: AggregationsGeoTileGridAggregation
geohex_grid?: AggregationsGeohexGridAggregation
global?: AggregationsGlobalAggregation
histogram?: AggregationsHistogramAggregation
ip_range?: AggregationsIpRangeAggregation
@ -2813,14 +2815,6 @@ export interface AggregationsChildrenAggregation extends AggregationsBucketAggre
type?: RelationName
}
export interface AggregationsClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export interface AggregationsCompositeAggregate extends AggregationsMultiBucketAggregateBase<AggregationsCompositeBucket> {
after_key?: Record<string, any>
}
@ -3089,6 +3083,14 @@ export interface AggregationsGeoTileGridBucketKeys extends AggregationsMultiBuck
export type AggregationsGeoTileGridBucket = AggregationsGeoTileGridBucketKeys
& { [property: string]: AggregationsAggregate | GeoTile | long }
export interface AggregationsGeohexGridAggregation extends AggregationsBucketAggregationBase {
field: Field
precision?: integer
bounds?: GeoBounds
size?: integer
shard_size?: integer
}
export interface AggregationsGlobalAggregateKeys extends AggregationsSingleBucketAggregateBase {
}
export type AggregationsGlobalAggregate = AggregationsGlobalAggregateKeys
@ -3186,8 +3188,8 @@ export interface AggregationsInferenceClassImportance {
}
export interface AggregationsInferenceConfigContainer {
regression?: AggregationsRegressionInferenceOptions
classification?: AggregationsClassificationInferenceOptions
regression?: MlRegressionInferenceOptions
classification?: MlClassificationInferenceOptions
}
export interface AggregationsInferenceFeatureImportance {
@ -3477,11 +3479,6 @@ export interface AggregationsRateAggregation extends AggregationsFormatMetricAgg
export type AggregationsRateMode = 'sum' | 'value_count'
export interface AggregationsRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export interface AggregationsReverseNestedAggregateKeys extends AggregationsSingleBucketAggregateBase {
}
export type AggregationsReverseNestedAggregate = AggregationsReverseNestedAggregateKeys
@ -3548,7 +3545,8 @@ export interface AggregationsSignificantTermsAggregation extends AggregationsBuc
execution_hint?: AggregationsTermsAggregationExecutionHint
field?: Field
gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[]
include?: AggregationsTermsInclude
jlh?: EmptyObject
min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic
@ -3572,6 +3570,7 @@ export interface AggregationsSignificantTextAggregation extends AggregationsBuck
filter_duplicate_text?: boolean
gnd?: AggregationsGoogleNormalizedDistanceHeuristic
include?: string | string[]
jlh?: EmptyObject
min_doc_count?: long
mutual_information?: AggregationsMutualInformationHeuristic
percentage?: AggregationsPercentageScoreHeuristic
@ -4577,7 +4576,7 @@ export interface MappingDenseVectorProperty extends MappingPropertyBase {
index_options?: MappingDenseVectorIndexOptions
}
export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingGenericProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty
export type MappingDocValuesProperty = MappingBinaryProperty | MappingBooleanProperty | MappingDateProperty | MappingDateNanosProperty | MappingKeywordProperty | MappingNumberProperty | MappingRangeProperty | MappingGeoPointProperty | MappingGeoShapeProperty | MappingCompletionProperty | MappingIpProperty | MappingMurmur3HashProperty | MappingShapeProperty | MappingTokenCountProperty | MappingVersionProperty | MappingWildcardProperty | MappingPointProperty
export interface MappingDocValuesPropertyBase extends MappingCorePropertyBase {
doc_values?: boolean
@ -4642,21 +4641,6 @@ export interface MappingFloatRangeProperty extends MappingRangePropertyBase {
type: 'float_range'
}
export interface MappingGenericProperty extends MappingDocValuesPropertyBase {
analyzer: string
boost: double
fielddata: IndicesStringFielddata
ignore_malformed: boolean
index: boolean
index_options: MappingIndexOptions
norms: boolean
null_value: string
position_increment_gap: integer
search_analyzer: string
term_vector: MappingTermVectorOption
type: string
}
export type MappingGeoOrientation = 'right' | 'RIGHT' | 'counterclockwise' | 'ccw' | 'left' | 'LEFT' | 'clockwise' | 'cw'
export interface MappingGeoPointProperty extends MappingDocValuesPropertyBase {
@ -5001,7 +4985,7 @@ export interface QueryDslConstantScoreQuery extends QueryDslQueryBase {
export interface QueryDslDateDecayFunctionKeys extends QueryDslDecayFunctionBase {
}
export type QueryDslDateDecayFunction = QueryDslDateDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode | QueryDslQueryContainer | double }
& { [property: string]: QueryDslDecayPlacement<DateMath, Time> | QueryDslMultiValueMode }
export interface QueryDslDateDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<DateMath, Time> {
}
@ -5019,7 +5003,7 @@ export interface QueryDslDateRangeQuery extends QueryDslRangeQueryBase {
export type QueryDslDecayFunction = QueryDslDateDecayFunction | QueryDslNumericDecayFunction | QueryDslGeoDecayFunction
export interface QueryDslDecayFunctionBase extends QueryDslScoreFunctionBase {
export interface QueryDslDecayFunctionBase {
multi_value_mode?: QueryDslMultiValueMode
}
@ -5062,7 +5046,7 @@ export interface QueryDslFieldLookup {
export type QueryDslFieldValueFactorModifier = 'none' | 'log' | 'log1p' | 'log2p' | 'ln' | 'ln1p' | 'ln2p' | 'square' | 'sqrt' | 'reciprocal'
export interface QueryDslFieldValueFactorScoreFunction extends QueryDslScoreFunctionBase {
export interface QueryDslFieldValueFactorScoreFunction {
field: Field
factor?: double
missing?: double
@ -5113,7 +5097,7 @@ export type QueryDslGeoBoundingBoxQuery = QueryDslGeoBoundingBoxQueryKeys
export interface QueryDslGeoDecayFunctionKeys extends QueryDslDecayFunctionBase {
}
export type QueryDslGeoDecayFunction = QueryDslGeoDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode | QueryDslQueryContainer | double }
& { [property: string]: QueryDslDecayPlacement<GeoLocation, Distance> | QueryDslMultiValueMode }
export interface QueryDslGeoDistanceFeatureQuery extends QueryDslDistanceFeatureQueryBase<GeoLocation, Distance> {
}
@ -5379,7 +5363,7 @@ export interface QueryDslNumberRangeQuery extends QueryDslRangeQueryBase {
export interface QueryDslNumericDecayFunctionKeys extends QueryDslDecayFunctionBase {
}
export type QueryDslNumericDecayFunction = QueryDslNumericDecayFunctionKeys
& { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode | QueryDslQueryContainer | double }
& { [property: string]: QueryDslDecayPlacement<double, double> | QueryDslMultiValueMode }
export type QueryDslOperator = 'and' | 'AND' | 'or' | 'OR'
@ -5509,7 +5493,7 @@ export interface QueryDslQueryStringQuery extends QueryDslQueryBase {
type?: QueryDslTextQueryType
}
export interface QueryDslRandomScoreFunction extends QueryDslScoreFunctionBase {
export interface QueryDslRandomScoreFunction {
field?: Field
seed?: long | string
}
@ -5557,16 +5541,11 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase {
value: string
}
export interface QueryDslScoreFunctionBase {
filter?: QueryDslQueryContainer
weight?: double
}
export interface QueryDslScriptQuery extends QueryDslQueryBase {
script: Script
}
export interface QueryDslScriptScoreFunction extends QueryDslScoreFunctionBase {
export interface QueryDslScriptScoreFunction {
script: Script
}
@ -5755,8 +5734,7 @@ export interface AsyncSearchGetRequest extends RequestBase {
wait_for_completion_timeout?: Time
}
export interface AsyncSearchGetResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> {
}
export type AsyncSearchGetResponse<TDocument = unknown, AsyncSearchTAggregations = unknown> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, AsyncSearchTAggregations>
export interface AsyncSearchStatusRequest extends RequestBase {
id: Id
@ -5853,8 +5831,7 @@ export interface AsyncSearchSubmitRequest extends RequestBase {
}
}
export interface AsyncSearchSubmitResponse<TDocument = unknown> extends AsyncSearchAsyncSearchDocumentResponseBase<TDocument> {
}
export type AsyncSearchSubmitResponse<TDocument = unknown, AsyncSearchTAggregations = unknown> = AsyncSearchAsyncSearchDocumentResponseBase<TDocument, AsyncSearchTAggregations>
export interface AutoscalingAutoscalingPolicy {
roles: string[]
@ -8755,8 +8732,7 @@ export interface EqlGetRequest extends RequestBase {
wait_for_completion_timeout?: Time
}
export interface EqlGetResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> {
}
export type EqlGetResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
export interface EqlGetStatusRequest extends RequestBase {
id: Id
@ -8798,8 +8774,7 @@ export interface EqlSearchRequest extends RequestBase {
}
}
export interface EqlSearchResponse<TEvent = unknown> extends EqlEqlSearchResponseBase<TEvent> {
}
export type EqlSearchResponse<TEvent = unknown> = EqlEqlSearchResponseBase<TEvent>
export type EqlSearchResultPosition = 'tail' | 'head'
@ -9454,6 +9429,7 @@ export interface IndicesMappingLimitSettings {
nested_objects?: IndicesMappingLimitSettingsNestedObjects
field_name_length?: IndicesMappingLimitSettingsFieldNameLength
dimension_fields?: IndicesMappingLimitSettingsDimensionFields
ignore_malformed?: boolean
}
export interface IndicesMappingLimitSettingsDepth {
@ -9611,13 +9587,7 @@ export interface IndicesStorage {
allow_mmap?: boolean
}
export type IndicesStorageType = 'fs' | 'niofs' | 'mmapfs' | 'hybridfs'
export interface IndicesStringFielddata {
format: IndicesStringFielddataFormat
}
export type IndicesStringFielddataFormat = 'paged_bytes' | 'disabled'
export type IndicesStorageType = 'fs' | '' | 'niofs' | 'mmapfs' | 'hybridfs'
export interface IndicesTemplateMapping {
aliases: Record<IndexName, IndicesAlias>
@ -9635,7 +9605,7 @@ export interface IndicesTranslog {
retention?: IndicesTranslogRetention
}
export type IndicesTranslogDurability = 'request' | 'async'
export type IndicesTranslogDurability = 'request' | 'REQUEST' | 'async' | 'ASYNC'
export interface IndicesTranslogRetention {
size?: ByteSize
@ -9805,7 +9775,7 @@ export interface IndicesCreateRequest extends RequestBase {
export interface IndicesCreateResponse {
index: IndexName
shards_acknowledged: boolean
acknowledged?: boolean
acknowledged: boolean
}
export interface IndicesCreateDataStreamRequest extends RequestBase {
@ -10131,6 +10101,25 @@ export interface IndicesMigrateToDataStreamRequest extends RequestBase {
export type IndicesMigrateToDataStreamResponse = AcknowledgedResponseBase
export interface IndicesModifyDataStreamAction {
add_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
remove_backing_index?: IndicesModifyDataStreamIndexAndDataStreamAction
}
export interface IndicesModifyDataStreamIndexAndDataStreamAction {
index: IndexName
data_stream: DataStreamName
}
export interface IndicesModifyDataStreamRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
actions: IndicesModifyDataStreamAction[]
}
}
export type IndicesModifyDataStreamResponse = AcknowledgedResponseBase
export interface IndicesOpenRequest extends RequestBase {
index: Indices
allow_no_indices?: boolean
@ -10984,10 +10973,20 @@ export interface IngestGsubProcessor extends IngestProcessorBase {
export interface IngestInferenceConfig {
regression?: IngestInferenceConfigRegression
classification?: IngestInferenceConfigClassification
}
export interface IngestInferenceConfigClassification {
num_top_classes?: integer
num_top_feature_importance_values?: integer
results_field?: Field
top_classes_results_field?: Field
prediction_field_type?: string
}
export interface IngestInferenceConfigRegression {
results_field: string
results_field?: Field
num_top_feature_importance_values?: integer
}
export interface IngestInferenceProcessor extends IngestProcessorBase {
@ -11614,6 +11613,14 @@ export interface MlChunkingConfig {
export type MlChunkingMode = 'auto' | 'manual' | 'off'
export interface MlClassificationInferenceOptions {
num_top_classes?: integer
num_top_feature_importance_values?: integer
prediction_field_type?: string
results_field?: string
top_classes_results_field?: string
}
export type MlConditionOperator = 'gt' | 'gte' | 'lt' | 'lte'
export type MlCustomSettings = any
@ -12004,6 +12011,18 @@ export interface MlDiscoveryNode {
export type MlExcludeFrequent = 'all' | 'none' | 'by' | 'over'
export interface MlFillMaskInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlFillMaskInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlFilter {
description?: string
filter_id: Id
@ -12044,6 +12063,17 @@ export interface MlHyperparameters {
export type MlInclude = 'definition' | 'feature_importance_baseline' | 'hyperparameters' | 'total_feature_importance'
export interface MlInferenceConfigCreateContainer {
regression?: MlRegressionInferenceOptions
classification?: MlClassificationInferenceOptions
text_classification?: MlTextClassificationInferenceOptions
zero_shot_classification?: MlZeroShotClassificationInferenceOptions
fill_mask?: MlFillMaskInferenceOptions
ner?: MlNerInferenceOptions
pass_through?: MlPassThroughInferenceOptions
text_embedding?: MlTextEmbeddingInferenceOptions
}
export interface MlInfluence {
influencer_field_name: string
influencer_field_values: string[]
@ -12203,6 +12233,47 @@ export interface MlModelSnapshot {
timestamp: long
}
export interface MlNerInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlNerInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlNlpBertTokenizationConfig {
do_lower_case?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpInferenceConfigUpdateContainer {
text_classification?: MlTextClassificationInferenceUpdateOptions
zero_shot_classification?: MlZeroShotClassificationInferenceUpdateOptions
fill_mask?: MlFillMaskInferenceUpdateOptions
ner?: MlNerInferenceUpdateOptions
pass_through?: MlPassThroughInferenceUpdateOptions
text_embedding?: MlTextEmbeddingInferenceUpdateOptions
}
export interface MlNlpRobertaTokenizationConfig {
add_prefix_space?: boolean
with_special_tokens?: boolean
max_sequence_length?: integer
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlNlpTokenizationUpdateOptions {
truncate?: MlTokenizationTruncate
span?: integer
}
export interface MlOutlierDetectionParameters {
compute_feature_influence?: boolean
feature_influence_threshold?: double
@ -12231,6 +12302,16 @@ export interface MlPage {
size?: integer
}
export interface MlPassThroughInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlPassThroughInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlPerPartitionCategorization {
enabled?: boolean
stop_on_warn?: boolean
@ -12238,6 +12319,11 @@ export interface MlPerPartitionCategorization {
export type MlPredictedValue = string | double
export interface MlRegressionInferenceOptions {
results_field?: Field
num_top_feature_importance_values?: integer
}
export type MlRoutingState = 'failed' | 'started' | 'starting' | 'stopped' | 'stopping'
export type MlRuleAction = 'skip_result' | 'skip_model_update'
@ -12253,11 +12339,43 @@ export interface MlRunningStateSearchInterval {
start_ms: long
}
export interface MlTextClassificationInferenceOptions {
num_top_classes?: integer
tokenization?: MlTokenizationConfigContainer
results_field?: string
classification_labels?: string[]
}
export interface MlTextClassificationInferenceUpdateOptions {
num_top_classes?: integer
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
classification_labels?: string[]
}
export interface MlTextEmbeddingInferenceOptions {
tokenization?: MlTokenizationConfigContainer
results_field?: string
}
export interface MlTextEmbeddingInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
}
export interface MlTimingStats {
elapsed_time: integer
iteration_time?: integer
}
export interface MlTokenizationConfigContainer {
bert?: MlNlpBertTokenizationConfig
mpnet?: MlNlpBertTokenizationConfig
roberta?: MlNlpRobertaTokenizationConfig
}
export type MlTokenizationTruncate = 'first' | 'second' | 'none'
export interface MlTopClassEntry {
class_name: string
class_probability: double
@ -12310,7 +12428,7 @@ export interface MlTrainedModelConfig {
description?: string
estimated_heap_memory_usage_bytes?: integer
estimated_operations?: integer
inference_config: AggregationsInferenceConfigContainer
inference_config: MlInferenceConfigCreateContainer
input: MlTrainedModelConfigInput
license_level?: string
metadata?: MlTrainedModelConfigMetadata
@ -12411,6 +12529,22 @@ export interface MlValidationLoss {
loss_type: string
}
export interface MlZeroShotClassificationInferenceOptions {
tokenization?: MlTokenizationConfigContainer
hypothesis_template?: string
classification_labels: string[]
results_field?: string
multi_label?: boolean
labels?: string[]
}
export interface MlZeroShotClassificationInferenceUpdateOptions {
tokenization?: MlNlpTokenizationUpdateOptions
results_field?: string
multi_label?: boolean
labels: string[]
}
export interface MlCloseJobRequest extends RequestBase {
job_id: Id
allow_no_match?: boolean
@ -12876,42 +13010,43 @@ export interface MlGetJobsResponse {
}
export interface MlGetMemoryStatsJvmStats {
heap_max: ByteSize
heap_max?: ByteSize
heap_max_in_bytes: integer
java_inference: ByteSize
java_inference?: ByteSize
java_inference_in_bytes: integer
java_inference_max: ByteSize
java_inference_max?: ByteSize
java_inference_max_in_bytes: integer
}
export interface MlGetMemoryStatsMemMlStats {
anomaly_detectors: ByteSize
anomaly_detectors?: ByteSize
anomaly_detectors_in_bytes: integer
data_frame_analytics: ByteSize
data_frame_analytics?: ByteSize
data_frame_analytics_in_bytes: integer
max: ByteSize
max?: ByteSize
max_in_bytes: integer
native_code_overhead: ByteSize
native_code_overhead?: ByteSize
native_code_overhead_in_bytes: integer
native_inference: ByteSize
native_inference?: ByteSize
native_inference_in_bytes: integer
}
export interface MlGetMemoryStatsMemStats {
adjusted_total: ByteSize
adjusted_total?: ByteSize
adjusted_total_in_bytes: integer
total: ByteSize
total?: ByteSize
total_in_bytes: integer
ml: MlGetMemoryStatsMemMlStats
}
export interface MlGetMemoryStatsMemory {
attributes: string[]
attributes: Record<string, string>
jvm: MlGetMemoryStatsJvmStats
mem: MlGetMemoryStatsMemStats
name: Name
roles: string[]
transport_address: TransportAddress
ephemeral_id: Id
}
export interface MlGetMemoryStatsRequest extends RequestBase {
@ -12923,7 +13058,7 @@ export interface MlGetMemoryStatsRequest extends RequestBase {
export interface MlGetMemoryStatsResponse {
_nodes: NodeStatistics
cluser_name: Name
cluster_name: Name
nodes: Record<Id, MlGetMemoryStatsMemory>
}
@ -13038,6 +13173,7 @@ export interface MlInferTrainedModelDeploymentRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
docs: Record<string, string>[]
inference_config?: MlNlpInferenceConfigUpdateContainer
}
}
@ -13382,7 +13518,7 @@ export interface MlPutTrainedModelRequest extends RequestBase {
compressed_definition?: string
definition?: MlPutTrainedModelDefinition
description?: string
inference_config: AggregationsInferenceConfigContainer
inference_config: MlInferenceConfigCreateContainer
input: MlPutTrainedModelInput
metadata?: any
model_type?: MlTrainedModelType
@ -14981,6 +15117,8 @@ export interface SecurityGlobalPrivilege {
application: SecurityApplicationGlobalUserPrivileges
}
export type SecurityGrantType = 'password' | 'access_token'
export type SecurityIndexPrivilege = 'none' | 'all' | 'auto_configure' | 'create' | 'create_doc' | 'create_index' | 'delete' | 'delete_index' | 'index' | 'maintenance' | 'manage' | 'manage_follow_index' | 'manage_ilm' | 'manage_leader_index' | 'monitor' | 'read' | 'read_cross_cluster' | 'view_index_metadata' | 'write'
export interface SecurityIndicesPrivileges {
@ -15044,6 +15182,44 @@ export interface SecurityUser {
enabled: boolean
}
export interface SecurityUserProfile {
uid: string
user: SecurityUserProfileUser
data?: Record<string, any>
labels?: Record<string, any>
enabled?: boolean
}
export interface SecurityUserProfileHitMetadata {
_primary_term: long
_seq_no: SequenceNumber
}
export interface SecurityUserProfileUser {
email?: string | null
full_name?: Name | null
metadata: Metadata
roles: string[]
username: Username
}
export interface SecurityUserProfileWithMetadata extends SecurityUserProfile {
last_synchronized: long
_doc?: SecurityUserProfileHitMetadata
}
export interface SecurityActivateUserProfileRequest extends RequestBase {
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
access_token?: string
grant_type: SecurityGrantType
password?: string
username?: string
}
}
export type SecurityActivateUserProfileResponse = SecurityUserProfileWithMetadata
export interface SecurityAuthenticateRequest extends RequestBase {
}
@ -15236,6 +15412,13 @@ export interface SecurityDisableUserRequest extends RequestBase {
export interface SecurityDisableUserResponse {
}
export interface SecurityDisableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityDisableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnableUserRequest extends RequestBase {
username: Username
refresh?: Refresh
@ -15244,6 +15427,13 @@ export interface SecurityEnableUserRequest extends RequestBase {
export interface SecurityEnableUserResponse {
}
export interface SecurityEnableUserProfileRequest extends RequestBase {
uid: string
refresh?: Refresh
}
export type SecurityEnableUserProfileResponse = AcknowledgedResponseBase
export interface SecurityEnrollKibanaRequest extends RequestBase {
}
@ -15429,6 +15619,13 @@ export interface SecurityGetUserPrivilegesResponse {
run_as: string[]
}
export interface SecurityGetUserProfileRequest extends RequestBase {
uid: string
data?: string | string[]
}
export type SecurityGetUserProfileResponse = Record<string, SecurityUserProfileWithMetadata>
export type SecurityGrantApiKeyApiKeyGrantType = 'access_token' | 'password'
export interface SecurityGrantApiKeyGrantApiKey {
@ -15695,6 +15892,40 @@ export interface SecuritySamlServiceProviderMetadataResponse {
metadata: string
}
export interface SecuritySuggestUserProfilesRequest extends RequestBase {
data?: string | string[]
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
name?: string
size?: long
}
}
export interface SecuritySuggestUserProfilesResponse {
total: SecuritySuggestUserProfilesTotalUserProfiles
took: long
profiles: SecurityUserProfile[]
}
export interface SecuritySuggestUserProfilesTotalUserProfiles {
value: long
relation: RelationName
}
export interface SecurityUpdateUserProfileDataRequest extends RequestBase {
uid: string
if_seq_no?: SequenceNumber
if_primary_term?: long
refresh?: Refresh
/** @deprecated The use of the 'body' key has been deprecated, move the nested keys to the top level object. */
body?: {
access?: Record<string, any>
data?: Record<string, any>
}
}
export type SecurityUpdateUserProfileDataResponse = AcknowledgedResponseBase
export interface ShutdownDeleteNodeRequest extends RequestBase {
node_id: NodeId
}
@ -16130,7 +16361,7 @@ export interface SnapshotRestoreRequest extends RequestBase {
ignore_unavailable?: boolean
include_aliases?: boolean
include_global_state?: boolean
index_settings?: IndicesPutSettingsRequest
index_settings?: IndicesIndexSettings
indices?: Indices
partial?: boolean
rename_pattern?: string
@ -16687,7 +16918,7 @@ export interface TransformUpdateTransformRequest extends RequestBase {
source?: TransformSource
settings?: TransformSettings
sync?: TransformSyncContainer
retention_policy?: TransformRetentionPolicyContainer
retention_policy?: TransformRetentionPolicyContainer | null
}
}