Auto-generated API code (#2618)
This commit is contained in:
Elastic Machine
@ -1730,7 +1730,7 @@ client.search({ ... })
|
||||
** *`rescore` (Optional, { window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[])*: Can be used to improve precision by reordering just the top (for example 100 - 500) documents returned by the `query` and `post_filter` phases.
|
||||
** *`retriever` (Optional, { standard, knn, rrf, text_similarity_reranker, rule })*: A retriever is a specification to describe top documents returned from a search. A retriever replaces other elements of the search API that also return top documents such as `query` and `knn`.
|
||||
** *`script_fields` (Optional, Record<string, { script, ignore_failure }>)*: Retrieve a script evaluation (based on different fields) for each hit.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Used to retrieve the next page of hits using a set of sort values from the previous page.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*: Used to retrieve the next page of hits using a set of sort values from the previous page.
|
||||
** *`size` (Optional, number)*: The number of hits to return, which must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. To page through more hits, use the `search_after` property.
|
||||
** *`slice` (Optional, { field, id, max })*: Split a scrolled search into multiple slices that can be consumed independently.
|
||||
** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])*: A list of <field>:<direction> pairs.
|
||||
@ -2424,7 +2424,7 @@ not included in the search results.
|
||||
** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Defines the search definition using the Query DSL.
|
||||
** *`rescore` (Optional, { window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[])*
|
||||
** *`script_fields` (Optional, Record<string, { script, ignore_failure }>)*: Retrieve a script evaluation (based on different fields) for each hit.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*
|
||||
** *`size` (Optional, number)*: The number of hits to return. By default, you cannot page through more
|
||||
than 10,000 hits using the from and size parameters. To page through more
|
||||
hits, use the search_after parameter.
|
||||
@ -4990,13 +4990,16 @@ client.esql.asyncQuery({ query })
|
||||
** *`columnar` (Optional, boolean)*: 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.
|
||||
** *`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.
|
||||
** *`locale` (Optional, string)*
|
||||
** *`params` (Optional, number | number | string | boolean | null | User-defined value[])*: To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
|
||||
** *`params` (Optional, number | number | string | boolean | null[])*: To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
|
||||
** *`profile` (Optional, boolean)*: If provided and `true` the response will include an extra `profile` object
|
||||
with information on how the query was executed. This information is for human debugging
|
||||
and its format can change at any time but it can give some insight into the performance
|
||||
of each part of the query.
|
||||
** *`tables` (Optional, Record<string, Record<string, { integer, keyword, long, double }>>)*: Tables to use with the LOOKUP operation. The top level key is the table
|
||||
name and the next level key is the column name.
|
||||
** *`include_ccs_metadata` (Optional, boolean)*: When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
|
||||
object with information about the clusters that participated in the search along with info such as shards
|
||||
count.
|
||||
** *`delimiter` (Optional, string)*: The character to use between values within a CSV row.
|
||||
It is valid only for the CSV format.
|
||||
** *`drop_null_columns` (Optional, boolean)*: Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results.
|
||||
@ -5108,13 +5111,16 @@ client.esql.query({ query })
|
||||
** *`columnar` (Optional, boolean)*: 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.
|
||||
** *`filter` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Specify a Query DSL query in the filter parameter to filter the set of documents that an ES|QL query runs on.
|
||||
** *`locale` (Optional, string)*
|
||||
** *`params` (Optional, number | number | string | boolean | null | User-defined value[])*: To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
|
||||
** *`params` (Optional, number | number | string | boolean | null[])*: To avoid any attempts of hacking or code injection, extract the values in a separate list of parameters. Use question mark placeholders (?) in the query string for each of the parameters.
|
||||
** *`profile` (Optional, boolean)*: If provided and `true` the response will include an extra `profile` object
|
||||
with information on how the query was executed. This information is for human debugging
|
||||
and its format can change at any time but it can give some insight into the performance
|
||||
of each part of the query.
|
||||
** *`tables` (Optional, Record<string, Record<string, { integer, keyword, long, double }>>)*: Tables to use with the LOOKUP operation. The top level key is the table
|
||||
name and the next level key is the column name.
|
||||
** *`include_ccs_metadata` (Optional, boolean)*: When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters`
|
||||
object with information about the clusters that participated in the search along with info such as shards
|
||||
count.
|
||||
** *`format` (Optional, Enum("csv" | "json" | "tsv" | "txt" | "yaml" | "cbor" | "smile" | "arrow"))*: A short version of the Accept header, e.g. json, yaml.
|
||||
** *`delimiter` (Optional, string)*: The character to use between values within a CSV row. Only valid for the CSV format.
|
||||
** *`drop_null_columns` (Optional, boolean)*: Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results?
|
||||
@ -5284,7 +5290,7 @@ not included in the search results.
|
||||
** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: Defines the search definition using the Query DSL.
|
||||
** *`rescore` (Optional, { window_size, query, learning_to_rank } | { window_size, query, learning_to_rank }[])*
|
||||
** *`script_fields` (Optional, Record<string, { script, ignore_failure }>)*: Retrieve a script evaluation (based on different fields) for each hit.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*
|
||||
** *`size` (Optional, number)*: The number of hits to return. By default, you cannot page through more
|
||||
than 10,000 hits using the from and size parameters. To page through more
|
||||
hits, use the search_after parameter.
|
||||
@ -12932,7 +12938,7 @@ It must not be negative.
|
||||
The `size` parameter can be set to `0`, in which case no API key matches are returned, only the aggregation results.
|
||||
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
|
||||
To page through more hits, use the `search_after` parameter.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: The search after definition.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*: The search after definition.
|
||||
** *`with_limited_by` (Optional, boolean)*: Return the snapshot of the owner user's role descriptors associated with the API key.
|
||||
An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it).
|
||||
An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.
|
||||
@ -12977,7 +12983,7 @@ In addition, sort can also be applied to the `_doc` field to sort by index order
|
||||
It must not be negative.
|
||||
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
|
||||
To page through more hits, use the `search_after` parameter.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: The search after definition.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*: The search after definition.
|
||||
|
||||
[discrete]
|
||||
==== query_user
|
||||
@ -13015,7 +13021,7 @@ In addition, sort can also be applied to the `_doc` field to sort by index order
|
||||
It must not be negative.
|
||||
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
|
||||
To page through more hits, use the `search_after` parameter.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: The search after definition
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*: The search after definition
|
||||
** *`with_profile_uid` (Optional, boolean)*: Determines whether to retrieve the user profile UID, if it exists, for the users.
|
||||
|
||||
[discrete]
|
||||
@ -15757,7 +15763,7 @@ It must be non-negative.
|
||||
It must be non-negative.
|
||||
** *`query` (Optional, { bool, boosting, common, combined_fields, constant_score, dis_max, distance_feature, exists, function_score, fuzzy, geo_bounding_box, geo_distance, geo_polygon, geo_shape, has_child, has_parent, ids, intervals, knn, match, match_all, match_bool_prefix, match_none, match_phrase, match_phrase_prefix, more_like_this, multi_match, nested, parent_id, percolate, pinned, prefix, query_string, range, rank_feature, regexp, rule, script, script_score, semantic, shape, simple_query_string, span_containing, span_field_masking, span_first, span_multi, span_near, span_not, span_or, span_term, span_within, sparse_vector, term, terms, terms_set, text_expansion, weighted_tokens, wildcard, wrapper, type })*: A query that filters the watches to be returned.
|
||||
** *`sort` (Optional, string | { _score, _doc, _geo_distance, _script } | string | { _score, _doc, _geo_distance, _script }[])*: One or more fields used to sort the search results.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null | User-defined value[])*: Retrieve the next page of hits using a set of sort values from the previous page.
|
||||
** *`search_after` (Optional, number | number | string | boolean | null[])*: Retrieve the next page of hits using a set of sort values from the previous page.
|
||||
|
||||
[discrete]
|
||||
==== start
|
||||
|
||||
@ -52,7 +52,7 @@ export default class Esql {
|
||||
async asyncQuery (this: That, params: T.EsqlAsyncQueryRequest, options?: TransportRequestOptions): Promise<T.EsqlAsyncQueryResponse>
|
||||
async asyncQuery (this: That, params: T.EsqlAsyncQueryRequest, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = []
|
||||
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables']
|
||||
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables', 'include_ccs_metadata']
|
||||
const userQuery = params?.querystring
|
||||
const querystring: Record<string, any> = userQuery != null ? { ...userQuery } : {}
|
||||
|
||||
@ -222,7 +222,7 @@ export default class Esql {
|
||||
async query (this: That, params: T.EsqlQueryRequest, options?: TransportRequestOptions): Promise<T.EsqlQueryResponse>
|
||||
async query (this: That, params: T.EsqlQueryRequest, options?: TransportRequestOptions): Promise<any> {
|
||||
const acceptedPath: string[] = []
|
||||
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables']
|
||||
const acceptedBody: string[] = ['columnar', 'filter', 'locale', 'params', 'profile', 'query', 'tables', 'include_ccs_metadata']
|
||||
const userQuery = params?.querystring
|
||||
const querystring: Record<string, any> = userQuery != null ? { ...userQuery } : {}
|
||||
|
||||
|
||||
@ -1992,7 +1992,7 @@ export interface SearchHit<TDocument = unknown> {
|
||||
matched_queries?: string[] | Record<string, double>
|
||||
_nested?: SearchNestedIdentity
|
||||
_ignored?: string[]
|
||||
ignored_field_values?: Record<string, FieldValue[]>
|
||||
ignored_field_values?: Record<string, any[]>
|
||||
_shard?: string
|
||||
_node?: string
|
||||
_routing?: string
|
||||
@ -2939,7 +2939,7 @@ export interface FieldSort {
|
||||
|
||||
export type FieldSortNumericType = 'long' | 'double' | 'date' | 'date_nanos'
|
||||
|
||||
export type FieldValue = long | double | string | boolean | null | any
|
||||
export type FieldValue = long | double | string | boolean | null
|
||||
|
||||
export interface FielddataStats {
|
||||
evictions?: long
|
||||
@ -11872,10 +11872,12 @@ export interface EsqlAsyncQueryRequest extends RequestBase {
|
||||
query: string
|
||||
/** Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name. */
|
||||
tables?: Record<string, Record<string, EsqlTableValuesContainer>>
|
||||
/** When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count. */
|
||||
include_ccs_metadata?: boolean
|
||||
/** All values in `body` will be added to the request body. */
|
||||
body?: string | { [key: string]: any } & { delimiter?: never, drop_null_columns?: never, format?: never, keep_alive?: never, keep_on_completion?: never, wait_for_completion_timeout?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never }
|
||||
body?: string | { [key: string]: any } & { delimiter?: never, drop_null_columns?: never, format?: never, keep_alive?: never, keep_on_completion?: never, wait_for_completion_timeout?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never, include_ccs_metadata?: never }
|
||||
/** All values in `querystring` will be added to the request querystring. */
|
||||
querystring?: { [key: string]: any } & { delimiter?: never, drop_null_columns?: never, format?: never, keep_alive?: never, keep_on_completion?: never, wait_for_completion_timeout?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never }
|
||||
querystring?: { [key: string]: any } & { delimiter?: never, drop_null_columns?: never, format?: never, keep_alive?: never, keep_on_completion?: never, wait_for_completion_timeout?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never, include_ccs_metadata?: never }
|
||||
}
|
||||
|
||||
export type EsqlAsyncQueryResponse = EsqlResult
|
||||
@ -11941,10 +11943,12 @@ export interface EsqlQueryRequest extends RequestBase {
|
||||
query: string
|
||||
/** Tables to use with the LOOKUP operation. The top level key is the table name and the next level key is the column name. */
|
||||
tables?: Record<string, Record<string, EsqlTableValuesContainer>>
|
||||
/** When set to `true` and performing a cross-cluster query, the response will include an extra `_clusters` object with information about the clusters that participated in the search along with info such as shards count. */
|
||||
include_ccs_metadata?: boolean
|
||||
/** All values in `body` will be added to the request body. */
|
||||
body?: string | { [key: string]: any } & { format?: never, delimiter?: never, drop_null_columns?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never }
|
||||
body?: string | { [key: string]: any } & { format?: never, delimiter?: never, drop_null_columns?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never, include_ccs_metadata?: never }
|
||||
/** All values in `querystring` will be added to the request querystring. */
|
||||
querystring?: { [key: string]: any } & { format?: never, delimiter?: never, drop_null_columns?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never }
|
||||
querystring?: { [key: string]: any } & { format?: never, delimiter?: never, drop_null_columns?: never, columnar?: never, filter?: never, locale?: never, params?: never, profile?: never, query?: never, tables?: never, include_ccs_metadata?: never }
|
||||
}
|
||||
|
||||
export type EsqlQueryResponse = EsqlResult
|
||||
@ -12348,7 +12352,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
|
||||
age?: Duration
|
||||
failed_step?: Name
|
||||
failed_step_retry_count?: integer
|
||||
index?: IndexName
|
||||
index: IndexName
|
||||
index_creation_date?: DateTime
|
||||
index_creation_date_millis?: EpochTime<UnitMillis>
|
||||
is_auto_retryable_error?: boolean
|
||||
@ -12358,7 +12362,11 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
|
||||
phase: Name
|
||||
phase_time?: DateTime
|
||||
phase_time_millis?: EpochTime<UnitMillis>
|
||||
policy: Name
|
||||
policy?: Name
|
||||
previous_step_info?: Record<string, any>
|
||||
repository_name?: string
|
||||
snapshot_name?: string
|
||||
shrink_index_name?: string
|
||||
step?: Name
|
||||
step_info?: Record<string, any>
|
||||
step_time?: DateTime
|
||||
@ -12368,6 +12376,7 @@ export interface IlmExplainLifecycleLifecycleExplainManaged {
|
||||
}
|
||||
|
||||
export interface IlmExplainLifecycleLifecycleExplainPhaseExecution {
|
||||
phase_definition?: IlmPhase
|
||||
policy: Name
|
||||
version: VersionNumber
|
||||
modified_date_in_millis: EpochTime<UnitMillis>
|
||||
@ -15066,7 +15075,7 @@ export interface InferenceInferenceResult {
|
||||
|
||||
export interface InferenceRankedDocument {
|
||||
index: integer
|
||||
score: float
|
||||
relevance_score: float
|
||||
text?: string
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user