diff --git a/docs/reference.asciidoc b/docs/reference.asciidoc index 612db6d1b..4bc780a89 100644 --- a/docs/reference.asciidoc +++ b/docs/reference.asciidoc @@ -2868,6 +2868,28 @@ client.eql.search({ index, query }) [discrete] === esql +[discrete] +==== async_query +Executes an ESQL request asynchronously + +{ref}/esql-async-query-api.html[Endpoint documentation] +[source,ts] +---- +client.esql.asyncQuery() +---- + + +[discrete] +==== async_query_get +Retrieves the results of a previously submitted async query request given its ID. + +{ref}/esql-async-query-get-api.html[Endpoint documentation] +[source,ts] +---- +client.esql.asyncQueryGet() +---- + + [discrete] ==== query Executes an ESQL request @@ -2916,24 +2938,6 @@ client.features.resetFeatures() [discrete] === fleet -[discrete] -==== delete_secret -Deletes a secret stored by Fleet. -[source,ts] ----- -client.fleet.deleteSecret() ----- - - -[discrete] -==== get_secret -Retrieves a secret stored by Fleet. -[source,ts] ----- -client.fleet.getSecret() ----- - - [discrete] ==== global_checkpoints Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. @@ -2990,15 +2994,6 @@ Elasticsearch to immediately execute the search. an error with no partial results. Defaults to the configured cluster setting `search.default_allow_partial_results` which is true by default. -[discrete] -==== post_secret -Creates a secret stored by Fleet. -[source,ts] ----- -client.fleet.postSecret() ----- - - [discrete] ==== search Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. @@ -4854,6 +4849,83 @@ Valid values are: `all`, `open`, `closed`, `hidden`, `none`. ** *`rewrite` (Optional, boolean)*: If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. ** *`q` (Optional, string)*: Query in the Lucene query string syntax. +[discrete] +=== inference +[discrete] +==== delete_model +Delete model in the Inference API + +{ref}/delete-inference-api.html[Endpoint documentation] +[source,ts] +---- +client.inference.deleteModel({ inference_id }) +---- + +[discrete] +==== Arguments + +* *Request (object):* +** *`inference_id` (string)*: The inference Id +** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type + +[discrete] +==== get_model +Get a model in the Inference API + +{ref}/get-inference-api.html[Endpoint documentation] +[source,ts] +---- +client.inference.getModel({ inference_id }) +---- + +[discrete] +==== Arguments + +* *Request (object):* +** *`inference_id` (string)*: The inference Id +** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type + +[discrete] +==== inference +Perform inference on a model + +{ref}/post-inference-api.html[Endpoint documentation] +[source,ts] +---- +client.inference.inference({ inference_id, input }) +---- + +[discrete] +==== Arguments + +* *Request (object):* +** *`inference_id` (string)*: The inference Id +** *`input` (string | string[])*: Text input to the model. +Either a string or an array of strings. +** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type +** *`query` (Optional, string)*: Query input, required for rerank task. +Not required for other tasks. +** *`task_settings` (Optional, User-defined value)*: Optional task settings +** *`timeout` (Optional, string | -1 | 0)*: Specifies the amount of time to wait for the inference request to complete. + +[discrete] +==== put_model +Configure a model for use in the Inference API + +{ref}/put-inference-api.html[Endpoint documentation] +[source,ts] +---- +client.inference.putModel({ inference_id }) +---- + +[discrete] +==== Arguments + +* *Request (object):* +** *`inference_id` (string)*: The inference Id +** *`task_type` (Optional, Enum("sparse_embedding" | "text_embedding" | "rerank" | "completion"))*: The task type +** *`model_config` (Optional, { service, service_settings, task_settings })* + [discrete] === ingest [discrete] @@ -6988,46 +7060,6 @@ client.ml.upgradeJobSnapshot({ job_id, snapshot_id }) Otherwise, it responds as soon as the upgrade task is assigned to a node. ** *`timeout` (Optional, string | -1 | 0)*: Controls the time to wait for the request to complete. -[discrete] -==== validate -Validates an anomaly detection job. - -https://www.elastic.co/guide/en/machine-learning/8.14/ml-jobs.html[Endpoint documentation] -[source,ts] ----- -client.ml.validate({ ... }) ----- - -[discrete] -==== Arguments - -* *Request (object):* -** *`job_id` (Optional, string)* -** *`analysis_config` (Optional, { bucket_span, categorization_analyzer, categorization_field_name, categorization_filters, detectors, influencers, latency, model_prune_window, multivariate_by_fields, per_partition_categorization, summary_count_field_name })* -** *`analysis_limits` (Optional, { categorization_examples_limit, model_memory_limit })* -** *`data_description` (Optional, { format, time_field, time_format, field_delimiter })* -** *`description` (Optional, string)* -** *`model_plot` (Optional, { annotations_enabled, enabled, terms })* -** *`model_snapshot_id` (Optional, string)* -** *`model_snapshot_retention_days` (Optional, number)* -** *`results_index_name` (Optional, string)* - -[discrete] -==== validate_detector -Validates an anomaly detection detector. - -https://www.elastic.co/guide/en/machine-learning/8.14/ml-jobs.html[Endpoint documentation] -[source,ts] ----- -client.ml.validateDetector({ ... }) ----- - -[discrete] -==== Arguments - -* *Request (object):* -** *`detector` (Optional, { by_field_name, custom_rules, detector_description, detector_index, exclude_frequent, field_name, function, over_field_name, partition_field_name, use_null })* - [discrete] === monitoring [discrete] @@ -7202,52 +7234,6 @@ A list of the following options: `_all`, `rest_actions`. ** *`timeout` (Optional, string | -1 | 0)*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. -[discrete] -=== profiling -[discrete] -==== flamegraph -Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. - -https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation] -[source,ts] ----- -client.profiling.flamegraph() ----- - - -[discrete] -==== stacktraces -Extracts raw stacktrace information from Universal Profiling. - -https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation] -[source,ts] ----- -client.profiling.stacktraces() ----- - - -[discrete] -==== status -Returns basic information about the status of Universal Profiling. - -https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation] -[source,ts] ----- -client.profiling.status() ----- - - -[discrete] -==== topn_functions -Extracts a list of topN functions from Universal Profiling. - -https://www.elastic.co/guide/en/observability/8.14/universal-profiling.html[Endpoint documentation] -[source,ts] ----- -client.profiling.topnFunctions() ----- - - [discrete] === query_ruleset [discrete] @@ -7567,6 +7553,17 @@ client.searchApplication.list({ ... }) ** *`from` (Optional, number)*: Starting offset. ** *`size` (Optional, number)*: Specifies a max number of results to get. +[discrete] +==== post_behavioral_analytics_event +Creates a behavioral analytics event for existing collection. + +http://todo.com/tbd[Endpoint documentation] +[source,ts] +---- +client.searchApplication.postBehavioralAnalyticsEvent() +---- + + [discrete] ==== put Creates or updates a search application. @@ -7601,6 +7598,17 @@ client.searchApplication.putBehavioralAnalytics({ name }) * *Request (object):* ** *`name` (string)*: The name of the analytics collection to be created or updated. +[discrete] +==== render_query +Renders a query for given search application search parameters + +{ref}/search-application-render-query.html[Endpoint documentation] +[source,ts] +---- +client.searchApplication.renderQuery() +---- + + [discrete] ==== search Perform a search against a search application @@ -7732,6 +7740,17 @@ client.security.authenticate() ---- +[discrete] +==== bulk_update_api_keys +Updates the attributes of multiple existing API keys. + +{ref}/security-api-bulk-update-api-keys.html[Endpoint documentation] +[source,ts] +---- +client.security.bulkUpdateApiKeys() +---- + + [discrete] ==== change_password Changes the passwords of users in the native realm and built-in users. @@ -7860,6 +7879,17 @@ client.security.createApiKey({ ... }) ** *`metadata` (Optional, Record)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with `_` are reserved for system usage. ** *`refresh` (Optional, Enum(true | false | "wait_for"))*: If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. +[discrete] +==== create_cross_cluster_api_key +Creates a cross-cluster API key for API key based remote cluster access. + +{ref}/security-api-create-cross-cluster-api-key.html[Endpoint documentation] +[source,ts] +---- +client.security.createCrossClusterApiKey() +---- + + [discrete] ==== create_service_token Creates a service account token for access without requiring basic authentication. @@ -8187,6 +8217,17 @@ client.security.getServiceCredentials({ namespace, service }) ** *`namespace` (string)*: Name of the namespace. ** *`service` (string)*: Name of the service name. +[discrete] +==== get_settings +Retrieve settings for the security system indices + +{ref}/security-api-get-settings.html[Endpoint documentation] +[source,ts] +---- +client.security.getSettings() +---- + + [discrete] ==== get_token Creates a bearer token for access without requiring basic authentication. @@ -8370,6 +8411,39 @@ client.security.invalidateToken({ ... }) ** *`realm_name` (Optional, string)* ** *`username` (Optional, string)* +[discrete] +==== oidc_authenticate +Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair + +{ref}/security-api-oidc-authenticate.html[Endpoint documentation] +[source,ts] +---- +client.security.oidcAuthenticate() +---- + + +[discrete] +==== oidc_logout +Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API + +{ref}/security-api-oidc-logout.html[Endpoint documentation] +[source,ts] +---- +client.security.oidcLogout() +---- + + +[discrete] +==== oidc_prepare_authentication +Creates an OAuth 2.0 authentication request as a URL string + +{ref}/security-api-oidc-prepare-authentication.html[Endpoint documentation] +[source,ts] +---- +client.security.oidcPrepareAuthentication() +---- + + [discrete] ==== put_privileges Adds or updates application privileges. @@ -8497,6 +8571,17 @@ An API key's actual permission is the intersection of its assigned role descript ** *`with_profile_uid` (Optional, boolean)*: Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. ** *`typed_keys` (Optional, boolean)*: Determines whether aggregation names are prefixed by their respective types in the response. +[discrete] +==== query_user +Retrieves information for Users using a subset of query DSL + +{ref}/security-api-query-user.html[Endpoint documentation] +[source,ts] +---- +client.security.queryUser() +---- + + [discrete] ==== saml_authenticate Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair @@ -8657,6 +8742,28 @@ client.security.updateApiKey({ id }) ** *`metadata` (Optional, Record)*: Arbitrary metadata that you want to associate with the API key. It supports nested data structure. Within the metadata object, keys beginning with _ are reserved for system usage. ** *`expiration` (Optional, string | -1 | 0)*: Expiration time for the API key. +[discrete] +==== update_cross_cluster_api_key +Updates attributes of an existing cross-cluster API key. + +{ref}/security-api-update-cross-cluster-api-key.html[Endpoint documentation] +[source,ts] +---- +client.security.updateCrossClusterApiKey() +---- + + +[discrete] +==== update_settings +Update settings for the security system index + +{ref}/security-api-update-settings.html[Endpoint documentation] +[source,ts] +---- +client.security.updateSettings() +---- + + [discrete] ==== update_user_profile_data Update application specific data for the user profile of the given unique ID. @@ -8755,6 +8862,19 @@ During relocation of data certain allocation rules are ignored, such as disk wat ** *`master_timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. ** *`timeout` (Optional, Enum("nanos" | "micros" | "ms" | "s" | "m" | "h" | "d"))*: Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. +[discrete] +=== simulate +[discrete] +==== ingest +Simulates running ingest with example documents. + +{ref}/simulate-ingest-api.html[Endpoint documentation] +[source,ts] +---- +client.simulate.ingest() +---- + + [discrete] === slm [discrete] @@ -9054,6 +9174,17 @@ client.snapshot.getRepository({ ... }) ** *`local` (Optional, boolean)*: Return local information, do not retrieve the state from master node (default: false) ** *`master_timeout` (Optional, string | -1 | 0)*: Explicit operation timeout for connection to master node +[discrete] +==== repository_analyze +Analyzes a repository for correctness and performance + +{ref}/modules-snapshots.html[Endpoint documentation] +[source,ts] +---- +client.snapshot.repositoryAnalyze() +---- + + [discrete] ==== restore Restores a snapshot. @@ -9448,6 +9579,28 @@ client.tasks.list({ ... }) [discrete] === text_structure +[discrete] +==== find_field_structure +Finds the structure of a text field in an index. + +{ref}/find-field-structure.html[Endpoint documentation] +[source,ts] +---- +client.textStructure.findFieldStructure() +---- + + +[discrete] +==== find_message_structure +Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. + +{ref}/find-message-structure.html[Endpoint documentation] +[source,ts] +---- +client.textStructure.findMessageStructure() +---- + + [discrete] ==== find_structure Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. @@ -9883,6 +10036,17 @@ client.watcher.executeWatch({ ... }) ** *`watch` (Optional, { actions, condition, input, metadata, status, throttle_period, throttle_period_in_millis, transform, trigger })*: When present, this watch is used instead of the one specified in the request. This watch is not persisted to the index and record_execution cannot be set. ** *`debug` (Optional, boolean)*: Defines whether the watch runs in debug mode. +[discrete] +==== get_settings +Retrieve settings for the watcher system index + +{ref}/watcher-api-get-settings.html[Endpoint documentation] +[source,ts] +---- +client.watcher.getSettings() +---- + + [discrete] ==== get_watch Retrieves a watch by its ID. @@ -9985,6 +10149,17 @@ client.watcher.stop() ---- +[discrete] +==== update_settings +Update settings for the watcher system index + +{ref}/watcher-api-update-settings.html[Endpoint documentation] +[source,ts] +---- +client.watcher.updateSettings() +---- + + [discrete] === xpack [discrete]