@elastic/elasticsearch 9.0.2 → 9.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +38 -52
- package/lib/api/api/bulk.d.ts +1 -1
- package/lib/api/api/cluster.d.ts +1 -1
- package/lib/api/api/esql.js +4 -5
- package/lib/api/api/esql.js.map +1 -1
- package/lib/api/api/indices.d.ts +5 -5
- package/lib/api/api/inference.d.ts +3 -3
- package/lib/api/api/ml.d.ts +2 -2
- package/lib/api/api/monitoring.d.ts +1 -1
- package/lib/api/api/reindex.d.ts +1 -1
- package/lib/api/api/search_mvt.d.ts +1 -1
- package/lib/api/api/security.d.ts +2 -2
- package/lib/api/api/termvectors.d.ts +1 -1
- package/lib/api/api/watcher.d.ts +2 -2
- package/lib/api/types.d.ts +351 -107
- package/package.json +1 -1
package/lib/api/types.d.ts
CHANGED
|
@@ -2008,7 +2008,7 @@ export interface OpenPointInTimeRequest extends RequestBase {
|
|
|
2008
2008
|
routing?: Routing;
|
|
2009
2009
|
/** The type of index that wildcard patterns can match.
|
|
2010
2010
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
2011
|
-
* It supports comma-separated values, such as `open,hidden`.
|
|
2011
|
+
* It supports comma-separated values, such as `open,hidden`. */
|
|
2012
2012
|
expand_wildcards?: ExpandWildcards;
|
|
2013
2013
|
/** Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT.
|
|
2014
2014
|
* If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception.
|
|
@@ -3636,7 +3636,7 @@ export interface SearchShardProfile {
|
|
|
3636
3636
|
index: IndexName;
|
|
3637
3637
|
node_id: NodeId;
|
|
3638
3638
|
searches: SearchSearchProfile[];
|
|
3639
|
-
shard_id:
|
|
3639
|
+
shard_id: integer;
|
|
3640
3640
|
}
|
|
3641
3641
|
export interface SearchSmoothingModelContainer {
|
|
3642
3642
|
/** A smoothing model that uses an additive smoothing where a constant (typically `1.0` or smaller) is added to all counts to balance weights. */
|
|
@@ -3897,8 +3897,7 @@ export interface SearchShardsRequest extends RequestBase {
|
|
|
3897
3897
|
allow_no_indices?: boolean;
|
|
3898
3898
|
/** Type of index that wildcard patterns can match.
|
|
3899
3899
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
3900
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
3901
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
3900
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
3902
3901
|
expand_wildcards?: ExpandWildcards;
|
|
3903
3902
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
3904
3903
|
ignore_unavailable?: boolean;
|
|
@@ -3976,8 +3975,7 @@ export interface SearchTemplateRequest extends RequestBase {
|
|
|
3976
3975
|
ccs_minimize_roundtrips?: boolean;
|
|
3977
3976
|
/** The type of index that wildcard patterns can match.
|
|
3978
3977
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
3979
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
3980
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
3978
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
3981
3979
|
expand_wildcards?: ExpandWildcards;
|
|
3982
3980
|
/** If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. */
|
|
3983
3981
|
ignore_throttled?: boolean;
|
|
@@ -4408,8 +4406,7 @@ export interface UpdateByQueryRequest extends RequestBase {
|
|
|
4408
4406
|
df?: string;
|
|
4409
4407
|
/** The type of index that wildcard patterns can match.
|
|
4410
4408
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
4411
|
-
* It supports comma-separated values, such as `open,hidden`.
|
|
4412
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
4409
|
+
* It supports comma-separated values, such as `open,hidden`. */
|
|
4413
4410
|
expand_wildcards?: ExpandWildcards;
|
|
4414
4411
|
/** Skips the specified number of documents. */
|
|
4415
4412
|
from?: long;
|
|
@@ -4764,7 +4761,7 @@ export interface ErrorCauseKeys {
|
|
|
4764
4761
|
/** The type of error */
|
|
4765
4762
|
type: string;
|
|
4766
4763
|
/** A human-readable explanation of the error, in English. */
|
|
4767
|
-
reason?: string;
|
|
4764
|
+
reason?: string | null;
|
|
4768
4765
|
/** The server stack trace. Present only if the `error_trace=true` parameter was sent with the request. */
|
|
4769
4766
|
stack_trace?: string;
|
|
4770
4767
|
caused_by?: ErrorCause;
|
|
@@ -4914,6 +4911,11 @@ export interface InlineGetKeys<TDocument = unknown> {
|
|
|
4914
4911
|
export type InlineGet<TDocument = unknown> = InlineGetKeys<TDocument> & {
|
|
4915
4912
|
[property: string]: any;
|
|
4916
4913
|
};
|
|
4914
|
+
export interface InnerRetriever {
|
|
4915
|
+
retriever: RetrieverContainer;
|
|
4916
|
+
weight: float;
|
|
4917
|
+
normalizer: ScoreNormalizer;
|
|
4918
|
+
}
|
|
4917
4919
|
export type Ip = string;
|
|
4918
4920
|
export interface KnnQuery extends QueryDslQueryBase {
|
|
4919
4921
|
/** The name of the vector field to search against */
|
|
@@ -4982,6 +4984,11 @@ export interface LatLonGeoLocation {
|
|
|
4982
4984
|
}
|
|
4983
4985
|
export type Level = 'cluster' | 'indices' | 'shards';
|
|
4984
4986
|
export type LifecycleOperationMode = 'RUNNING' | 'STOPPING' | 'STOPPED';
|
|
4987
|
+
export interface LinearRetriever extends RetrieverBase {
|
|
4988
|
+
/** Inner retrievers. */
|
|
4989
|
+
retrievers?: InnerRetriever[];
|
|
4990
|
+
rank_window_size?: integer;
|
|
4991
|
+
}
|
|
4985
4992
|
export type MapboxVectorTiles = ArrayBuffer;
|
|
4986
4993
|
export interface MergesStats {
|
|
4987
4994
|
current: long;
|
|
@@ -5056,6 +5063,13 @@ export type Normalization = 'no' | 'h1' | 'h2' | 'h3' | 'z';
|
|
|
5056
5063
|
export type OpType = 'index' | 'create';
|
|
5057
5064
|
export type Password = string;
|
|
5058
5065
|
export type Percentage = string | float;
|
|
5066
|
+
export interface PinnedRetriever extends RetrieverBase {
|
|
5067
|
+
/** Inner retriever. */
|
|
5068
|
+
retriever: RetrieverContainer;
|
|
5069
|
+
ids?: string[];
|
|
5070
|
+
docs?: SpecifiedDocument[];
|
|
5071
|
+
rank_window_size?: integer;
|
|
5072
|
+
}
|
|
5059
5073
|
export type PipelineName = string;
|
|
5060
5074
|
export interface PluginStats {
|
|
5061
5075
|
classname: string;
|
|
@@ -5138,6 +5152,11 @@ export interface RescoreVector {
|
|
|
5138
5152
|
/** Applies the specified oversample factor to k on the approximate kNN search */
|
|
5139
5153
|
oversample: float;
|
|
5140
5154
|
}
|
|
5155
|
+
export interface RescorerRetriever extends RetrieverBase {
|
|
5156
|
+
/** Inner retriever. */
|
|
5157
|
+
retriever: RetrieverContainer;
|
|
5158
|
+
rescore: SearchRescore | SearchRescore[];
|
|
5159
|
+
}
|
|
5141
5160
|
export type Result = 'created' | 'updated' | 'deleted' | 'not_found' | 'noop';
|
|
5142
5161
|
export interface Retries {
|
|
5143
5162
|
/** The number of bulk actions retried. */
|
|
@@ -5150,6 +5169,8 @@ export interface RetrieverBase {
|
|
|
5150
5169
|
filter?: QueryDslQueryContainer | QueryDslQueryContainer[];
|
|
5151
5170
|
/** Minimum _score for matching documents. Documents with a lower _score are not included in the top documents. */
|
|
5152
5171
|
min_score?: float;
|
|
5172
|
+
/** Retriever name. */
|
|
5173
|
+
_name?: string;
|
|
5153
5174
|
}
|
|
5154
5175
|
export interface RetrieverContainer {
|
|
5155
5176
|
/** A retriever that replaces the functionality of a traditional query. */
|
|
@@ -5162,6 +5183,13 @@ export interface RetrieverContainer {
|
|
|
5162
5183
|
text_similarity_reranker?: TextSimilarityReranker;
|
|
5163
5184
|
/** A retriever that replaces the functionality of a rule query. */
|
|
5164
5185
|
rule?: RuleRetriever;
|
|
5186
|
+
/** A retriever that re-scores only the results produced by its child retriever. */
|
|
5187
|
+
rescorer?: RescorerRetriever;
|
|
5188
|
+
/** A retriever that supports the combination of different retrievers through a weighted linear combination. */
|
|
5189
|
+
linear?: LinearRetriever;
|
|
5190
|
+
/** A pinned retriever applies pinned documents to the underlying retriever.
|
|
5191
|
+
* This retriever will rewrite to a PinnedQueryBuilder. */
|
|
5192
|
+
pinned?: PinnedRetriever;
|
|
5165
5193
|
}
|
|
5166
5194
|
export type Routing = string;
|
|
5167
5195
|
export interface RrfRank {
|
|
@@ -5172,7 +5200,7 @@ export interface RrfRank {
|
|
|
5172
5200
|
}
|
|
5173
5201
|
export interface RuleRetriever extends RetrieverBase {
|
|
5174
5202
|
/** The ruleset IDs containing the rules this retriever is evaluating against. */
|
|
5175
|
-
ruleset_ids: Id[];
|
|
5203
|
+
ruleset_ids: Id | Id[];
|
|
5176
5204
|
/** The match criteria that will determine if a rule in the provided rulesets should be applied. */
|
|
5177
5205
|
match_criteria: any;
|
|
5178
5206
|
/** The retriever whose results rules should be applied to. */
|
|
@@ -5181,6 +5209,7 @@ export interface RuleRetriever extends RetrieverBase {
|
|
|
5181
5209
|
rank_window_size?: integer;
|
|
5182
5210
|
}
|
|
5183
5211
|
export type ScalarValue = long | double | string | boolean | null;
|
|
5212
|
+
export type ScoreNormalizer = 'none' | 'minmax';
|
|
5184
5213
|
export interface ScoreSort {
|
|
5185
5214
|
order?: SortOrder;
|
|
5186
5215
|
}
|
|
@@ -5336,6 +5365,10 @@ export type SortOptions = SortOptionsKeys & {
|
|
|
5336
5365
|
};
|
|
5337
5366
|
export type SortOrder = 'asc' | 'desc';
|
|
5338
5367
|
export type SortResults = FieldValue[];
|
|
5368
|
+
export interface SpecifiedDocument {
|
|
5369
|
+
index?: IndexName;
|
|
5370
|
+
id: Id;
|
|
5371
|
+
}
|
|
5339
5372
|
export interface StandardRetriever extends RetrieverBase {
|
|
5340
5373
|
/** Defines a query to retrieve a set of top documents. */
|
|
5341
5374
|
query?: QueryDslQueryContainer;
|
|
@@ -5395,9 +5428,9 @@ export interface TextSimilarityReranker extends RetrieverBase {
|
|
|
5395
5428
|
/** Unique identifier of the inference endpoint created using the inference API. */
|
|
5396
5429
|
inference_id?: string;
|
|
5397
5430
|
/** The text snippet used as the basis for similarity comparison */
|
|
5398
|
-
inference_text
|
|
5431
|
+
inference_text: string;
|
|
5399
5432
|
/** The document field to be used for text similarity comparisons. This field should contain the text that will be evaluated against the inference_text */
|
|
5400
|
-
field
|
|
5433
|
+
field: string;
|
|
5401
5434
|
}
|
|
5402
5435
|
export type ThreadType = 'cpu' | 'wait' | 'block' | 'gpu' | 'mem';
|
|
5403
5436
|
export type TimeOfDay = string;
|
|
@@ -8883,7 +8916,7 @@ export type QueryDslGeoDistanceQuery = QueryDslGeoDistanceQueryKeys & {
|
|
|
8883
8916
|
};
|
|
8884
8917
|
export type QueryDslGeoExecution = 'memory' | 'indexed';
|
|
8885
8918
|
export interface QueryDslGeoGridQuery extends QueryDslQueryBase {
|
|
8886
|
-
|
|
8919
|
+
geotile?: GeoTile;
|
|
8887
8920
|
geohash?: GeoHash;
|
|
8888
8921
|
geohex?: GeoHexCell;
|
|
8889
8922
|
}
|
|
@@ -8978,6 +9011,8 @@ export interface QueryDslIntervalsContainer {
|
|
|
8978
9011
|
match?: QueryDslIntervalsMatch;
|
|
8979
9012
|
/** Matches terms that start with a specified set of characters. */
|
|
8980
9013
|
prefix?: QueryDslIntervalsPrefix;
|
|
9014
|
+
range?: QueryDslIntervalsRange;
|
|
9015
|
+
regexp?: QueryDslIntervalsRegexp;
|
|
8981
9016
|
/** Matches terms using a wildcard pattern. */
|
|
8982
9017
|
wildcard?: QueryDslIntervalsWildcard;
|
|
8983
9018
|
}
|
|
@@ -9053,9 +9088,35 @@ export interface QueryDslIntervalsQuery extends QueryDslQueryBase {
|
|
|
9053
9088
|
match?: QueryDslIntervalsMatch;
|
|
9054
9089
|
/** Matches terms that start with a specified set of characters. */
|
|
9055
9090
|
prefix?: QueryDslIntervalsPrefix;
|
|
9091
|
+
range?: QueryDslIntervalsRange;
|
|
9092
|
+
regexp?: QueryDslIntervalsRegexp;
|
|
9056
9093
|
/** Matches terms using a wildcard pattern. */
|
|
9057
9094
|
wildcard?: QueryDslIntervalsWildcard;
|
|
9058
9095
|
}
|
|
9096
|
+
export interface QueryDslIntervalsRange {
|
|
9097
|
+
/** Analyzer used to analyze the `prefix`. */
|
|
9098
|
+
analyzer?: string;
|
|
9099
|
+
/** Lower term, either gte or gt must be provided. */
|
|
9100
|
+
gte?: string;
|
|
9101
|
+
/** Lower term, either gte or gt must be provided. */
|
|
9102
|
+
gt?: string;
|
|
9103
|
+
/** Upper term, either lte or lt must be provided. */
|
|
9104
|
+
lte?: string;
|
|
9105
|
+
/** Upper term, either lte or lt must be provided. */
|
|
9106
|
+
lt?: string;
|
|
9107
|
+
/** If specified, match intervals from this field rather than the top-level field.
|
|
9108
|
+
* The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. */
|
|
9109
|
+
use_field?: Field;
|
|
9110
|
+
}
|
|
9111
|
+
export interface QueryDslIntervalsRegexp {
|
|
9112
|
+
/** Analyzer used to analyze the `prefix`. */
|
|
9113
|
+
analyzer?: string;
|
|
9114
|
+
/** Regex pattern. */
|
|
9115
|
+
pattern: string;
|
|
9116
|
+
/** If specified, match intervals from this field rather than the top-level field.
|
|
9117
|
+
* The `prefix` is normalized using the search analyzer from this field, unless `analyzer` is specified separately. */
|
|
9118
|
+
use_field?: Field;
|
|
9119
|
+
}
|
|
9059
9120
|
export interface QueryDslIntervalsWildcard {
|
|
9060
9121
|
/** Analyzer used to analyze the `pattern`.
|
|
9061
9122
|
* Defaults to the top-level field's analyzer. */
|
|
@@ -9529,8 +9590,6 @@ export interface QueryDslRangeQueryBase<T = unknown> extends QueryDslQueryBase {
|
|
|
9529
9590
|
lt?: T;
|
|
9530
9591
|
/** Less than or equal to. */
|
|
9531
9592
|
lte?: T;
|
|
9532
|
-
from?: T | null;
|
|
9533
|
-
to?: T | null;
|
|
9534
9593
|
}
|
|
9535
9594
|
export type QueryDslRangeRelation = 'within' | 'contains' | 'intersects';
|
|
9536
9595
|
export interface QueryDslRankFeatureFunction {
|
|
@@ -9578,7 +9637,8 @@ export interface QueryDslRegexpQuery extends QueryDslQueryBase {
|
|
|
9578
9637
|
}
|
|
9579
9638
|
export interface QueryDslRuleQuery extends QueryDslQueryBase {
|
|
9580
9639
|
organic: QueryDslQueryContainer;
|
|
9581
|
-
ruleset_ids
|
|
9640
|
+
ruleset_ids?: Id | Id[];
|
|
9641
|
+
ruleset_id?: string;
|
|
9582
9642
|
match_criteria: any;
|
|
9583
9643
|
}
|
|
9584
9644
|
export interface QueryDslScriptQuery extends QueryDslQueryBase {
|
|
@@ -16529,8 +16589,11 @@ export interface ClusterGetSettingsRequest extends RequestBase {
|
|
|
16529
16589
|
};
|
|
16530
16590
|
}
|
|
16531
16591
|
export interface ClusterGetSettingsResponse {
|
|
16592
|
+
/** The settings that persist after the cluster restarts. */
|
|
16532
16593
|
persistent: Record<string, any>;
|
|
16594
|
+
/** The settings that do not persist after the cluster restarts. */
|
|
16533
16595
|
transient: Record<string, any>;
|
|
16596
|
+
/** The default setting values. */
|
|
16534
16597
|
defaults?: Record<string, any>;
|
|
16535
16598
|
}
|
|
16536
16599
|
export interface ClusterHealthHealthResponseBody {
|
|
@@ -16810,7 +16873,9 @@ export interface ClusterPutSettingsRequest extends RequestBase {
|
|
|
16810
16873
|
master_timeout?: Duration;
|
|
16811
16874
|
/** Explicit operation timeout */
|
|
16812
16875
|
timeout?: Duration;
|
|
16876
|
+
/** The settings that persist after the cluster restarts. */
|
|
16813
16877
|
persistent?: Record<string, any>;
|
|
16878
|
+
/** The settings that do not persist after the cluster restarts. */
|
|
16814
16879
|
transient?: Record<string, any>;
|
|
16815
16880
|
/** All values in `body` will be added to the request body. */
|
|
16816
16881
|
body?: string | ({
|
|
@@ -18953,6 +19018,7 @@ export interface EsqlEsqlClusterDetails {
|
|
|
18953
19018
|
indices: string;
|
|
18954
19019
|
took?: DurationValue<UnitMillis>;
|
|
18955
19020
|
_shards?: EsqlEsqlShardInfo;
|
|
19021
|
+
failures?: EsqlEsqlShardFailure[];
|
|
18956
19022
|
}
|
|
18957
19023
|
export interface EsqlEsqlClusterInfo {
|
|
18958
19024
|
total: integer;
|
|
@@ -18983,8 +19049,8 @@ export interface EsqlEsqlResult {
|
|
|
18983
19049
|
profile?: any;
|
|
18984
19050
|
}
|
|
18985
19051
|
export interface EsqlEsqlShardFailure {
|
|
18986
|
-
shard:
|
|
18987
|
-
index: IndexName;
|
|
19052
|
+
shard: integer;
|
|
19053
|
+
index: IndexName | null;
|
|
18988
19054
|
node?: NodeId;
|
|
18989
19055
|
reason: ErrorCause;
|
|
18990
19056
|
}
|
|
@@ -18993,7 +19059,6 @@ export interface EsqlEsqlShardInfo {
|
|
|
18993
19059
|
successful?: integer;
|
|
18994
19060
|
skipped?: integer;
|
|
18995
19061
|
failed?: integer;
|
|
18996
|
-
failures?: EsqlEsqlShardFailure[];
|
|
18997
19062
|
}
|
|
18998
19063
|
export interface EsqlTableValuesContainer {
|
|
18999
19064
|
integer?: EsqlTableValuesIntegerValue[];
|
|
@@ -19014,14 +19079,6 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
19014
19079
|
drop_null_columns?: boolean;
|
|
19015
19080
|
/** A short version of the Accept header, for example `json` or `yaml`. */
|
|
19016
19081
|
format?: EsqlEsqlFormat;
|
|
19017
|
-
/** The period for which the query and its results are stored in the cluster.
|
|
19018
|
-
* The default period is five days.
|
|
19019
|
-
* When this period expires, the query and its results are deleted, even if the query is still ongoing.
|
|
19020
|
-
* If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value. */
|
|
19021
|
-
keep_alive?: Duration;
|
|
19022
|
-
/** Indicates whether the query and its results are stored in the cluster.
|
|
19023
|
-
* If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. */
|
|
19024
|
-
keep_on_completion?: boolean;
|
|
19025
19082
|
/** By default, ES|QL returns results as rows. For example, FROM returns each individual document as one row. For the JSON, YAML, CBOR and smile formats, ES|QL can return the results in a columnar fashion where one row represents all the values of a certain column in the results. */
|
|
19026
19083
|
columnar?: boolean;
|
|
19027
19084
|
/** Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on. */
|
|
@@ -19048,6 +19105,14 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
19048
19105
|
* If the query completes during this period, results are returned
|
|
19049
19106
|
* Otherwise, a query ID is returned that can later be used to retrieve the results. */
|
|
19050
19107
|
wait_for_completion_timeout?: Duration;
|
|
19108
|
+
/** The period for which the query and its results are stored in the cluster.
|
|
19109
|
+
* The default period is five days.
|
|
19110
|
+
* When this period expires, the query and its results are deleted, even if the query is still ongoing.
|
|
19111
|
+
* If the `keep_on_completion` parameter is false, Elasticsearch only stores async queries that do not complete within the period set by the `wait_for_completion_timeout` parameter, regardless of this value. */
|
|
19112
|
+
keep_alive?: Duration;
|
|
19113
|
+
/** Indicates whether the query and its results are stored in the cluster.
|
|
19114
|
+
* If false, the query and its results are stored in the cluster only if the request does not complete during the period set by the `wait_for_completion_timeout` parameter. */
|
|
19115
|
+
keep_on_completion?: boolean;
|
|
19051
19116
|
/** All values in `body` will be added to the request body. */
|
|
19052
19117
|
body?: string | ({
|
|
19053
19118
|
[key: string]: any;
|
|
@@ -19055,8 +19120,6 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
19055
19120
|
delimiter?: never;
|
|
19056
19121
|
drop_null_columns?: never;
|
|
19057
19122
|
format?: never;
|
|
19058
|
-
keep_alive?: never;
|
|
19059
|
-
keep_on_completion?: never;
|
|
19060
19123
|
columnar?: never;
|
|
19061
19124
|
filter?: never;
|
|
19062
19125
|
locale?: never;
|
|
@@ -19066,6 +19129,8 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
19066
19129
|
tables?: never;
|
|
19067
19130
|
include_ccs_metadata?: never;
|
|
19068
19131
|
wait_for_completion_timeout?: never;
|
|
19132
|
+
keep_alive?: never;
|
|
19133
|
+
keep_on_completion?: never;
|
|
19069
19134
|
});
|
|
19070
19135
|
/** All values in `querystring` will be added to the request querystring. */
|
|
19071
19136
|
querystring?: {
|
|
@@ -19074,8 +19139,6 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
19074
19139
|
delimiter?: never;
|
|
19075
19140
|
drop_null_columns?: never;
|
|
19076
19141
|
format?: never;
|
|
19077
|
-
keep_alive?: never;
|
|
19078
|
-
keep_on_completion?: never;
|
|
19079
19142
|
columnar?: never;
|
|
19080
19143
|
filter?: never;
|
|
19081
19144
|
locale?: never;
|
|
@@ -19085,6 +19148,8 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
|
|
19085
19148
|
tables?: never;
|
|
19086
19149
|
include_ccs_metadata?: never;
|
|
19087
19150
|
wait_for_completion_timeout?: never;
|
|
19151
|
+
keep_alive?: never;
|
|
19152
|
+
keep_on_completion?: never;
|
|
19088
19153
|
};
|
|
19089
19154
|
}
|
|
19090
19155
|
export type EsqlAsyncQueryResponse = EsqlAsyncEsqlResult;
|
|
@@ -20404,7 +20469,8 @@ export interface IndicesIndexSettingsKeys {
|
|
|
20404
20469
|
max_shingle_diff?: integer;
|
|
20405
20470
|
blocks?: IndicesIndexSettingBlocks;
|
|
20406
20471
|
max_refresh_listeners?: integer;
|
|
20407
|
-
/** Settings to define analyzers, tokenizers, token filters and character filters.
|
|
20472
|
+
/** Settings to define analyzers, tokenizers, token filters and character filters.
|
|
20473
|
+
* Refer to the linked documentation for step-by-step examples of updating analyzers on existing indices. */
|
|
20408
20474
|
analyze?: IndicesSettingsAnalyze;
|
|
20409
20475
|
highlight?: IndicesSettingsHighlight;
|
|
20410
20476
|
max_terms_count?: integer;
|
|
@@ -20961,8 +21027,7 @@ export interface IndicesClearCacheRequest extends RequestBase {
|
|
|
20961
21027
|
allow_no_indices?: boolean;
|
|
20962
21028
|
/** Type of index that wildcard patterns can match.
|
|
20963
21029
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
20964
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
20965
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
21030
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
20966
21031
|
expand_wildcards?: ExpandWildcards;
|
|
20967
21032
|
/** If `true`, clears the fields cache.
|
|
20968
21033
|
* Use the `fields` parameter to clear the cache of specific fields only. */
|
|
@@ -21066,8 +21131,7 @@ export interface IndicesCloseRequest extends RequestBase {
|
|
|
21066
21131
|
allow_no_indices?: boolean;
|
|
21067
21132
|
/** Type of index that wildcard patterns can match.
|
|
21068
21133
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
21069
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
21070
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
21134
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
21071
21135
|
expand_wildcards?: ExpandWildcards;
|
|
21072
21136
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
21073
21137
|
ignore_unavailable?: boolean;
|
|
@@ -21302,8 +21366,7 @@ export interface IndicesDeleteRequest extends RequestBase {
|
|
|
21302
21366
|
allow_no_indices?: boolean;
|
|
21303
21367
|
/** Type of index that wildcard patterns can match.
|
|
21304
21368
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
21305
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
21306
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
21369
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
21307
21370
|
expand_wildcards?: ExpandWildcards;
|
|
21308
21371
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
21309
21372
|
ignore_unavailable?: boolean;
|
|
@@ -21553,8 +21616,7 @@ export interface IndicesExistsRequest extends RequestBase {
|
|
|
21553
21616
|
allow_no_indices?: boolean;
|
|
21554
21617
|
/** Type of index that wildcard patterns can match.
|
|
21555
21618
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
21556
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
21557
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
21619
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
21558
21620
|
expand_wildcards?: ExpandWildcards;
|
|
21559
21621
|
/** If `true`, returns settings in flat format. */
|
|
21560
21622
|
flat_settings?: boolean;
|
|
@@ -21601,8 +21663,7 @@ export interface IndicesExistsAliasRequest extends RequestBase {
|
|
|
21601
21663
|
allow_no_indices?: boolean;
|
|
21602
21664
|
/** Type of index that wildcard patterns can match.
|
|
21603
21665
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
21604
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
21605
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
21666
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
21606
21667
|
expand_wildcards?: ExpandWildcards;
|
|
21607
21668
|
/** If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. */
|
|
21608
21669
|
ignore_unavailable?: boolean;
|
|
@@ -21817,8 +21878,7 @@ export interface IndicesFlushRequest extends RequestBase {
|
|
|
21817
21878
|
allow_no_indices?: boolean;
|
|
21818
21879
|
/** Type of index that wildcard patterns can match.
|
|
21819
21880
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
21820
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
21821
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
21881
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
21822
21882
|
expand_wildcards?: ExpandWildcards;
|
|
21823
21883
|
/** If `true`, the request forces a flush even if there are no changes to commit to the index. */
|
|
21824
21884
|
force?: boolean;
|
|
@@ -21974,8 +22034,7 @@ export interface IndicesGetAliasRequest extends RequestBase {
|
|
|
21974
22034
|
allow_no_indices?: boolean;
|
|
21975
22035
|
/** Type of index that wildcard patterns can match.
|
|
21976
22036
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
21977
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
21978
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
22037
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
21979
22038
|
expand_wildcards?: ExpandWildcards;
|
|
21980
22039
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
21981
22040
|
ignore_unavailable?: boolean;
|
|
@@ -22016,8 +22075,7 @@ export interface IndicesGetDataLifecycleRequest extends RequestBase {
|
|
|
22016
22075
|
* To target all data streams, omit this parameter or use `*` or `_all`. */
|
|
22017
22076
|
name: DataStreamNames;
|
|
22018
22077
|
/** Type of data stream that wildcard patterns can match.
|
|
22019
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
22020
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
22078
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
22021
22079
|
expand_wildcards?: ExpandWildcards;
|
|
22022
22080
|
/** If `true`, return all default settings in the response. */
|
|
22023
22081
|
include_defaults?: boolean;
|
|
@@ -22124,8 +22182,7 @@ export interface IndicesGetFieldMappingRequest extends RequestBase {
|
|
|
22124
22182
|
allow_no_indices?: boolean;
|
|
22125
22183
|
/** Type of index that wildcard patterns can match.
|
|
22126
22184
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
22127
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
22128
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
22185
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
22129
22186
|
expand_wildcards?: ExpandWildcards;
|
|
22130
22187
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
22131
22188
|
ignore_unavailable?: boolean;
|
|
@@ -22215,8 +22272,7 @@ export interface IndicesGetMappingRequest extends RequestBase {
|
|
|
22215
22272
|
allow_no_indices?: boolean;
|
|
22216
22273
|
/** Type of index that wildcard patterns can match.
|
|
22217
22274
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
22218
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
22219
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
22275
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
22220
22276
|
expand_wildcards?: ExpandWildcards;
|
|
22221
22277
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
22222
22278
|
ignore_unavailable?: boolean;
|
|
@@ -22475,8 +22531,7 @@ export interface IndicesOpenRequest extends RequestBase {
|
|
|
22475
22531
|
allow_no_indices?: boolean;
|
|
22476
22532
|
/** Type of index that wildcard patterns can match.
|
|
22477
22533
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
22478
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
22479
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
22534
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
22480
22535
|
expand_wildcards?: ExpandWildcards;
|
|
22481
22536
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
22482
22537
|
ignore_unavailable?: boolean;
|
|
@@ -22608,8 +22663,7 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase {
|
|
|
22608
22663
|
* To target all data streams use `*` or `_all`. */
|
|
22609
22664
|
name: DataStreamNames;
|
|
22610
22665
|
/** Type of data stream that wildcard patterns can match.
|
|
22611
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
22612
|
-
* Valid values are: `all`, `hidden`, `open`, `closed`, `none`. */
|
|
22666
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
22613
22667
|
expand_wildcards?: ExpandWildcards;
|
|
22614
22668
|
/** Period to wait for a connection to the master node. If no response is
|
|
22615
22669
|
* received before the timeout expires, the request fails and returns an
|
|
@@ -22762,8 +22816,7 @@ export interface IndicesPutMappingRequest extends RequestBase {
|
|
|
22762
22816
|
allow_no_indices?: boolean;
|
|
22763
22817
|
/** Type of index that wildcard patterns can match.
|
|
22764
22818
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
22765
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
22766
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
22819
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
22767
22820
|
expand_wildcards?: ExpandWildcards;
|
|
22768
22821
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
22769
22822
|
ignore_unavailable?: boolean;
|
|
@@ -23106,8 +23159,7 @@ export interface IndicesRefreshRequest extends RequestBase {
|
|
|
23106
23159
|
allow_no_indices?: boolean;
|
|
23107
23160
|
/** Type of index that wildcard patterns can match.
|
|
23108
23161
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
23109
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
23110
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
23162
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
23111
23163
|
expand_wildcards?: ExpandWildcards;
|
|
23112
23164
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
23113
23165
|
ignore_unavailable?: boolean;
|
|
@@ -23189,7 +23241,6 @@ export interface IndicesResolveClusterRequest extends RequestBase {
|
|
|
23189
23241
|
/** Type of index that wildcard patterns can match.
|
|
23190
23242
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
23191
23243
|
* Supports comma-separated values, such as `open,hidden`.
|
|
23192
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
|
23193
23244
|
* NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index
|
|
23194
23245
|
* options to the `_resolve/cluster` API endpoint that takes no index expression. */
|
|
23195
23246
|
expand_wildcards?: ExpandWildcards;
|
|
@@ -23254,8 +23305,7 @@ export interface IndicesResolveIndexRequest extends RequestBase {
|
|
|
23254
23305
|
name: Names;
|
|
23255
23306
|
/** Type of index that wildcard patterns can match.
|
|
23256
23307
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
23257
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
23258
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
23308
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
23259
23309
|
expand_wildcards?: ExpandWildcards;
|
|
23260
23310
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
23261
23311
|
ignore_unavailable?: boolean;
|
|
@@ -23410,8 +23460,7 @@ export interface IndicesSegmentsRequest extends RequestBase {
|
|
|
23410
23460
|
allow_no_indices?: boolean;
|
|
23411
23461
|
/** Type of index that wildcard patterns can match.
|
|
23412
23462
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
23413
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
23414
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
23463
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
23415
23464
|
expand_wildcards?: ExpandWildcards;
|
|
23416
23465
|
/** If `false`, the request returns an error if it targets a missing or closed index. */
|
|
23417
23466
|
ignore_unavailable?: boolean;
|
|
@@ -24080,8 +24129,7 @@ export interface IndicesValidateQueryRequest extends RequestBase {
|
|
|
24080
24129
|
df?: string;
|
|
24081
24130
|
/** Type of index that wildcard patterns can match.
|
|
24082
24131
|
* If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
|
|
24083
|
-
* Supports comma-separated values, such as `open,hidden`.
|
|
24084
|
-
* Valid values are: `all`, `open`, `closed`, `hidden`, `none`. */
|
|
24132
|
+
* Supports comma-separated values, such as `open,hidden`. */
|
|
24085
24133
|
expand_wildcards?: ExpandWildcards;
|
|
24086
24134
|
/** If `true`, the response returns detailed information if an error has occurred. */
|
|
24087
24135
|
explain?: boolean;
|
|
@@ -24603,6 +24651,102 @@ export interface InferenceInferenceEndpointInfo extends InferenceInferenceEndpoi
|
|
|
24603
24651
|
/** The task type */
|
|
24604
24652
|
task_type: InferenceTaskType;
|
|
24605
24653
|
}
|
|
24654
|
+
export interface InferenceInferenceEndpointInfoAlibabaCloudAI extends InferenceInferenceEndpoint {
|
|
24655
|
+
/** The inference Id */
|
|
24656
|
+
inference_id: string;
|
|
24657
|
+
/** The task type */
|
|
24658
|
+
task_type: InferenceTaskTypeAlibabaCloudAI;
|
|
24659
|
+
}
|
|
24660
|
+
export interface InferenceInferenceEndpointInfoAmazonBedrock extends InferenceInferenceEndpoint {
|
|
24661
|
+
/** The inference Id */
|
|
24662
|
+
inference_id: string;
|
|
24663
|
+
/** The task type */
|
|
24664
|
+
task_type: InferenceTaskTypeAmazonBedrock;
|
|
24665
|
+
}
|
|
24666
|
+
export interface InferenceInferenceEndpointInfoAnthropic extends InferenceInferenceEndpoint {
|
|
24667
|
+
/** The inference Id */
|
|
24668
|
+
inference_id: string;
|
|
24669
|
+
/** The task type */
|
|
24670
|
+
task_type: InferenceTaskTypeAnthropic;
|
|
24671
|
+
}
|
|
24672
|
+
export interface InferenceInferenceEndpointInfoAzureAIStudio extends InferenceInferenceEndpoint {
|
|
24673
|
+
/** The inference Id */
|
|
24674
|
+
inference_id: string;
|
|
24675
|
+
/** The task type */
|
|
24676
|
+
task_type: InferenceTaskTypeAzureAIStudio;
|
|
24677
|
+
}
|
|
24678
|
+
export interface InferenceInferenceEndpointInfoAzureOpenAI extends InferenceInferenceEndpoint {
|
|
24679
|
+
/** The inference Id */
|
|
24680
|
+
inference_id: string;
|
|
24681
|
+
/** The task type */
|
|
24682
|
+
task_type: InferenceTaskTypeAzureOpenAI;
|
|
24683
|
+
}
|
|
24684
|
+
export interface InferenceInferenceEndpointInfoCohere extends InferenceInferenceEndpoint {
|
|
24685
|
+
/** The inference Id */
|
|
24686
|
+
inference_id: string;
|
|
24687
|
+
/** The task type */
|
|
24688
|
+
task_type: InferenceTaskTypeCohere;
|
|
24689
|
+
}
|
|
24690
|
+
export interface InferenceInferenceEndpointInfoELSER extends InferenceInferenceEndpoint {
|
|
24691
|
+
/** The inference Id */
|
|
24692
|
+
inference_id: string;
|
|
24693
|
+
/** The task type */
|
|
24694
|
+
task_type: InferenceTaskTypeELSER;
|
|
24695
|
+
}
|
|
24696
|
+
export interface InferenceInferenceEndpointInfoElasticsearch extends InferenceInferenceEndpoint {
|
|
24697
|
+
/** The inference Id */
|
|
24698
|
+
inference_id: string;
|
|
24699
|
+
/** The task type */
|
|
24700
|
+
task_type: InferenceTaskTypeElasticsearch;
|
|
24701
|
+
}
|
|
24702
|
+
export interface InferenceInferenceEndpointInfoGoogleAIStudio extends InferenceInferenceEndpoint {
|
|
24703
|
+
/** The inference Id */
|
|
24704
|
+
inference_id: string;
|
|
24705
|
+
/** The task type */
|
|
24706
|
+
task_type: InferenceTaskTypeGoogleAIStudio;
|
|
24707
|
+
}
|
|
24708
|
+
export interface InferenceInferenceEndpointInfoGoogleVertexAI extends InferenceInferenceEndpoint {
|
|
24709
|
+
/** The inference Id */
|
|
24710
|
+
inference_id: string;
|
|
24711
|
+
/** The task type */
|
|
24712
|
+
task_type: InferenceTaskTypeGoogleVertexAI;
|
|
24713
|
+
}
|
|
24714
|
+
export interface InferenceInferenceEndpointInfoHuggingFace extends InferenceInferenceEndpoint {
|
|
24715
|
+
/** The inference Id */
|
|
24716
|
+
inference_id: string;
|
|
24717
|
+
/** The task type */
|
|
24718
|
+
task_type: InferenceTaskTypeHuggingFace;
|
|
24719
|
+
}
|
|
24720
|
+
export interface InferenceInferenceEndpointInfoJinaAi extends InferenceInferenceEndpoint {
|
|
24721
|
+
/** The inference Id */
|
|
24722
|
+
inference_id: string;
|
|
24723
|
+
/** The task type */
|
|
24724
|
+
task_type: InferenceTaskTypeJinaAi;
|
|
24725
|
+
}
|
|
24726
|
+
export interface InferenceInferenceEndpointInfoMistral extends InferenceInferenceEndpoint {
|
|
24727
|
+
/** The inference Id */
|
|
24728
|
+
inference_id: string;
|
|
24729
|
+
/** The task type */
|
|
24730
|
+
task_type: InferenceTaskTypeMistral;
|
|
24731
|
+
}
|
|
24732
|
+
export interface InferenceInferenceEndpointInfoOpenAI extends InferenceInferenceEndpoint {
|
|
24733
|
+
/** The inference Id */
|
|
24734
|
+
inference_id: string;
|
|
24735
|
+
/** The task type */
|
|
24736
|
+
task_type: InferenceTaskTypeOpenAI;
|
|
24737
|
+
}
|
|
24738
|
+
export interface InferenceInferenceEndpointInfoVoyageAI extends InferenceInferenceEndpoint {
|
|
24739
|
+
/** The inference Id */
|
|
24740
|
+
inference_id: string;
|
|
24741
|
+
/** The task type */
|
|
24742
|
+
task_type: InferenceTaskTypeVoyageAI;
|
|
24743
|
+
}
|
|
24744
|
+
export interface InferenceInferenceEndpointInfoWatsonx extends InferenceInferenceEndpoint {
|
|
24745
|
+
/** The inference Id */
|
|
24746
|
+
inference_id: string;
|
|
24747
|
+
/** The task type */
|
|
24748
|
+
task_type: InferenceTaskTypeWatsonx;
|
|
24749
|
+
}
|
|
24606
24750
|
export interface InferenceInferenceResult {
|
|
24607
24751
|
text_embedding_bytes?: InferenceTextEmbeddingByteResult[];
|
|
24608
24752
|
text_embedding_bits?: InferenceTextEmbeddingByteResult[];
|
|
@@ -24652,13 +24796,47 @@ export interface InferenceJinaAITaskSettings {
|
|
|
24652
24796
|
export type InferenceJinaAITaskType = 'rerank' | 'text_embedding';
|
|
24653
24797
|
export type InferenceJinaAITextEmbeddingTask = 'classification' | 'clustering' | 'ingest' | 'search';
|
|
24654
24798
|
export interface InferenceMessage {
|
|
24655
|
-
/** The content of the message.
|
|
24799
|
+
/** The content of the message.
|
|
24800
|
+
*
|
|
24801
|
+
* String example:
|
|
24802
|
+
* ```
|
|
24803
|
+
* {
|
|
24804
|
+
* "content": "Some string"
|
|
24805
|
+
* }
|
|
24806
|
+
* ```
|
|
24807
|
+
*
|
|
24808
|
+
* Object example:
|
|
24809
|
+
* ```
|
|
24810
|
+
* {
|
|
24811
|
+
* "content": [
|
|
24812
|
+
* {
|
|
24813
|
+
* "text": "Some text",
|
|
24814
|
+
* "type": "text"
|
|
24815
|
+
* }
|
|
24816
|
+
* ]
|
|
24817
|
+
* }
|
|
24818
|
+
* ``` */
|
|
24656
24819
|
content?: InferenceMessageContent;
|
|
24657
|
-
/** The role of the message author. */
|
|
24820
|
+
/** The role of the message author. Valid values are `user`, `assistant`, `system`, and `tool`. */
|
|
24658
24821
|
role: string;
|
|
24659
|
-
/** The tool call that this message is responding to. */
|
|
24822
|
+
/** Only for `tool` role messages. The tool call that this message is responding to. */
|
|
24660
24823
|
tool_call_id?: Id;
|
|
24661
|
-
/** The tool calls generated by the model.
|
|
24824
|
+
/** Only for `assistant` role messages. The tool calls generated by the model. If it's specified, the `content` field is optional.
|
|
24825
|
+
* Example:
|
|
24826
|
+
* ```
|
|
24827
|
+
* {
|
|
24828
|
+
* "tool_calls": [
|
|
24829
|
+
* {
|
|
24830
|
+
* "id": "call_KcAjWtAww20AihPHphUh46Gd",
|
|
24831
|
+
* "type": "function",
|
|
24832
|
+
* "function": {
|
|
24833
|
+
* "name": "get_current_weather",
|
|
24834
|
+
* "arguments": "{\"location\":\"Boston, MA\"}"
|
|
24835
|
+
* }
|
|
24836
|
+
* }
|
|
24837
|
+
* ]
|
|
24838
|
+
* }
|
|
24839
|
+
* ``` */
|
|
24662
24840
|
tool_calls?: InferenceToolCall[];
|
|
24663
24841
|
}
|
|
24664
24842
|
export type InferenceMessageContent = string | InferenceContentObject[];
|
|
@@ -24723,7 +24901,25 @@ export interface InferenceRankedDocument {
|
|
|
24723
24901
|
text?: string;
|
|
24724
24902
|
}
|
|
24725
24903
|
export interface InferenceRateLimitSetting {
|
|
24726
|
-
/** The number of requests allowed per minute.
|
|
24904
|
+
/** The number of requests allowed per minute.
|
|
24905
|
+
* By default, the number of requests allowed per minute is set by each service as follows:
|
|
24906
|
+
*
|
|
24907
|
+
* * `alibabacloud-ai-search` service: `1000`
|
|
24908
|
+
* * `anthropic` service: `50`
|
|
24909
|
+
* * `azureaistudio` service: `240`
|
|
24910
|
+
* * `azureopenai` service and task type `text_embedding`: `1440`
|
|
24911
|
+
* * `azureopenai` service and task type `completion`: `120`
|
|
24912
|
+
* * `cohere` service: `10000`
|
|
24913
|
+
* * `elastic` service and task type `chat_completion`: `240`
|
|
24914
|
+
* * `googleaistudio` service: `360`
|
|
24915
|
+
* * `googlevertexai` service: `30000`
|
|
24916
|
+
* * `hugging_face` service: `3000`
|
|
24917
|
+
* * `jinaai` service: `2000`
|
|
24918
|
+
* * `mistral` service: `240`
|
|
24919
|
+
* * `openai` service and task type `text_embedding`: `3000`
|
|
24920
|
+
* * `openai` service and task type `completion`: `500`
|
|
24921
|
+
* * `voyageai` service: `2000`
|
|
24922
|
+
* * `watsonxai` service: `120` */
|
|
24727
24923
|
requests_per_minute?: integer;
|
|
24728
24924
|
}
|
|
24729
24925
|
export interface InferenceRequestChatCompletion {
|
|
@@ -24739,9 +24935,46 @@ export interface InferenceRequestChatCompletion {
|
|
|
24739
24935
|
stop?: string[];
|
|
24740
24936
|
/** The sampling temperature to use. */
|
|
24741
24937
|
temperature?: float;
|
|
24742
|
-
/** Controls which tool is called by the model.
|
|
24938
|
+
/** Controls which tool is called by the model.
|
|
24939
|
+
* String representation: One of `auto`, `none`, or `requrired`. `auto` allows the model to choose between calling tools and generating a message. `none` causes the model to not call any tools. `required` forces the model to call one or more tools.
|
|
24940
|
+
* Example (object representation):
|
|
24941
|
+
* ```
|
|
24942
|
+
* {
|
|
24943
|
+
* "tool_choice": {
|
|
24944
|
+
* "type": "function",
|
|
24945
|
+
* "function": {
|
|
24946
|
+
* "name": "get_current_weather"
|
|
24947
|
+
* }
|
|
24948
|
+
* }
|
|
24949
|
+
* }
|
|
24950
|
+
* ``` */
|
|
24743
24951
|
tool_choice?: InferenceCompletionToolType;
|
|
24744
|
-
/** A list of tools that the model can call.
|
|
24952
|
+
/** A list of tools that the model can call.
|
|
24953
|
+
* Example:
|
|
24954
|
+
* ```
|
|
24955
|
+
* {
|
|
24956
|
+
* "tools": [
|
|
24957
|
+
* {
|
|
24958
|
+
* "type": "function",
|
|
24959
|
+
* "function": {
|
|
24960
|
+
* "name": "get_price_of_item",
|
|
24961
|
+
* "description": "Get the current price of an item",
|
|
24962
|
+
* "parameters": {
|
|
24963
|
+
* "type": "object",
|
|
24964
|
+
* "properties": {
|
|
24965
|
+
* "item": {
|
|
24966
|
+
* "id": "12345"
|
|
24967
|
+
* },
|
|
24968
|
+
* "unit": {
|
|
24969
|
+
* "type": "currency"
|
|
24970
|
+
* }
|
|
24971
|
+
* }
|
|
24972
|
+
* }
|
|
24973
|
+
* }
|
|
24974
|
+
* }
|
|
24975
|
+
* ]
|
|
24976
|
+
* }
|
|
24977
|
+
* ``` */
|
|
24745
24978
|
tools?: InferenceCompletionTool[];
|
|
24746
24979
|
/** Nucleus sampling, an alternative to sampling with temperature. */
|
|
24747
24980
|
top_p?: float;
|
|
@@ -24759,6 +24992,22 @@ export interface InferenceSparseEmbeddingResult {
|
|
|
24759
24992
|
export type InferenceSparseVector = Record<string, float>;
|
|
24760
24993
|
export type InferenceTaskSettings = any;
|
|
24761
24994
|
export type InferenceTaskType = 'sparse_embedding' | 'text_embedding' | 'rerank' | 'completion' | 'chat_completion';
|
|
24995
|
+
export type InferenceTaskTypeAlibabaCloudAI = 'text_embedding' | 'rerank' | 'completion' | 'sparse_embedding';
|
|
24996
|
+
export type InferenceTaskTypeAmazonBedrock = 'text_embedding' | 'completion';
|
|
24997
|
+
export type InferenceTaskTypeAnthropic = 'completion';
|
|
24998
|
+
export type InferenceTaskTypeAzureAIStudio = 'text_embedding' | 'completion';
|
|
24999
|
+
export type InferenceTaskTypeAzureOpenAI = 'text_embedding' | 'completion';
|
|
25000
|
+
export type InferenceTaskTypeCohere = 'text_embedding' | 'rerank' | 'completion';
|
|
25001
|
+
export type InferenceTaskTypeELSER = 'sparse_embedding';
|
|
25002
|
+
export type InferenceTaskTypeElasticsearch = 'sparse_embedding' | 'text_embedding' | 'rerank';
|
|
25003
|
+
export type InferenceTaskTypeGoogleAIStudio = 'text_embedding' | 'completion';
|
|
25004
|
+
export type InferenceTaskTypeGoogleVertexAI = 'text_embedding' | 'rerank';
|
|
25005
|
+
export type InferenceTaskTypeHuggingFace = 'text_embedding';
|
|
25006
|
+
export type InferenceTaskTypeJinaAi = 'text_embedding' | 'rerank';
|
|
25007
|
+
export type InferenceTaskTypeMistral = 'text_embedding';
|
|
25008
|
+
export type InferenceTaskTypeOpenAI = 'text_embedding' | 'chat_completion' | 'completion';
|
|
25009
|
+
export type InferenceTaskTypeVoyageAI = 'text_embedding' | 'rerank';
|
|
25010
|
+
export type InferenceTaskTypeWatsonx = 'text_embedding';
|
|
24762
25011
|
export interface InferenceTextEmbeddingByteResult {
|
|
24763
25012
|
embedding: InferenceDenseByteVector;
|
|
24764
25013
|
}
|
|
@@ -24996,7 +25245,7 @@ export interface InferenceInferenceRequest extends RequestBase {
|
|
|
24996
25245
|
}
|
|
24997
25246
|
export type InferenceInferenceResponse = InferenceInferenceResult;
|
|
24998
25247
|
export interface InferencePutRequest extends RequestBase {
|
|
24999
|
-
/** The task type */
|
|
25248
|
+
/** The task type. Refer to the integration list in the API description for the available task types. */
|
|
25000
25249
|
task_type?: InferenceTaskType;
|
|
25001
25250
|
/** The inference Id */
|
|
25002
25251
|
inference_id: Id;
|
|
@@ -25056,7 +25305,7 @@ export interface InferencePutAlibabacloudRequest extends RequestBase {
|
|
|
25056
25305
|
task_settings?: never;
|
|
25057
25306
|
};
|
|
25058
25307
|
}
|
|
25059
|
-
export type InferencePutAlibabacloudResponse =
|
|
25308
|
+
export type InferencePutAlibabacloudResponse = InferenceInferenceEndpointInfoAlibabaCloudAI;
|
|
25060
25309
|
export interface InferencePutAmazonbedrockRequest extends RequestBase {
|
|
25061
25310
|
/** The type of the inference task that the model will perform. */
|
|
25062
25311
|
task_type: InferenceAmazonBedrockTaskType;
|
|
@@ -25094,7 +25343,7 @@ export interface InferencePutAmazonbedrockRequest extends RequestBase {
|
|
|
25094
25343
|
task_settings?: never;
|
|
25095
25344
|
};
|
|
25096
25345
|
}
|
|
25097
|
-
export type InferencePutAmazonbedrockResponse =
|
|
25346
|
+
export type InferencePutAmazonbedrockResponse = InferenceInferenceEndpointInfoAmazonBedrock;
|
|
25098
25347
|
export interface InferencePutAnthropicRequest extends RequestBase {
|
|
25099
25348
|
/** The task type.
|
|
25100
25349
|
* The only valid task type for the model to perform is `completion`. */
|
|
@@ -25133,7 +25382,7 @@ export interface InferencePutAnthropicRequest extends RequestBase {
|
|
|
25133
25382
|
task_settings?: never;
|
|
25134
25383
|
};
|
|
25135
25384
|
}
|
|
25136
|
-
export type InferencePutAnthropicResponse =
|
|
25385
|
+
export type InferencePutAnthropicResponse = InferenceInferenceEndpointInfoAnthropic;
|
|
25137
25386
|
export interface InferencePutAzureaistudioRequest extends RequestBase {
|
|
25138
25387
|
/** The type of the inference task that the model will perform. */
|
|
25139
25388
|
task_type: InferenceAzureAiStudioTaskType;
|
|
@@ -25171,7 +25420,7 @@ export interface InferencePutAzureaistudioRequest extends RequestBase {
|
|
|
25171
25420
|
task_settings?: never;
|
|
25172
25421
|
};
|
|
25173
25422
|
}
|
|
25174
|
-
export type InferencePutAzureaistudioResponse =
|
|
25423
|
+
export type InferencePutAzureaistudioResponse = InferenceInferenceEndpointInfoAzureAIStudio;
|
|
25175
25424
|
export interface InferencePutAzureopenaiRequest extends RequestBase {
|
|
25176
25425
|
/** The type of the inference task that the model will perform.
|
|
25177
25426
|
* NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. */
|
|
@@ -25210,7 +25459,7 @@ export interface InferencePutAzureopenaiRequest extends RequestBase {
|
|
|
25210
25459
|
task_settings?: never;
|
|
25211
25460
|
};
|
|
25212
25461
|
}
|
|
25213
|
-
export type InferencePutAzureopenaiResponse =
|
|
25462
|
+
export type InferencePutAzureopenaiResponse = InferenceInferenceEndpointInfoAzureOpenAI;
|
|
25214
25463
|
export interface InferencePutCohereRequest extends RequestBase {
|
|
25215
25464
|
/** The type of the inference task that the model will perform. */
|
|
25216
25465
|
task_type: InferenceCohereTaskType;
|
|
@@ -25249,7 +25498,7 @@ export interface InferencePutCohereRequest extends RequestBase {
|
|
|
25249
25498
|
task_settings?: never;
|
|
25250
25499
|
};
|
|
25251
25500
|
}
|
|
25252
|
-
export type InferencePutCohereResponse =
|
|
25501
|
+
export type InferencePutCohereResponse = InferenceInferenceEndpointInfoCohere;
|
|
25253
25502
|
export interface InferencePutElasticsearchRequest extends RequestBase {
|
|
25254
25503
|
/** The type of the inference task that the model will perform. */
|
|
25255
25504
|
task_type: InferenceElasticsearchTaskType;
|
|
@@ -25288,7 +25537,7 @@ export interface InferencePutElasticsearchRequest extends RequestBase {
|
|
|
25288
25537
|
task_settings?: never;
|
|
25289
25538
|
};
|
|
25290
25539
|
}
|
|
25291
|
-
export type InferencePutElasticsearchResponse =
|
|
25540
|
+
export type InferencePutElasticsearchResponse = InferenceInferenceEndpointInfoElasticsearch;
|
|
25292
25541
|
export interface InferencePutElserRequest extends RequestBase {
|
|
25293
25542
|
/** The type of the inference task that the model will perform. */
|
|
25294
25543
|
task_type: InferenceElserTaskType;
|
|
@@ -25321,7 +25570,7 @@ export interface InferencePutElserRequest extends RequestBase {
|
|
|
25321
25570
|
service_settings?: never;
|
|
25322
25571
|
};
|
|
25323
25572
|
}
|
|
25324
|
-
export type InferencePutElserResponse =
|
|
25573
|
+
export type InferencePutElserResponse = InferenceInferenceEndpointInfoELSER;
|
|
25325
25574
|
export interface InferencePutGoogleaistudioRequest extends RequestBase {
|
|
25326
25575
|
/** The type of the inference task that the model will perform. */
|
|
25327
25576
|
task_type: InferenceGoogleAiStudioTaskType;
|
|
@@ -25354,7 +25603,7 @@ export interface InferencePutGoogleaistudioRequest extends RequestBase {
|
|
|
25354
25603
|
service_settings?: never;
|
|
25355
25604
|
};
|
|
25356
25605
|
}
|
|
25357
|
-
export type InferencePutGoogleaistudioResponse =
|
|
25606
|
+
export type InferencePutGoogleaistudioResponse = InferenceInferenceEndpointInfoGoogleAIStudio;
|
|
25358
25607
|
export interface InferencePutGooglevertexaiRequest extends RequestBase {
|
|
25359
25608
|
/** The type of the inference task that the model will perform. */
|
|
25360
25609
|
task_type: InferenceGoogleVertexAITaskType;
|
|
@@ -25392,7 +25641,7 @@ export interface InferencePutGooglevertexaiRequest extends RequestBase {
|
|
|
25392
25641
|
task_settings?: never;
|
|
25393
25642
|
};
|
|
25394
25643
|
}
|
|
25395
|
-
export type InferencePutGooglevertexaiResponse =
|
|
25644
|
+
export type InferencePutGooglevertexaiResponse = InferenceInferenceEndpointInfoGoogleVertexAI;
|
|
25396
25645
|
export interface InferencePutHuggingFaceRequest extends RequestBase {
|
|
25397
25646
|
/** The type of the inference task that the model will perform. */
|
|
25398
25647
|
task_type: InferenceHuggingFaceTaskType;
|
|
@@ -25425,7 +25674,7 @@ export interface InferencePutHuggingFaceRequest extends RequestBase {
|
|
|
25425
25674
|
service_settings?: never;
|
|
25426
25675
|
};
|
|
25427
25676
|
}
|
|
25428
|
-
export type InferencePutHuggingFaceResponse =
|
|
25677
|
+
export type InferencePutHuggingFaceResponse = InferenceInferenceEndpointInfoHuggingFace;
|
|
25429
25678
|
export interface InferencePutJinaaiRequest extends RequestBase {
|
|
25430
25679
|
/** The type of the inference task that the model will perform. */
|
|
25431
25680
|
task_type: InferenceJinaAITaskType;
|
|
@@ -25463,7 +25712,7 @@ export interface InferencePutJinaaiRequest extends RequestBase {
|
|
|
25463
25712
|
task_settings?: never;
|
|
25464
25713
|
};
|
|
25465
25714
|
}
|
|
25466
|
-
export type InferencePutJinaaiResponse =
|
|
25715
|
+
export type InferencePutJinaaiResponse = InferenceInferenceEndpointInfoJinaAi;
|
|
25467
25716
|
export interface InferencePutMistralRequest extends RequestBase {
|
|
25468
25717
|
/** The task type.
|
|
25469
25718
|
* The only valid task type for the model to perform is `text_embedding`. */
|
|
@@ -25497,7 +25746,7 @@ export interface InferencePutMistralRequest extends RequestBase {
|
|
|
25497
25746
|
service_settings?: never;
|
|
25498
25747
|
};
|
|
25499
25748
|
}
|
|
25500
|
-
export type InferencePutMistralResponse =
|
|
25749
|
+
export type InferencePutMistralResponse = InferenceInferenceEndpointInfoMistral;
|
|
25501
25750
|
export interface InferencePutOpenaiRequest extends RequestBase {
|
|
25502
25751
|
/** The type of the inference task that the model will perform.
|
|
25503
25752
|
* NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. */
|
|
@@ -25536,7 +25785,7 @@ export interface InferencePutOpenaiRequest extends RequestBase {
|
|
|
25536
25785
|
task_settings?: never;
|
|
25537
25786
|
};
|
|
25538
25787
|
}
|
|
25539
|
-
export type InferencePutOpenaiResponse =
|
|
25788
|
+
export type InferencePutOpenaiResponse = InferenceInferenceEndpointInfoOpenAI;
|
|
25540
25789
|
export interface InferencePutVoyageaiRequest extends RequestBase {
|
|
25541
25790
|
/** The type of the inference task that the model will perform. */
|
|
25542
25791
|
task_type: InferenceVoyageAITaskType;
|
|
@@ -25574,7 +25823,7 @@ export interface InferencePutVoyageaiRequest extends RequestBase {
|
|
|
25574
25823
|
task_settings?: never;
|
|
25575
25824
|
};
|
|
25576
25825
|
}
|
|
25577
|
-
export type InferencePutVoyageaiResponse =
|
|
25826
|
+
export type InferencePutVoyageaiResponse = InferenceInferenceEndpointInfoVoyageAI;
|
|
25578
25827
|
export interface InferencePutWatsonxRequest extends RequestBase {
|
|
25579
25828
|
/** The task type.
|
|
25580
25829
|
* The only valid task type for the model to perform is `text_embedding`. */
|
|
@@ -25604,7 +25853,7 @@ export interface InferencePutWatsonxRequest extends RequestBase {
|
|
|
25604
25853
|
service_settings?: never;
|
|
25605
25854
|
};
|
|
25606
25855
|
}
|
|
25607
|
-
export type InferencePutWatsonxResponse =
|
|
25856
|
+
export type InferencePutWatsonxResponse = InferenceInferenceEndpointInfoWatsonx;
|
|
25608
25857
|
export interface InferenceRerankRequest extends RequestBase {
|
|
25609
25858
|
/** The unique identifier for the inference endpoint. */
|
|
25610
25859
|
inference_id: Id;
|
|
@@ -31589,13 +31838,7 @@ export interface MlPutJobRequest extends RequestBase {
|
|
|
31589
31838
|
* `_all` string or when no indices are specified. */
|
|
31590
31839
|
allow_no_indices?: boolean;
|
|
31591
31840
|
/** Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
|
|
31592
|
-
* whether wildcard expressions match hidden data streams. Supports comma-separated values.
|
|
31593
|
-
*
|
|
31594
|
-
* * `all`: Match any data stream or index, including hidden ones.
|
|
31595
|
-
* * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
|
|
31596
|
-
* * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
31597
|
-
* * `none`: Wildcard patterns are not accepted.
|
|
31598
|
-
* * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. */
|
|
31841
|
+
* whether wildcard expressions match hidden data streams. Supports comma-separated values. */
|
|
31599
31842
|
expand_wildcards?: ExpandWildcards;
|
|
31600
31843
|
/** If `true`, concrete, expanded or aliased indices are ignored when frozen. */
|
|
31601
31844
|
ignore_throttled?: boolean;
|
|
@@ -32346,13 +32589,7 @@ export interface MlUpdateDatafeedRequest extends RequestBase {
|
|
|
32346
32589
|
* `_all` string or when no indices are specified. */
|
|
32347
32590
|
allow_no_indices?: boolean;
|
|
32348
32591
|
/** Type of index that wildcard patterns can match. If the request can target data streams, this argument determines
|
|
32349
|
-
* whether wildcard expressions match hidden data streams. Supports comma-separated values.
|
|
32350
|
-
*
|
|
32351
|
-
* * `all`: Match any data stream or index, including hidden ones.
|
|
32352
|
-
* * `closed`: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.
|
|
32353
|
-
* * `hidden`: Match hidden data streams and hidden indices. Must be combined with `open`, `closed`, or both.
|
|
32354
|
-
* * `none`: Wildcard patterns are not accepted.
|
|
32355
|
-
* * `open`: Match open, non-hidden indices. Also matches any non-hidden data stream. */
|
|
32592
|
+
* whether wildcard expressions match hidden data streams. Supports comma-separated values. */
|
|
32356
32593
|
expand_wildcards?: ExpandWildcards;
|
|
32357
32594
|
/** If `true`, concrete, expanded or aliased indices are ignored when frozen. */
|
|
32358
32595
|
ignore_throttled?: boolean;
|
|
@@ -38250,6 +38487,13 @@ export interface SlmSnapshotLifecycle {
|
|
|
38250
38487
|
version: VersionNumber;
|
|
38251
38488
|
stats: SlmStatistics;
|
|
38252
38489
|
}
|
|
38490
|
+
export interface SlmSnapshotPolicyStats {
|
|
38491
|
+
policy: string;
|
|
38492
|
+
snapshots_taken: long;
|
|
38493
|
+
snapshots_failed: long;
|
|
38494
|
+
snapshots_deleted: long;
|
|
38495
|
+
snapshot_deletion_failures: long;
|
|
38496
|
+
}
|
|
38253
38497
|
export interface SlmStatistics {
|
|
38254
38498
|
retention_deletion_time?: Duration;
|
|
38255
38499
|
retention_deletion_time_millis?: DurationValue<UnitMillis>;
|
|
@@ -38406,7 +38650,7 @@ export interface SlmGetStatsResponse {
|
|
|
38406
38650
|
total_snapshot_deletion_failures: long;
|
|
38407
38651
|
total_snapshots_failed: long;
|
|
38408
38652
|
total_snapshots_taken: long;
|
|
38409
|
-
policy_stats:
|
|
38653
|
+
policy_stats: SlmSnapshotPolicyStats[];
|
|
38410
38654
|
}
|
|
38411
38655
|
export interface SlmGetStatusRequest extends RequestBase {
|
|
38412
38656
|
/** The period to wait for a connection to the master node.
|
|
@@ -38829,7 +39073,7 @@ export interface SnapshotSnapshotShardFailure {
|
|
|
38829
39073
|
index: IndexName;
|
|
38830
39074
|
node_id?: Id;
|
|
38831
39075
|
reason: string;
|
|
38832
|
-
shard_id:
|
|
39076
|
+
shard_id: integer;
|
|
38833
39077
|
index_uuid: Id;
|
|
38834
39078
|
status: string;
|
|
38835
39079
|
}
|