From 17ceee20f5a718ffcbf618a54334d42d866a88e6 Mon Sep 17 00:00:00 2001 From: Elastic Machine Date: Mon, 12 May 2025 06:03:10 +0000 Subject: [PATCH] Auto-generated API code --- elasticsearch/_async/client/__init__.py | 86 +++--- elasticsearch/_async/client/async_search.py | 8 +- elasticsearch/_async/client/autoscaling.py | 8 +- elasticsearch/_async/client/cat.py | 260 +++++++++++++++--- elasticsearch/_async/client/ccr.py | 26 +- elasticsearch/_async/client/cluster.py | 28 +- elasticsearch/_async/client/connector.py | 60 ++-- .../_async/client/dangling_indices.py | 6 +- elasticsearch/_async/client/enrich.py | 10 +- elasticsearch/_async/client/eql.py | 6 +- elasticsearch/_async/client/esql.py | 18 +- elasticsearch/_async/client/features.py | 4 +- elasticsearch/_async/client/fleet.py | 6 +- elasticsearch/_async/client/graph.py | 2 +- elasticsearch/_async/client/ilm.py | 22 +- elasticsearch/_async/client/indices.py | 110 ++++---- elasticsearch/_async/client/inference.py | 122 ++------ elasticsearch/_async/client/ingest.py | 18 +- elasticsearch/_async/client/license.py | 12 +- elasticsearch/_async/client/logstash.py | 6 +- elasticsearch/_async/client/migration.py | 6 +- elasticsearch/_async/client/ml.py | 140 +++++----- elasticsearch/_async/client/nodes.py | 14 +- elasticsearch/_async/client/query_rules.py | 16 +- elasticsearch/_async/client/rollup.py | 16 +- .../_async/client/search_application.py | 20 +- .../_async/client/searchable_snapshots.py | 8 +- elasticsearch/_async/client/security.py | 128 ++++----- elasticsearch/_async/client/shutdown.py | 6 +- elasticsearch/_async/client/simulate.py | 2 +- elasticsearch/_async/client/slm.py | 18 +- elasticsearch/_async/client/snapshot.py | 26 +- elasticsearch/_async/client/sql.py | 12 +- elasticsearch/_async/client/ssl.py | 2 +- elasticsearch/_async/client/synonyms.py | 14 +- elasticsearch/_async/client/tasks.py | 6 +- elasticsearch/_async/client/text_structure.py | 8 +- elasticsearch/_async/client/transform.py | 18 +- elasticsearch/_async/client/xpack.py | 2 +- elasticsearch/_sync/client/__init__.py | 86 +++--- elasticsearch/_sync/client/async_search.py | 8 +- elasticsearch/_sync/client/autoscaling.py | 8 +- elasticsearch/_sync/client/cat.py | 260 +++++++++++++++--- elasticsearch/_sync/client/ccr.py | 26 +- elasticsearch/_sync/client/cluster.py | 28 +- elasticsearch/_sync/client/connector.py | 60 ++-- .../_sync/client/dangling_indices.py | 6 +- elasticsearch/_sync/client/enrich.py | 10 +- elasticsearch/_sync/client/eql.py | 6 +- elasticsearch/_sync/client/esql.py | 18 +- elasticsearch/_sync/client/features.py | 4 +- elasticsearch/_sync/client/fleet.py | 6 +- elasticsearch/_sync/client/graph.py | 2 +- elasticsearch/_sync/client/ilm.py | 22 +- elasticsearch/_sync/client/indices.py | 110 ++++---- elasticsearch/_sync/client/inference.py | 122 ++------ elasticsearch/_sync/client/ingest.py | 18 +- elasticsearch/_sync/client/license.py | 12 +- elasticsearch/_sync/client/logstash.py | 6 +- elasticsearch/_sync/client/migration.py | 6 +- elasticsearch/_sync/client/ml.py | 140 +++++----- elasticsearch/_sync/client/nodes.py | 14 +- elasticsearch/_sync/client/query_rules.py | 16 +- elasticsearch/_sync/client/rollup.py | 16 +- .../_sync/client/search_application.py | 20 +- .../_sync/client/searchable_snapshots.py | 8 +- elasticsearch/_sync/client/security.py | 128 ++++----- elasticsearch/_sync/client/shutdown.py | 6 +- elasticsearch/_sync/client/simulate.py | 2 +- elasticsearch/_sync/client/slm.py | 18 +- elasticsearch/_sync/client/snapshot.py | 26 +- elasticsearch/_sync/client/sql.py | 12 +- elasticsearch/_sync/client/ssl.py | 2 +- elasticsearch/_sync/client/synonyms.py | 14 +- elasticsearch/_sync/client/tasks.py | 6 +- elasticsearch/_sync/client/text_structure.py | 8 +- elasticsearch/_sync/client/transform.py | 18 +- elasticsearch/_sync/client/xpack.py | 2 +- elasticsearch/dsl/query.py | 44 ++- elasticsearch/dsl/types.py | 12 +- 80 files changed, 1453 insertions(+), 1163 deletions(-) diff --git a/elasticsearch/_async/client/__init__.py b/elasticsearch/_async/client/__init__.py index cf34c6284..cad97a98e 100644 --- a/elasticsearch/_async/client/__init__.py +++ b/elasticsearch/_async/client/__init__.py @@ -731,7 +731,7 @@ async def bulk( The other two shards that make up the index do not participate in the _bulk request at all.

- ``_ + ``_ :param operations: :param index: The name of the data stream, index, or index alias to perform bulk @@ -856,7 +856,7 @@ async def clear_scroll( Clear the search context and results for a scrolling search.

- ``_ + ``_ :param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`. """ @@ -913,7 +913,7 @@ async def close_point_in_time( However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.

- ``_ + ``_ :param id: The ID of the point-in-time. """ @@ -997,7 +997,7 @@ async def count( This means that replicas increase the scalability of the count.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, @@ -1199,7 +1199,7 @@ async def create( The _shards section of the API response reveals the number of shard copies on which replication succeeded and failed.

- ``_ + ``_ :param index: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template @@ -1366,7 +1366,7 @@ async def delete( It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.

- ``_ + ``_ :param index: The name of the target index. :param id: A unique identifier for the document. @@ -1555,7 +1555,7 @@ async def delete_by_query( The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, @@ -1752,7 +1752,7 @@ async def delete_by_query_rethrottle( Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

- ``_ + ``_ :param task_id: The ID for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -1802,7 +1802,7 @@ async def delete_script( Deletes a stored script or search template.

- ``_ + ``_ :param id: The identifier for the stored script or search template. :param master_timeout: The period to wait for a connection to the master node. @@ -1886,7 +1886,7 @@ async def exists( Elasticsearch cleans up deleted documents in the background as you continue to index more data.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`). @@ -2009,7 +2009,7 @@ async def exists_source(

A document's source is not available if it is disabled in the mapping.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`). @@ -2115,7 +2115,7 @@ async def explain( It computes a score explanation for a query and a specific document.

- ``_ + ``_ :param index: Index names that are used to limit the request. Only a single index name can be provided to this parameter. @@ -2250,7 +2250,7 @@ async def field_caps( For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -2411,7 +2411,7 @@ async def get( Elasticsearch cleans up deleted documents in the background as you continue to index more data.

- ``_ + ``_ :param index: The name of the index that contains the document. :param id: A unique document identifier. @@ -2518,7 +2518,7 @@ async def get_script( Retrieves a stored script or search template.

- ``_ + ``_ :param id: The identifier for the stored script or search template. :param master_timeout: The period to wait for the master node. If the master @@ -2567,7 +2567,7 @@ async def get_script_context(

Get a list of supported script contexts and their methods.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_context" @@ -2606,7 +2606,7 @@ async def get_script_languages(

Get a list of available script types, languages, and contexts.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_language" @@ -2671,7 +2671,7 @@ async def get_source( - ``_ + ``_ :param index: The name of the index that contains the document. :param id: A unique document identifier. @@ -2771,7 +2771,7 @@ async def health_report( When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.

- ``_ + ``_ :param feature: A feature of the cluster, as returned by the top-level health report API. @@ -2936,7 +2936,7 @@ async def index( - ``_ + ``_ :param index: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template @@ -3068,7 +3068,7 @@ async def info( Get basic build, version, and cluster information.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/" @@ -3142,7 +3142,7 @@ async def knn_search( - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or to perform the operation on all indices. @@ -3258,7 +3258,7 @@ async def mget( You can include the stored_fields query parameter in the request URI to specify the defaults to use when there are no per-document instructions.

- ``_ + ``_ :param index: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. @@ -3393,7 +3393,7 @@ async def msearch( When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

- ``_ + ``_ :param searches: :param index: Comma-separated list of data streams, indices, and index aliases @@ -3539,7 +3539,7 @@ async def msearch_template( - ``_ + ``_ :param search_templates: :param index: A comma-separated list of data streams, indices, and aliases to @@ -3644,7 +3644,7 @@ async def mtermvectors( The mapping used is determined by the specified _index.

- ``_ + ``_ :param index: The name of the index that contains the documents. :param docs: An array of existing or artificial documents. @@ -3785,7 +3785,7 @@ async def open_point_in_time( You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.

- ``_ + ``_ :param index: A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices @@ -3883,7 +3883,7 @@ async def put_script( Creates or updates a stored script or search template.

- ``_ + ``_ :param id: The identifier for the stored script or search template. It must be unique within the cluster. @@ -3973,7 +3973,7 @@ async def rank_eval(

Evaluate the quality of ranked search results over a set of typical search queries.

- ``_ + ``_ :param requests: A set of typical search requests, together with their provided ratings. @@ -4205,7 +4205,7 @@ async def reindex( It is not possible to configure SSL in the body of the reindex request.

- ``_ + ``_ :param dest: The destination you are copying to. :param source: The source you are copying from. @@ -4329,7 +4329,7 @@ async def reindex_rethrottle( This behavior prevents scroll timeouts.

- ``_ + ``_ :param task_id: The task identifier, which can be found by using the tasks API. :param requests_per_second: The throttle for this request in sub-requests per @@ -4385,7 +4385,7 @@ async def render_search_template(

Render a search template as a search request body.

- ``_ + ``_ :param id: The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. @@ -4479,7 +4479,7 @@ async def scripts_painless_execute(

Each context requires a script, but additional parameters depend on the context you're using for that script.

- ``_ + ``_ :param context: The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed. @@ -4552,7 +4552,7 @@ async def scroll(

IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

- ``_ + ``_ :param scroll_id: The scroll ID of the search. :param rest_total_hits_as_int: If true, the API response’s hit.total property @@ -4758,7 +4758,7 @@ async def search( This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, @@ -5509,7 +5509,7 @@ async def search_mvt( Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, or aliases to search :param field: Field containing geospatial data to return @@ -5683,7 +5683,7 @@ async def search_shards(

If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or alias.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, @@ -5794,7 +5794,7 @@ async def search_template(

Run a search with a search template.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). @@ -5937,7 +5937,7 @@ async def terms_enum( - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and index aliases to search. Wildcard (`*`) expressions are supported. To search all data streams @@ -6086,7 +6086,7 @@ async def termvectors( Use routing only to hit a particular shard.

- ``_ + ``_ :param index: The name of the index that contains the document. :param id: A unique identifier for the document. @@ -6257,7 +6257,7 @@ async def update( In addition to _source, you can access the following variables through the ctx map: _index, _type, _id, _version, _routing, and _now (the current timestamp).

- ``_ + ``_ :param index: The name of the target index. By default, the index is created automatically if it doesn't exist. @@ -6495,7 +6495,7 @@ async def update_by_query( This API enables you to only modify the source of matching documents; you cannot move them.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, @@ -6715,7 +6715,7 @@ async def update_by_query_rethrottle( Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

- ``_ + ``_ :param task_id: The ID for the task. :param requests_per_second: The throttle for this request in sub-requests per diff --git a/elasticsearch/_async/client/async_search.py b/elasticsearch/_async/client/async_search.py index b480e199b..6849e9b3c 100644 --- a/elasticsearch/_async/client/async_search.py +++ b/elasticsearch/_async/client/async_search.py @@ -44,7 +44,7 @@ async def delete( If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege.

- ``_ + ``_ :param id: A unique identifier for the async search. """ @@ -94,7 +94,7 @@ async def get( If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.

- ``_ + ``_ :param id: A unique identifier for the async search. :param keep_alive: The length of time that the async search should be available @@ -164,7 +164,7 @@ async def status( - ``_ + ``_ :param id: A unique identifier for the async search. :param keep_alive: The length of time that the async search needs to be available. @@ -346,7 +346,7 @@ async def submit( The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.

- ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_async/client/autoscaling.py b/elasticsearch/_async/client/autoscaling.py index 9999f82e8..8de430f83 100644 --- a/elasticsearch/_async/client/autoscaling.py +++ b/elasticsearch/_async/client/autoscaling.py @@ -44,7 +44,7 @@ async def delete_autoscaling_policy(

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

- ``_ + ``_ :param name: the name of the autoscaling policy :param master_timeout: Period to wait for a connection to the master node. If @@ -104,7 +104,7 @@ async def get_autoscaling_capacity( Do not use this information to make autoscaling decisions.

- ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -151,7 +151,7 @@ async def get_autoscaling_policy(

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

- ``_ + ``_ :param name: the name of the autoscaling policy :param master_timeout: Period to wait for a connection to the master node. If @@ -206,7 +206,7 @@ async def put_autoscaling_policy(

NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

- ``_ + ``_ :param name: the name of the autoscaling policy :param policy: diff --git a/elasticsearch/_async/client/cat.py b/elasticsearch/_async/client/cat.py index 2bd625661..58e274d1c 100644 --- a/elasticsearch/_async/client/cat.py +++ b/elasticsearch/_async/client/cat.py @@ -65,7 +65,7 @@ async def aliases(

IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

- ``_ + ``_ :param name: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. @@ -161,7 +161,7 @@ async def allocation(

IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

- ``_ + ``_ :param node_id: A comma-separated list of node identifiers or names used to limit the returned information. @@ -250,7 +250,7 @@ async def component_templates( They are not intended for use by applications. For application consumption, use the get component template API.

- ``_ + ``_ :param name: The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned. @@ -334,7 +334,7 @@ async def count( They are not intended for use by applications. For application consumption, use the count API.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams @@ -412,7 +412,7 @@ async def fielddata( They are not intended for use by applications. For application consumption, use the nodes stats API.

- ``_ + ``_ :param fields: Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. @@ -498,7 +498,7 @@ async def health( You also can use the API to track the recovery of a large cluster over a longer period of time.

- ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -556,7 +556,7 @@ async def help(self) -> TextApiResponse:

Get help for the CAT APIs.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_cat" @@ -623,7 +623,7 @@ async def indices( They are not intended for use by applications. For application consumption, use an index endpoint.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -721,7 +721,7 @@ async def master(

IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

- ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -899,7 +899,7 @@ async def ml_data_frame_analytics( application consumption, use the get data frame analytics jobs statistics API.

- ``_ + ``_ :param id: The ID of the data frame analytics to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -1067,7 +1067,7 @@ async def ml_datafeeds( application consumption, use the get datafeed statistics API.

- ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1433,7 +1433,7 @@ async def ml_jobs( application consumption, use the get anomaly detection job statistics API.

- ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param allow_no_match: Specifies what to do when the request: * Contains wildcard @@ -1618,7 +1618,7 @@ async def ml_trained_models( application consumption, use the get trained models statistics API.

- ``_ + ``_ :param model_id: A unique identifier for the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -1711,7 +1711,7 @@ async def nodeattrs( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

- ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1774,7 +1774,200 @@ async def nodes( filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, format: t.Optional[str] = None, full_id: t.Optional[t.Union[bool, str]] = None, - h: t.Optional[t.Union[str, t.Sequence[str]]] = None, + h: t.Optional[ + t.Union[ + t.Sequence[ + t.Union[ + str, + t.Literal[ + "build", + "completion.size", + "cpu", + "disk.avail", + "disk.total", + "disk.used", + "disk.used_percent", + "fielddata.evictions", + "fielddata.memory_size", + "file_desc.current", + "file_desc.max", + "file_desc.percent", + "flush.total", + "flush.total_time", + "get.current", + "get.exists_time", + "get.exists_total", + "get.missing_time", + "get.missing_total", + "get.time", + "get.total", + "heap.current", + "heap.max", + "heap.percent", + "http_address", + "id", + "indexing.delete_current", + "indexing.delete_time", + "indexing.delete_total", + "indexing.index_current", + "indexing.index_failed", + "indexing.index_failed_due_to_version_conflict", + "indexing.index_time", + "indexing.index_total", + "ip", + "jdk", + "load_15m", + "load_1m", + "load_5m", + "mappings.total_count", + "mappings.total_estimated_overhead_in_bytes", + "master", + "merges.current", + "merges.current_docs", + "merges.current_size", + "merges.total", + "merges.total_docs", + "merges.total_size", + "merges.total_time", + "name", + "node.role", + "pid", + "port", + "query_cache.evictions", + "query_cache.hit_count", + "query_cache.memory_size", + "query_cache.miss_count", + "ram.current", + "ram.max", + "ram.percent", + "refresh.time", + "refresh.total", + "request_cache.evictions", + "request_cache.hit_count", + "request_cache.memory_size", + "request_cache.miss_count", + "script.cache_evictions", + "script.compilations", + "search.fetch_current", + "search.fetch_time", + "search.fetch_total", + "search.open_contexts", + "search.query_current", + "search.query_time", + "search.query_total", + "search.scroll_current", + "search.scroll_time", + "search.scroll_total", + "segments.count", + "segments.fixed_bitset_memory", + "segments.index_writer_memory", + "segments.memory", + "segments.version_map_memory", + "shard_stats.total_count", + "suggest.current", + "suggest.time", + "suggest.total", + "uptime", + "version", + ], + ] + ], + t.Union[ + str, + t.Literal[ + "build", + "completion.size", + "cpu", + "disk.avail", + "disk.total", + "disk.used", + "disk.used_percent", + "fielddata.evictions", + "fielddata.memory_size", + "file_desc.current", + "file_desc.max", + "file_desc.percent", + "flush.total", + "flush.total_time", + "get.current", + "get.exists_time", + "get.exists_total", + "get.missing_time", + "get.missing_total", + "get.time", + "get.total", + "heap.current", + "heap.max", + "heap.percent", + "http_address", + "id", + "indexing.delete_current", + "indexing.delete_time", + "indexing.delete_total", + "indexing.index_current", + "indexing.index_failed", + "indexing.index_failed_due_to_version_conflict", + "indexing.index_time", + "indexing.index_total", + "ip", + "jdk", + "load_15m", + "load_1m", + "load_5m", + "mappings.total_count", + "mappings.total_estimated_overhead_in_bytes", + "master", + "merges.current", + "merges.current_docs", + "merges.current_size", + "merges.total", + "merges.total_docs", + "merges.total_size", + "merges.total_time", + "name", + "node.role", + "pid", + "port", + "query_cache.evictions", + "query_cache.hit_count", + "query_cache.memory_size", + "query_cache.miss_count", + "ram.current", + "ram.max", + "ram.percent", + "refresh.time", + "refresh.total", + "request_cache.evictions", + "request_cache.hit_count", + "request_cache.memory_size", + "request_cache.miss_count", + "script.cache_evictions", + "script.compilations", + "search.fetch_current", + "search.fetch_time", + "search.fetch_total", + "search.open_contexts", + "search.query_current", + "search.query_time", + "search.query_total", + "search.scroll_current", + "search.scroll_time", + "search.scroll_total", + "segments.count", + "segments.fixed_bitset_memory", + "segments.index_writer_memory", + "segments.memory", + "segments.version_map_memory", + "shard_stats.total_count", + "suggest.current", + "suggest.time", + "suggest.total", + "uptime", + "version", + ], + ], + ] + ] = None, help: t.Optional[bool] = None, human: t.Optional[bool] = None, include_unloaded_segments: t.Optional[bool] = None, @@ -1794,23 +1987,24 @@ async def nodes( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

- ``_ + ``_ :param bytes: The unit used to display byte values. :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. :param full_id: If `true`, return the full node ID. If `false`, return the shortened node ID. - :param h: List of columns to appear in the response. Supports simple wildcards. + :param h: A comma-separated list of columns names to display. It supports simple + wildcards. :param help: When set to `true` will output available columns. This option can't be combined with any other query string option. :param include_unloaded_segments: If true, the response includes information from segments that are not loaded into memory. - :param master_timeout: Period to wait for a connection to the master node. - :param s: List of columns that determine how the table should be sorted. Sorting - defaults to ascending and can be changed by setting `:asc` or `:desc` as - a suffix to the column name. - :param time: Unit used to display time values. + :param master_timeout: The period to wait for a connection to the master node. + :param s: A comma-separated list of column names or aliases that determines the + sort order. Sorting defaults to ascending and can be changed by setting `:asc` + or `:desc` as a suffix to the column name. + :param time: The unit used to display time values. :param v: When set to `true` will enable verbose output. """ __path_parts: t.Dict[str, str] = {} @@ -1881,7 +2075,7 @@ async def pending_tasks( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.

- ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1961,7 +2155,7 @@ async def plugins( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

- ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -2049,7 +2243,7 @@ async def recovery( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2137,7 +2331,7 @@ async def repositories( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.

- ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -2218,7 +2412,7 @@ async def segments( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2312,7 +2506,7 @@ async def shards( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

- ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2401,7 +2595,7 @@ async def snapshots( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

- ``_ + ``_ :param repository: A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. @@ -2494,7 +2688,7 @@ async def tasks( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

- ``_ + ``_ :param actions: The task action names, which are used to limit the response. :param detailed: If `true`, the response includes detailed information about @@ -2588,7 +2782,7 @@ async def templates( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

- ``_ + ``_ :param name: The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. @@ -2676,7 +2870,7 @@ async def thread_pool( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

- ``_ + ``_ :param thread_pool_patterns: A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. @@ -2933,7 +3127,7 @@ async def transforms( application consumption, use the get transform statistics API.

- ``_ + ``_ :param transform_id: A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all diff --git a/elasticsearch/_async/client/ccr.py b/elasticsearch/_async/client/ccr.py index cfa80673b..eeef7c7ab 100644 --- a/elasticsearch/_async/client/ccr.py +++ b/elasticsearch/_async/client/ccr.py @@ -43,7 +43,7 @@ async def delete_auto_follow_pattern(

Delete a collection of cross-cluster replication auto-follow patterns.

- ``_ + ``_ :param name: The auto-follow pattern collection to delete. :param master_timeout: The period to wait for a connection to the master node. @@ -130,7 +130,7 @@ async def follow( When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.

- ``_ + ``_ :param index: The name of the follower index. :param leader_index: The name of the index in the leader cluster to follow. @@ -259,7 +259,7 @@ async def follow_info( For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.

- ``_ + ``_ :param index: A comma-delimited list of follower index patterns. :param master_timeout: The period to wait for a connection to the master node. @@ -311,7 +311,7 @@ async def follow_stats( The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.

- ``_ + ``_ :param index: A comma-delimited list of index patterns. :param timeout: The period to wait for a response. If no response is received @@ -380,7 +380,7 @@ async def forget_follower( The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.

- ``_ + ``_ :param index: the name of the leader index for which specified follower retention leases should be removed @@ -445,7 +445,7 @@ async def get_auto_follow_pattern(

Get cross-cluster replication auto-follow patterns.

- ``_ + ``_ :param name: The auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections. @@ -505,7 +505,7 @@ async def pause_auto_follow_pattern( Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.

- ``_ + ``_ :param name: The name of the auto-follow pattern to pause. :param master_timeout: The period to wait for a connection to the master node. @@ -559,7 +559,7 @@ async def pause_follow( You can pause and resume a follower index to change the configuration of the following task.

- ``_ + ``_ :param index: The name of the follower index. :param master_timeout: The period to wait for a connection to the master node. @@ -648,7 +648,7 @@ async def put_auto_follow_pattern( NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.

- ``_ + ``_ :param name: The name of the collection of auto-follow patterns. :param remote_cluster: The remote cluster containing the leader indices to match @@ -782,7 +782,7 @@ async def resume_auto_follow_pattern( Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.

- ``_ + ``_ :param name: The name of the auto-follow pattern to resume. :param master_timeout: The period to wait for a connection to the master node. @@ -860,7 +860,7 @@ async def resume_follow( When this API returns, the follower index will resume fetching operations from the leader index.

- ``_ + ``_ :param index: The name of the follow index to resume following. :param master_timeout: Period to wait for a connection to the master node. @@ -951,7 +951,7 @@ async def stats(

This API returns stats about auto-following and the same shard-level stats as the get follower stats API.

- ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request @@ -1009,7 +1009,7 @@ async def unfollow( - ``_ + ``_ :param index: The name of the follower index. :param master_timeout: The period to wait for a connection to the master node. diff --git a/elasticsearch/_async/client/cluster.py b/elasticsearch/_async/client/cluster.py index 7847bbdb6..55f9c4d92 100644 --- a/elasticsearch/_async/client/cluster.py +++ b/elasticsearch/_async/client/cluster.py @@ -54,7 +54,7 @@ async def allocation_explain( This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.

- ``_ + ``_ :param current_node: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. @@ -130,7 +130,7 @@ async def delete_component_template( Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

- ``_ + ``_ :param name: Comma-separated list or wildcard expression of component template names used to limit the request. @@ -239,7 +239,7 @@ async def exists_component_template( Returns information about whether a particular component template exists.

- ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported. @@ -298,7 +298,7 @@ async def get_component_template( Get information about component templates.

- ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -365,7 +365,7 @@ async def get_settings( By default, it returns only settings that have been explicitly defined.

- ``_ + ``_ :param flat_settings: If `true`, returns settings in flat format. :param include_defaults: If `true`, returns default cluster settings from the @@ -457,7 +457,7 @@ async def health( The cluster status is controlled by the worst index status.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target @@ -565,7 +565,7 @@ async def info( Returns basic information about the cluster.

- ``_ + ``_ :param target: Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. @@ -614,7 +614,7 @@ async def pending_tasks( However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

- ``_ + ``_ :param local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. @@ -761,7 +761,7 @@ async def put_component_template( To be applied, a component template must be included in an index template's composed_of list.

- ``_ + ``_ :param name: Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; @@ -866,7 +866,7 @@ async def put_settings( If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

- ``_ + ``_ :param flat_settings: Return settings in flat format (default: false) :param master_timeout: Explicit operation timeout for connection to master node @@ -932,7 +932,7 @@ async def remote_info( - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_remote/info" @@ -989,7 +989,7 @@ async def reroute(

Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the ?retry_failed URI query parameter, which will attempt a single retry round for these shards.

- ``_ + ``_ :param commands: Defines the commands to perform. :param dry_run: If true, then the request simulates the operation. It will calculate @@ -1094,7 +1094,7 @@ async def state( Instead, obtain the information you require using other more stable cluster APIs.

- ``_ + ``_ :param metric: Limit the information returned to the specified metrics :param index: A comma-separated list of index names; use `_all` or empty string @@ -1182,7 +1182,7 @@ async def stats( Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

- ``_ + ``_ :param node_id: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. diff --git a/elasticsearch/_async/client/connector.py b/elasticsearch/_async/client/connector.py index 2f5080821..9f4b91c32 100644 --- a/elasticsearch/_async/client/connector.py +++ b/elasticsearch/_async/client/connector.py @@ -49,7 +49,7 @@ async def check_in(

Update the last_seen field in the connector and set it to the current timestamp.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be checked in """ @@ -98,7 +98,7 @@ async def delete( These need to be removed manually.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be deleted :param delete_sync_jobs: A flag indicating if associated sync jobs should be @@ -147,7 +147,7 @@ async def get(

Get the details about a connector.

- ``_ + ``_ :param connector_id: The unique identifier of the connector """ @@ -247,7 +247,7 @@ async def last_sync( This action is used for analytics and monitoring.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param last_access_control_sync_error: @@ -346,7 +346,7 @@ async def list(

Get information about all connectors.

- ``_ + ``_ :param connector_name: A comma-separated list of connector names to fetch connector documents for @@ -427,7 +427,7 @@ async def post( Self-managed connectors (Connector clients) are self-managed on your infrastructure.

- ``_ + ``_ :param description: :param index_name: @@ -509,7 +509,7 @@ async def put(

Create or update a connector.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be created or updated. ID is auto-generated if not provided. @@ -584,7 +584,7 @@ async def sync_job_cancel( The connector service is then responsible for setting the status of connector sync jobs to cancelled.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job """ @@ -635,7 +635,7 @@ async def sync_job_check_in( This service runs automatically on Elastic Cloud for Elastic managed connectors.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job to be checked in. @@ -695,7 +695,7 @@ async def sync_job_claim( This service runs automatically on Elastic Cloud for Elastic managed connectors.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job. :param worker_hostname: The host name of the current system that will run the @@ -757,7 +757,7 @@ async def sync_job_delete( This is a destructive action that is not recoverable.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job to be deleted @@ -811,7 +811,7 @@ async def sync_job_error( This service runs automatically on Elastic Cloud for Elastic managed connectors.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier for the connector sync job. :param error: The error for the connector sync job error field. @@ -865,7 +865,7 @@ async def sync_job_get(

Get a connector sync job.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job """ @@ -938,7 +938,7 @@ async def sync_job_list(

Get information about all stored connector sync jobs listed by their creation date in ascending order.

- ``_ + ``_ :param connector_id: A connector id to fetch connector sync jobs for :param from_: Starting offset (default: 0) @@ -1004,7 +1004,7 @@ async def sync_job_post(

Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

- ``_ + ``_ :param id: The id of the associated connector :param job_type: @@ -1080,7 +1080,7 @@ async def sync_job_update_stats( This service runs automatically on Elastic Cloud for Elastic managed connectors.

- ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job. :param deleted_document_count: The number of documents the sync job deleted. @@ -1163,7 +1163,7 @@ async def update_active_filtering(

Activates the valid draft filtering for a connector.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated """ @@ -1216,7 +1216,7 @@ async def update_api_key_id( Self-managed connectors (connector clients) do not use this field.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param api_key_id: @@ -1275,7 +1275,7 @@ async def update_configuration(

Update the configuration field in the connector document.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param configuration: @@ -1335,7 +1335,7 @@ async def update_error( Otherwise, if the error is reset to null, the connector status is updated to connected.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param error: @@ -1403,7 +1403,7 @@ async def update_features( This service runs automatically on Elastic Cloud for Elastic managed connectors.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated. :param features: @@ -1464,7 +1464,7 @@ async def update_filtering( The filtering property is used to configure sync rules (both basic and advanced) for a connector.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param advanced_snippet: @@ -1525,7 +1525,7 @@ async def update_filtering_validation(

Update the draft filtering validation info for a connector.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param validation: @@ -1582,7 +1582,7 @@ async def update_index_name(

Update the index_name field of a connector, specifying the index where the data ingested by the connector is stored.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param index_name: @@ -1639,7 +1639,7 @@ async def update_name(

Update the connector name and description.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param description: @@ -1696,7 +1696,7 @@ async def update_native(

Update the connector is_native flag.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param is_native: @@ -1753,7 +1753,7 @@ async def update_pipeline(

When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param pipeline: @@ -1809,7 +1809,7 @@ async def update_scheduling(

Update the connector scheduling.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param scheduling: @@ -1865,7 +1865,7 @@ async def update_service_type(

Update the connector service type.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param service_type: @@ -1928,7 +1928,7 @@ async def update_status(

Update the connector status.

- ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param status: diff --git a/elasticsearch/_async/client/dangling_indices.py b/elasticsearch/_async/client/dangling_indices.py index d7b5d5597..b792b815b 100644 --- a/elasticsearch/_async/client/dangling_indices.py +++ b/elasticsearch/_async/client/dangling_indices.py @@ -46,7 +46,7 @@ async def delete_dangling_index( For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

- ``_ + ``_ :param index_uuid: The UUID of the index to delete. Use the get dangling indices API to find the UUID. @@ -107,7 +107,7 @@ async def import_dangling_index( For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

- ``_ + ``_ :param index_uuid: The UUID of the index to import. Use the get dangling indices API to locate the UUID. @@ -168,7 +168,7 @@ async def list_dangling_indices(

Use this API to list dangling indices, which you can then import or delete.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_dangling" diff --git a/elasticsearch/_async/client/enrich.py b/elasticsearch/_async/client/enrich.py index 83161c9dd..e05204a04 100644 --- a/elasticsearch/_async/client/enrich.py +++ b/elasticsearch/_async/client/enrich.py @@ -43,7 +43,7 @@ async def delete_policy( Deletes an existing enrich policy and its enrich index.

- ``_ + ``_ :param name: Enrich policy to delete. :param master_timeout: Period to wait for a connection to the master node. @@ -92,7 +92,7 @@ async def execute_policy( Create the enrich index for an existing enrich policy.

- ``_ + ``_ :param name: Enrich policy to execute. :param master_timeout: Period to wait for a connection to the master node. @@ -144,7 +144,7 @@ async def get_policy( Returns information about an enrich policy.

- ``_ + ``_ :param name: Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. @@ -202,7 +202,7 @@ async def put_policy( Creates an enrich policy.

- ``_ + ``_ :param name: Name of the enrich policy to create or update. :param geo_match: Matches enrich data to incoming documents based on a `geo_shape` @@ -263,7 +263,7 @@ async def stats( Returns enrich coordinator statistics and information about enrich policies that are currently executing.

- ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. """ diff --git a/elasticsearch/_async/client/eql.py b/elasticsearch/_async/client/eql.py index 8985e91ec..6a6f1dafd 100644 --- a/elasticsearch/_async/client/eql.py +++ b/elasticsearch/_async/client/eql.py @@ -93,7 +93,7 @@ async def get( Get the current status and available results for an async EQL search or a stored synchronous EQL search.

- ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -147,7 +147,7 @@ async def get_status( Get the current status for an async EQL search or a stored synchronous EQL search without returning results.

- ``_ + ``_ :param id: Identifier for the search. """ @@ -246,7 +246,7 @@ async def search( EQL assumes each document in a data stream or index corresponds to an event.

- ``_ + ``_ :param index: The name of the index to scope the operation :param query: EQL query you wish to run. diff --git a/elasticsearch/_async/client/esql.py b/elasticsearch/_async/client/esql.py index a1dc79cd1..33e5061c2 100644 --- a/elasticsearch/_async/client/esql.py +++ b/elasticsearch/_async/client/esql.py @@ -84,13 +84,15 @@ async def async_query(

The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.

- ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. :param allow_partial_results: If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other - clusters and shards. + clusters and shards. If `false`, the query will fail if there are any failures. + To override the default behavior, you can set the `esql.query.allow_partial_results` + cluster setting to `false`. :param columnar: 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 @@ -212,7 +214,7 @@ async def async_query_delete( - ``_ + ``_ :param id: The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the @@ -265,7 +267,7 @@ async def async_query_get( If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.

- ``_ + ``_ :param id: The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the @@ -332,7 +334,7 @@ async def async_query_stop( If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.

- ``_ + ``_ :param id: The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the @@ -420,13 +422,15 @@ async def query( Get search results for an ES|QL (Elasticsearch query language) query.

- ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. :param allow_partial_results: If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other - clusters and shards. + clusters and shards. If `false`, the query will fail if there are any failures. + To override the default behavior, you can set the `esql.query.allow_partial_results` + cluster setting to `false`. :param columnar: 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 diff --git a/elasticsearch/_async/client/features.py b/elasticsearch/_async/client/features.py index 8cd9d7b9e..4b2b787ae 100644 --- a/elasticsearch/_async/client/features.py +++ b/elasticsearch/_async/client/features.py @@ -48,7 +48,7 @@ async def get_features( In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.

- ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. """ @@ -102,7 +102,7 @@ async def reset_features(

IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.

- ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. """ diff --git a/elasticsearch/_async/client/fleet.py b/elasticsearch/_async/client/fleet.py index ff8449659..d58259512 100644 --- a/elasticsearch/_async/client/fleet.py +++ b/elasticsearch/_async/client/fleet.py @@ -53,7 +53,7 @@ async def global_checkpoints( This API is designed for internal use by the Fleet server project.

- ``_ + ``_ :param index: A single index or index alias that resolves to a single index. :param checkpoints: A comma separated list of previous global checkpoints. When @@ -143,7 +143,7 @@ async def msearch( supports the wait_for_checkpoints parameter.

- ``_ + ``_ :param searches: :param index: A single target to search. If the target is an index alias, it @@ -392,7 +392,7 @@ async def search( after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.

- ``_ + ``_ :param index: A single target to search. If the target is an index alias, it must resolve to a single index. diff --git a/elasticsearch/_async/client/graph.py b/elasticsearch/_async/client/graph.py index 5b86970b1..8b0933f19 100644 --- a/elasticsearch/_async/client/graph.py +++ b/elasticsearch/_async/client/graph.py @@ -55,7 +55,7 @@ async def explore( You can exclude vertices that have already been returned.

- ``_ + ``_ :param index: Name of the index. :param connections: Specifies or more fields from which you want to extract terms diff --git a/elasticsearch/_async/client/ilm.py b/elasticsearch/_async/client/ilm.py index d483797d0..a5c047e78 100644 --- a/elasticsearch/_async/client/ilm.py +++ b/elasticsearch/_async/client/ilm.py @@ -44,7 +44,7 @@ async def delete_lifecycle( You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.

- ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -102,7 +102,7 @@ async def explain_lifecycle(

The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -163,7 +163,7 @@ async def get_lifecycle(

Get lifecycle policies.

- ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -218,7 +218,7 @@ async def get_status(

Get the current index lifecycle management status.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ilm/status" @@ -274,7 +274,7 @@ async def migrate_to_data_tiers( Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED.

- ``_ + ``_ :param dry_run: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides @@ -347,7 +347,7 @@ async def move_to_step( An index cannot move to a step that is not part of its policy.

- ``_ + ``_ :param index: The name of the index whose lifecycle step is to change :param current_step: The step that the index is expected to be in. @@ -415,7 +415,7 @@ async def put_lifecycle(

NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.

- ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -479,7 +479,7 @@ async def remove_policy( It also stops managing the indices.

- ``_ + ``_ :param index: The name of the index to remove policy on """ @@ -525,7 +525,7 @@ async def retry( Use the explain lifecycle state API to determine whether an index is in the ERROR step.

- ``_ + ``_ :param index: The name of the indices (comma-separated) whose failed lifecycle step is to be retry @@ -573,7 +573,7 @@ async def start( Restarting ILM is necessary only when it has been stopped using the stop ILM API.

- ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -627,7 +627,7 @@ async def stop( Use the get ILM status API to check whether ILM is running.

- ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and diff --git a/elasticsearch/_async/client/indices.py b/elasticsearch/_async/client/indices.py index 79cac1395..1e5c9e420 100644 --- a/elasticsearch/_async/client/indices.py +++ b/elasticsearch/_async/client/indices.py @@ -62,7 +62,7 @@ async def add_block( Index blocks limit the operations allowed on an index by blocking specific operation types.

- ``_ + ``_ :param index: A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you @@ -173,7 +173,7 @@ async def analyze( The _analyze endpoint without a specified index will always use 10000 as its limit.

- ``_ + ``_ :param index: Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the @@ -265,7 +265,7 @@ async def cancel_migrate_reindex(

Cancel a migration reindex attempt for a data stream or index.

- ``_ + ``_ :param index: The index or data stream name """ @@ -327,7 +327,7 @@ async def clear_cache( To clear the cache only of specific fields, use the fields parameter.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -449,7 +449,7 @@ async def clone(

Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.

- ``_ + ``_ :param index: Name of the source index to clone. :param target: Name of the target index to create. @@ -553,7 +553,7 @@ async def close( Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false.

- ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -654,7 +654,7 @@ async def create( Note that changing this setting will also affect the wait_for_active_shards value on all subsequent write operations.

- ``_ + ``_ :param index: Name of the index you wish to create. :param aliases: Aliases for the index. @@ -731,7 +731,7 @@ async def create_data_stream(

You must have a matching index template with data stream enabled.

- ``_ + ``_ :param name: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, @@ -794,7 +794,7 @@ async def create_from(

Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

- ``_ + ``_ :param source: The source index or data stream name :param dest: The destination index or data stream name @@ -861,7 +861,7 @@ async def data_streams_stats(

Get statistics for one or more data streams.

- ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a @@ -930,7 +930,7 @@ async def delete( You can then use the delete index API to delete the previous write index.

- ``_ + ``_ :param index: Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -1004,7 +1004,7 @@ async def delete_alias( Removes a data stream or index from an alias.

- ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). @@ -1072,7 +1072,7 @@ async def delete_data_lifecycle( Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

- ``_ + ``_ :param name: A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams @@ -1136,7 +1136,7 @@ async def delete_data_stream( Deletes one or more data streams and their backing indices.

- ``_ + ``_ :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. @@ -1194,7 +1194,7 @@ async def delete_index_template( existing templates.

- ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1249,7 +1249,7 @@ async def delete_template(

Delete a legacy index template.

- ``_ + ``_ :param name: The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. @@ -1321,7 +1321,7 @@ async def disk_usage( The stored size of the _id field is likely underestimated while the _source field is overestimated.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single @@ -1404,7 +1404,7 @@ async def downsample( The source index must be read only (index.blocks.write: true).

- ``_ + ``_ :param index: Name of the time series index to downsample. :param target_index: Name of the index to create. @@ -1476,7 +1476,7 @@ async def exists( Check if one or more indices, index aliases, or data streams exist.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1697,7 +1697,7 @@ async def exists_template(

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

- ``_ + ``_ :param name: A comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -1755,7 +1755,7 @@ async def explain_data_lifecycle( Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

- ``_ + ``_ :param index: The name of the index to explain :param include_defaults: indicates if the API should return the default values @@ -1822,7 +1822,7 @@ async def field_usage_stats( A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.

- ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1907,7 +1907,7 @@ async def flush( If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this @@ -2032,7 +2032,7 @@ async def forcemerge( - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -2130,7 +2130,7 @@ async def get( stream’s backing indices.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -2223,7 +2223,7 @@ async def get_alias( Retrieves information for one or more data stream or index aliases.

- ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, @@ -2309,7 +2309,7 @@ async def get_data_lifecycle(

Get the data stream lifecycle configuration of one or more data streams.

- ``_ + ``_ :param name: Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` @@ -2367,7 +2367,7 @@ async def get_data_lifecycle_stats( Get statistics about the data streams that are managed by a data stream lifecycle.

- ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_lifecycle/stats" @@ -2418,7 +2418,7 @@ async def get_data_stream(

Get information about one or more data streams.

- ``_ + ``_ :param name: Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are @@ -2499,7 +2499,7 @@ async def get_field_mapping(

This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

- ``_ + ``_ :param fields: Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (`*`). @@ -2580,7 +2580,7 @@ async def get_index_template( Get information about one or more index templates.

- ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2657,7 +2657,7 @@ async def get_mapping( For data streams, the API retrieves mappings for the stream’s backing indices.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2731,7 +2731,7 @@ async def get_migrate_reindex_status(

Get the status of a migration reindex attempt for a data stream or index.

- ``_ + ``_ :param index: The index or data stream name. """ @@ -2791,7 +2791,7 @@ async def get_settings( For data streams, it returns setting information for the stream's backing indices.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2883,7 +2883,7 @@ async def get_template(

IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

- ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, @@ -2950,7 +2950,7 @@ async def migrate_reindex( The persistent task ID is returned immediately and the reindexing work is completed in that task.

- ``_ + ``_ :param reindex: """ @@ -3146,7 +3146,7 @@ async def open(

Because opening or closing an index allocates its shards, the wait_for_active_shards setting on index creation applies to the _open and _close index actions as well.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly @@ -3716,7 +3716,7 @@ async def put_mapping( Instead, add an alias field to create an alternate field name.

- ``_ + ``_ :param index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. @@ -3862,7 +3862,7 @@ async def put_settings( To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.

- ``_ + ``_ :param settings: :param index: Comma-separated list of data streams, indices, and aliases used @@ -3988,7 +3988,7 @@ async def put_template( NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.

- ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -4090,7 +4090,7 @@ async def recovery( This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -4164,7 +4164,7 @@ async def refresh( This option ensures the indexing operation waits for a periodic refresh before running the search.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -4248,7 +4248,7 @@ async def reload_search_analyzers( This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

- ``_ + ``_ :param index: A comma-separated list of index names to reload analyzers for :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -4355,7 +4355,7 @@ async def resolve_cluster( If a connection was (re-)established, this will also cause the remote/info endpoint to now indicate a connected status.

- ``_ + ``_ :param name: A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be @@ -4457,7 +4457,7 @@ async def resolve_index( Multiple patterns and remote clusters are supported.

- ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -4559,7 +4559,7 @@ async def rollover( If you roll over the alias on May 7, 2099, the new index's name is my-index-2099.05.07-000002.

- ``_ + ``_ :param alias: Name of the data stream or index alias to roll over. :param new_index: Name of the index to create. Supports date math. Data streams @@ -4674,7 +4674,7 @@ async def segments( For data streams, the API returns information about the stream's backing indices.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -4766,7 +4766,7 @@ async def shard_stores(

By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

- ``_ + ``_ :param index: List of data streams, indices, and aliases used to limit the request. :param allow_no_indices: If false, the request returns an error if any wildcard @@ -4868,7 +4868,7 @@ async def shrink( - ``_ + ``_ :param index: Name of the source index to shrink. :param target: Name of the target index to create. @@ -4949,7 +4949,7 @@ async def simulate_index_template( Get the index configuration that would be applied to the specified index from an existing index template.

- ``_ + ``_ :param name: Name of the index to simulate :param cause: User defined reason for dry-run creating the new template for simulation @@ -5039,7 +5039,7 @@ async def simulate_template( Get the index configuration that would be applied by a particular index template.

- ``_ + ``_ :param name: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template @@ -5211,7 +5211,7 @@ async def split( - ``_ + ``_ :param index: Name of the source index to split. :param target: Name of the target index to create. @@ -5313,7 +5313,7 @@ async def stats( Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

- ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -5420,7 +5420,7 @@ async def unfreeze( When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

- ``_ + ``_ :param index: Identifier for the index. :param allow_no_indices: If `false`, the request returns an error if any wildcard @@ -5577,7 +5577,7 @@ async def validate_query( Validates a query without running it.

- ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this diff --git a/elasticsearch/_async/client/inference.py b/elasticsearch/_async/client/inference.py index ce939ccf9..7b7ee4e8a 100644 --- a/elasticsearch/_async/client/inference.py +++ b/elasticsearch/_async/client/inference.py @@ -47,7 +47,7 @@ async def completion(

Perform completion inference on the service

- ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -123,7 +123,7 @@ async def delete(

Delete an inference endpoint

- ``_ + ``_ :param inference_id: The inference identifier. :param task_type: The task type @@ -197,7 +197,7 @@ async def get(

Get an inference endpoint

- ``_ + ``_ :param task_type: The task type :param inference_id: The inference Id @@ -277,7 +277,7 @@ async def inference( - ``_ + ``_ :param inference_id: The unique identifier for the inference endpoint. :param input: The text on which you want to perform the inference task. It can @@ -370,18 +370,13 @@ async def put( """ .. raw:: html -

Create an inference endpoint. - When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

+

Create an inference endpoint.

IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

- ``_ + ``_ :param inference_id: The inference Id :param inference_config: @@ -458,14 +453,9 @@ async def put_alibabacloud(

Create an AlibabaCloud AI Search inference endpoint.

Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service.

-

When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

- ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param alibabacloud_inference_id: The unique identifier of the inference endpoint. @@ -558,14 +548,9 @@ async def put_amazonbedrock(

info You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.

-

When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

- ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param amazonbedrock_inference_id: The unique identifier of the inference endpoint. @@ -654,14 +639,9 @@ async def put_anthropic(

Create an Anthropic inference endpoint.

Create an inference endpoint to perform an inference task with the anthropic service.

-

When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

- ``_ + ``_ :param task_type: The task type. The only valid task type for the model to perform is `completion`. @@ -751,14 +731,9 @@ async def put_azureaistudio(

Create an Azure AI studio inference endpoint.

Create an inference endpoint to perform an inference task with the azureaistudio service.

-

When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

- ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param azureaistudio_inference_id: The unique identifier of the inference endpoint. @@ -853,14 +828,9 @@ async def put_azureopenai(
  • GPT-3.5

    • The list of embeddings models that you can choose from in your deployment can be found in the Azure models documentation.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through @@ -951,14 +921,9 @@ async def put_cohere(

    Create a Cohere inference endpoint.

    Create an inference endpoint to perform an inference task with the cohere service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param cohere_inference_id: The unique identifier of the inference endpoint. @@ -1062,7 +1027,7 @@ async def put_elasticsearch( Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param elasticsearch_inference_id: The unique identifier of the inference endpoint. @@ -1162,7 +1127,7 @@ async def put_elser( Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param elser_inference_id: The unique identifier of the inference endpoint. @@ -1239,14 +1204,9 @@ async def put_googleaistudio(

    Create an Google AI Studio inference endpoint.

    Create an inference endpoint to perform an inference task with the googleaistudio service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param googleaistudio_inference_id: The unique identifier of the inference endpoint. @@ -1331,14 +1291,9 @@ async def put_googlevertexai(

    Create a Google Vertex AI inference endpoint.

    Create an inference endpoint to perform an inference task with the googlevertexai service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param googlevertexai_inference_id: The unique identifier of the inference endpoint. @@ -1434,14 +1389,9 @@ async def put_hugging_face(
  • multilingual-e5-base
  • multilingual-e5-small
    • -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param huggingface_inference_id: The unique identifier of the inference endpoint. @@ -1528,14 +1478,9 @@ async def put_jinaai(

    Create an inference endpoint to perform an inference task with the jinaai service.

    To review the available rerank models, refer to https://jina.ai/reranker. To review the available text_embedding models, refer to the https://jina.ai/embeddings/.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param jinaai_inference_id: The unique identifier of the inference endpoint. @@ -1616,14 +1561,9 @@ async def put_mistral(

    Create a Mistral inference endpoint.

    Creates an inference endpoint to perform an inference task with the mistral service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The task type. The only valid task type for the model to perform is `text_embedding`. @@ -1709,14 +1649,9 @@ async def put_openai(

    Create an OpenAI inference endpoint.

    Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through @@ -1808,7 +1743,7 @@ async def put_voyageai(

    Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param voyageai_inference_id: The unique identifier of the inference endpoint. @@ -1890,14 +1825,9 @@ async def put_watsonx(

    Create an inference endpoint to perform an inference task with the watsonxai service. You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The task type. The only valid task type for the model to perform is `text_embedding`. @@ -1973,7 +1903,7 @@ async def rerank(

    Perform rereanking inference on the service

    - ``_ + ``_ :param inference_id: The unique identifier for the inference endpoint. :param input: The text on which you want to perform the inference task. It can @@ -2049,7 +1979,7 @@ async def sparse_embedding(

    Perform sparse embedding inference on the service

    - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -2117,7 +2047,7 @@ async def text_embedding(

    Perform text embedding inference on the service

    - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -2199,7 +2129,7 @@ async def update( However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

    - ``_ + ``_ :param inference_id: The unique identifier of the inference endpoint. :param inference_config: diff --git a/elasticsearch/_async/client/ingest.py b/elasticsearch/_async/client/ingest.py index 69792566c..0cc6e284b 100644 --- a/elasticsearch/_async/client/ingest.py +++ b/elasticsearch/_async/client/ingest.py @@ -98,7 +98,7 @@ async def delete_ip_location_database(

    Delete IP geolocation database configurations.

    - ``_ + ``_ :param id: A comma-separated list of IP location database configurations. :param master_timeout: The period to wait for a connection to the master node. @@ -155,7 +155,7 @@ async def delete_pipeline( Delete one or more ingest pipelines.

    - ``_ + ``_ :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. @@ -208,7 +208,7 @@ async def geo_ip_stats( Get download statistics for GeoIP2 databases that are used with the GeoIP processor.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/geoip/stats" @@ -297,7 +297,7 @@ async def get_ip_location_database(

    Get IP geolocation database configurations.

    - ``_ + ``_ :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit @@ -355,7 +355,7 @@ async def get_pipeline( This API returns a local reference of the pipeline.

    - ``_ + ``_ :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -412,7 +412,7 @@ async def processor_grok( A grok pattern is like a regular expression that supports aliased expressions that can be reused.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/processor/grok" @@ -534,7 +534,7 @@ async def put_ip_location_database(

    Create or update an IP geolocation database configuration.

    - ``_ + ``_ :param id: The database configuration identifier. :param configuration: @@ -620,7 +620,7 @@ async def put_pipeline( Changes made using this API take effect immediately.

    - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated @@ -717,7 +717,7 @@ async def simulate( You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

    - ``_ + ``_ :param docs: Sample documents to test in the pipeline. :param id: The pipeline to test. If you don't specify a `pipeline` in the request diff --git a/elasticsearch/_async/client/license.py b/elasticsearch/_async/client/license.py index 84c91196a..ab0426f1e 100644 --- a/elasticsearch/_async/client/license.py +++ b/elasticsearch/_async/client/license.py @@ -44,7 +44,7 @@ async def delete(

    If the operator privileges feature is enabled, only operator users can use this API.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. :param timeout: The period to wait for a response. If no response is received @@ -98,7 +98,7 @@ async def get( - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -147,7 +147,7 @@ async def get_basic_status(

    Get the basic license status.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/basic_status" @@ -185,7 +185,7 @@ async def get_trial_status(

    Get the trial status.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/trial_status" @@ -308,7 +308,7 @@ async def post_start_basic(

    To check the status of your basic license, use the get basic license API.

    - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -365,7 +365,7 @@ async def post_start_trial(

    To check the status of your trial, use the get trial status API.

    - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_async/client/logstash.py b/elasticsearch/_async/client/logstash.py index 9e8e6c639..3e1a8c305 100644 --- a/elasticsearch/_async/client/logstash.py +++ b/elasticsearch/_async/client/logstash.py @@ -43,7 +43,7 @@ async def delete_pipeline( If the request succeeds, you receive an empty response with an appropriate status code.

    - ``_ + ``_ :param id: An identifier for the pipeline. """ @@ -87,7 +87,7 @@ async def get_pipeline( Get pipelines that are used for Logstash Central Management.

    - ``_ + ``_ :param id: A comma-separated list of pipeline identifiers. """ @@ -139,7 +139,7 @@ async def put_pipeline( If the specified pipeline exists, it is replaced.

    - ``_ + ``_ :param id: An identifier for the pipeline. :param pipeline: diff --git a/elasticsearch/_async/client/migration.py b/elasticsearch/_async/client/migration.py index 6cbc5283e..62c476b26 100644 --- a/elasticsearch/_async/client/migration.py +++ b/elasticsearch/_async/client/migration.py @@ -44,7 +44,7 @@ async def deprecations( You are strongly recommended to use the Upgrade Assistant.

    - ``_ + ``_ :param index: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. @@ -94,7 +94,7 @@ async def get_feature_upgrade_status( You are strongly recommended to use the Upgrade Assistant.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" @@ -136,7 +136,7 @@ async def post_feature_upgrade(

    TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" diff --git a/elasticsearch/_async/client/ml.py b/elasticsearch/_async/client/ml.py index c97cbda3a..ee50139c0 100644 --- a/elasticsearch/_async/client/ml.py +++ b/elasticsearch/_async/client/ml.py @@ -45,7 +45,7 @@ async def clear_trained_model_deployment_cache( Calling this API clears the caches without restarting the deployment.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -100,7 +100,7 @@ async def close_job( When a datafeed that has a specified end date stops, it automatically closes its associated job.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection @@ -165,7 +165,7 @@ async def delete_calendar(

    Remove all scheduled events from a calendar, then delete it.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -209,7 +209,7 @@ async def delete_calendar_event(

    Delete events from a calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param event_id: Identifier for the scheduled event. You can obtain this identifier @@ -260,7 +260,7 @@ async def delete_calendar_job(

    Delete anomaly jobs from a calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -312,7 +312,7 @@ async def delete_data_frame_analytics(

    Delete a data frame analytics job.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param force: If `true`, it deletes a job that is not stopped; this method is @@ -363,7 +363,7 @@ async def delete_datafeed(

    Delete a datafeed.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -426,7 +426,7 @@ async def delete_expired_data( <job_id>.

    - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -490,7 +490,7 @@ async def delete_filter( filter. You must update or delete the job before you can delete the filter.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -540,7 +540,7 @@ async def delete_forecast( forecasts before they expire.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -616,7 +616,7 @@ async def delete_job( delete job request.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param delete_user_annotations: Specifies whether annotations that have been @@ -676,7 +676,7 @@ async def delete_model_snapshot( the model_snapshot_id in the results from the get jobs API.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -728,7 +728,7 @@ async def delete_trained_model(

    The request deletes a trained inference model that is not referenced by an ingest pipeline.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param force: Forcefully deletes a trained model that is referenced by ingest @@ -783,7 +783,7 @@ async def delete_trained_model_alias( by the model_id, this API returns an error.

    - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -844,7 +844,7 @@ async def estimate_model_memory( estimates for the fields it references.

    - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -916,7 +916,7 @@ async def evaluate_data_frame( field and an analytics result field to be present.

    - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -1001,7 +1001,7 @@ async def explain_data_frame_analytics( - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -1112,7 +1112,7 @@ async def flush_job( analyzing further data.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -1187,7 +1187,7 @@ async def forecast( based on historical data.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -1273,7 +1273,7 @@ async def get_buckets( The API presents a chronological view of the records, grouped by bucket.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1371,7 +1371,7 @@ async def get_calendar_events(

    Get info about events in calendars.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1440,7 +1440,7 @@ async def get_calendars(

    Get calendar configuration info.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1516,7 +1516,7 @@ async def get_categories(

    Get anomaly detection job results for categories.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param category_id: Identifier for the category, which is unique in the job. @@ -1604,7 +1604,7 @@ async def get_data_frame_analytics( wildcard expression.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1679,7 +1679,7 @@ async def get_data_frame_analytics_stats(

    Get data frame analytics job stats.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1753,7 +1753,7 @@ async def get_datafeed_stats( This API returns a maximum of 10,000 datafeeds.

    - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1817,7 +1817,7 @@ async def get_datafeeds( This API returns a maximum of 10,000 datafeeds.

    - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1884,7 +1884,7 @@ async def get_filters( You can get a single filter or all filters.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1952,7 +1952,7 @@ async def get_influencers( influencer_field_name is specified in the job configuration.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -2036,7 +2036,7 @@ async def get_job_stats(

    Get anomaly detection job stats.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If @@ -2100,7 +2100,7 @@ async def get_jobs( _all, by specifying * as the <job_id>, or by omitting the <job_id>.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these @@ -2166,7 +2166,7 @@ async def get_memory_stats( on each node, both within the JVM heap, and natively, outside of the JVM.

    - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -2224,7 +2224,7 @@ async def get_model_snapshot_upgrade_stats(

    Get anomaly detection job model snapshot upgrade usage info.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2298,7 +2298,7 @@ async def get_model_snapshots(

    Get model snapshots info.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2418,7 +2418,7 @@ async def get_overall_buckets( jobs' largest bucket span.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. @@ -2528,7 +2528,7 @@ async def get_records( number of detectors.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2627,7 +2627,7 @@ async def get_trained_models(

    Get trained model configuration info.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request @@ -2718,7 +2718,7 @@ async def get_trained_models_stats( models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. @@ -2784,7 +2784,7 @@ async def infer_trained_model(

    Evaluate a trained model.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param docs: An array of objects to pass to the model for inference. The objects @@ -2851,7 +2851,7 @@ async def info( cluster configuration.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ml/info" @@ -2900,7 +2900,7 @@ async def open_job( new data is received.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2957,7 +2957,7 @@ async def post_calendar_events(

    Add scheduled events to the calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param events: A list of one of more scheduled events. The event’s start and @@ -3018,7 +3018,7 @@ async def post_data( It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -3085,7 +3085,7 @@ async def preview_data_frame_analytics( Preview the extracted features used by a data frame analytics config.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param config: A data frame analytics config as described in create data frame @@ -3158,7 +3158,7 @@ async def preview_datafeed( You can also use secondary authorization headers to supply the credentials.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3237,7 +3237,7 @@ async def put_calendar(

    Create a calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -3294,7 +3294,7 @@ async def put_calendar_job(

    Add anomaly detection job to calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -3377,7 +3377,7 @@ async def put_data_frame_analytics(

    If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3562,7 +3562,7 @@ async def put_datafeed( directly to the .ml-config index. Do not give users write privileges on the .ml-config index.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3724,7 +3724,7 @@ async def put_filter( Specifically, filters are referenced in the custom_rules property of detector configuration objects.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3826,7 +3826,7 @@ async def put_job( If you include a datafeed_config but do not provide a query, the datafeed uses {"match_all": {"boost": 1}}.

    - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -4034,7 +4034,7 @@ async def put_trained_model( Enable you to supply a trained model that is not created by data frame analytics.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param compressed_definition: The compressed (GZipped and Base64 encoded) inference @@ -4155,7 +4155,7 @@ async def put_trained_model_alias( returns a warning.

    - ``_ + ``_ :param model_id: The identifier for the trained model that the alias refers to. :param model_alias: The alias to create or update. This value cannot end in numbers. @@ -4216,7 +4216,7 @@ async def put_trained_model_definition_part(

    Create part of a trained model definition.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param part: The definition part number. When the definition is loaded for inference @@ -4298,7 +4298,7 @@ async def put_trained_model_vocabulary( The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -4361,7 +4361,7 @@ async def reset_job( comma separated list.

    - ``_ + ``_ :param job_id: The ID of the job to reset. :param delete_user_annotations: Specifies whether annotations that have been @@ -4425,7 +4425,7 @@ async def revert_model_snapshot( snapshot after Black Friday or a critical system failure.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -4500,7 +4500,7 @@ async def set_upgrade_mode( machine learning info API.

    - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -4560,7 +4560,7 @@ async def start_data_frame_analytics( the destination index in advance with custom settings and mappings.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4623,7 +4623,7 @@ async def start_datafeed( authorization headers when you created or updated the datafeed, those credentials are used instead.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4700,7 +4700,7 @@ async def start_trained_model_deployment( It allocates the model to every machine learning node.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -4801,7 +4801,7 @@ async def stop_data_frame_analytics( throughout its lifecycle.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4871,7 +4871,7 @@ async def stop_datafeed( multiple times throughout its lifecycle.

    - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a @@ -4936,7 +4936,7 @@ async def stop_trained_model_deployment(

    Stop a trained model deployment.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -5119,7 +5119,7 @@ async def update_datafeed( those credentials are used instead.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -5286,7 +5286,7 @@ async def update_filter( Updates the description of a filter, adds items, or removes items from the list.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -5380,7 +5380,7 @@ async def update_job( Updates certain properties of an anomaly detection job.

    - ``_ + ``_ :param job_id: Identifier for the job. :param allow_lazy_open: Advanced configuration option. Specifies whether this @@ -5512,7 +5512,7 @@ async def update_model_snapshot( Updates certain properties of a snapshot.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -5654,7 +5654,7 @@ async def upgrade_job_snapshot( job.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -5733,7 +5733,7 @@ async def validate(

    Validate an anomaly detection job.

    - ``_ + ``_ :param analysis_config: :param analysis_limits: diff --git a/elasticsearch/_async/client/nodes.py b/elasticsearch/_async/client/nodes.py index ff8c7b321..e53ed6728 100644 --- a/elasticsearch/_async/client/nodes.py +++ b/elasticsearch/_async/client/nodes.py @@ -50,7 +50,7 @@ async def clear_repositories_metering_archive( Clear the archived repositories metering information in the cluster.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -105,7 +105,7 @@ async def get_repositories_metering_info( Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -162,7 +162,7 @@ async def hot_threads( The output is plain text with a breakdown of the top hot threads for each node.

    - ``_ + ``_ :param node_id: List of node IDs or names used to limit returned information. :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket @@ -235,7 +235,7 @@ async def info(

    By default, the API returns all attributes and core settings for cluster nodes.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -308,7 +308,7 @@ async def reload_secure_settings( Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

    - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. :param secure_settings_password: The password for the Elasticsearch keystore. @@ -383,7 +383,7 @@ async def stats( By default, all stats are returned. You can limit the returned information by using metrics.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -498,7 +498,7 @@ async def usage(

    Get feature usage information.

    - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting diff --git a/elasticsearch/_async/client/query_rules.py b/elasticsearch/_async/client/query_rules.py index 9e7f38b4b..4ca766d7d 100644 --- a/elasticsearch/_async/client/query_rules.py +++ b/elasticsearch/_async/client/query_rules.py @@ -44,7 +44,7 @@ async def delete_rule( This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to delete @@ -97,7 +97,7 @@ async def delete_ruleset( This is a destructive action that is not recoverable.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to delete """ @@ -142,7 +142,7 @@ async def get_rule( Get details about a query rule within a query ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to retrieve @@ -194,7 +194,7 @@ async def get_ruleset( Get details about a query ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset """ @@ -241,7 +241,7 @@ async def list_rulesets( Get summarized information about the query rulesets.

    - ``_ + ``_ :param from_: The offset from the first result to fetch. :param size: The maximum number of results to retrieve. @@ -302,7 +302,7 @@ async def put_rule( If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to be created or updated. @@ -389,7 +389,7 @@ async def put_ruleset( If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated. @@ -446,7 +446,7 @@ async def test( Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated diff --git a/elasticsearch/_async/client/rollup.py b/elasticsearch/_async/client/rollup.py index 94dc52ae3..1c589b5ed 100644 --- a/elasticsearch/_async/client/rollup.py +++ b/elasticsearch/_async/client/rollup.py @@ -67,7 +67,7 @@ async def delete_job( - ``_ + ``_ :param id: Identifier for the job. """ @@ -115,7 +115,7 @@ async def get_jobs( For details about a historical rollup job, the rollup capabilities API may be more useful.

    - ``_ + ``_ :param id: Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. @@ -171,7 +171,7 @@ async def get_rollup_caps( - ``_ + ``_ :param id: Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. @@ -225,7 +225,7 @@ async def get_rollup_index_caps( - ``_ + ``_ :param index: Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported. @@ -295,7 +295,7 @@ async def put_job(

    Jobs are created in a STOPPED state. You can start them with the start rollup jobs API.

    - ``_ + ``_ :param id: Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the data that is associated with the rollup job. @@ -443,7 +443,7 @@ async def rollup_search( During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.

    - ``_ + ``_ :param index: A comma-separated list of data streams and indices used to limit the request. This parameter has the following rules: * At least one data @@ -521,7 +521,7 @@ async def start_job( If you try to start a job that is already started, nothing happens.

    - ``_ + ``_ :param id: Identifier for the rollup job. """ @@ -575,7 +575,7 @@ async def stop_job( If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.

    - ``_ + ``_ :param id: Identifier for the rollup job. :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum) diff --git a/elasticsearch/_async/client/search_application.py b/elasticsearch/_async/client/search_application.py index a517db976..f1bca27fd 100644 --- a/elasticsearch/_async/client/search_application.py +++ b/elasticsearch/_async/client/search_application.py @@ -49,7 +49,7 @@ async def delete(

    Remove a search application and its associated alias. Indices attached to the search application are not removed.

    - ``_ + ``_ :param name: The name of the search application to delete. """ @@ -94,7 +94,7 @@ async def delete_behavioral_analytics( The associated data stream is also deleted.

    - ``_ + ``_ :param name: The name of the analytics collection to be deleted """ @@ -138,7 +138,7 @@ async def get(

    Get search application details.

    - ``_ + ``_ :param name: The name of the search application """ @@ -182,7 +182,7 @@ async def get_behavioral_analytics(

    Get behavioral analytics collections.

    - ``_ + ``_ :param name: A list of analytics collections to limit the returned information """ @@ -234,7 +234,7 @@ async def list( Get information about search applications.

    - ``_ + ``_ :param from_: Starting offset. :param q: Query in the Lucene query string syntax. @@ -290,7 +290,7 @@ async def post_behavioral_analytics_event(

    Create a behavioral analytics collection event.

    - ``_ + ``_ :param collection_name: The name of the behavioral analytics collection. :param event_type: The analytics event type. @@ -357,7 +357,7 @@ async def put(

    Create or update a search application.

    - ``_ + ``_ :param name: The name of the search application to be created or updated. :param search_application: @@ -414,7 +414,7 @@ async def put_behavioral_analytics(

    Create a behavioral analytics collection.

    - ``_ + ``_ :param name: The name of the analytics collection to be created or updated. """ @@ -467,7 +467,7 @@ async def render_query(

    You must have read privileges on the backing alias of the search application.

    - ``_ + ``_ :param name: The name of the search application to render teh query for. :param params: @@ -531,7 +531,7 @@ async def search( Unspecified template parameters are assigned their default values if applicable.

    - ``_ + ``_ :param name: The name of the search application to be searched. :param params: Query parameters specific to this request, which will override diff --git a/elasticsearch/_async/client/searchable_snapshots.py b/elasticsearch/_async/client/searchable_snapshots.py index 6d9ef50cc..b15bf0705 100644 --- a/elasticsearch/_async/client/searchable_snapshots.py +++ b/elasticsearch/_async/client/searchable_snapshots.py @@ -50,7 +50,7 @@ async def cache_stats( Get statistics about the shared cache for partially mounted indices.

    - ``_ + ``_ :param node_id: The names of the nodes in the cluster to target. :param master_timeout: @@ -111,7 +111,7 @@ async def clear_cache( Clear indices and data streams from the shared cache for partially mounted indices.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to clear from the cache. It supports wildcards (`*`). @@ -190,7 +190,7 @@ async def mount( Manually mounting ILM-managed snapshots can interfere with ILM processes.

    - ``_ + ``_ :param repository: The name of the repository containing the snapshot of the index to mount. @@ -278,7 +278,7 @@ async def stats(

    Get searchable snapshot statistics.

    - ``_ + ``_ :param index: A comma-separated list of data streams and indices to retrieve statistics for. diff --git a/elasticsearch/_async/client/security.py b/elasticsearch/_async/client/security.py index a2f5ac605..e89b72523 100644 --- a/elasticsearch/_async/client/security.py +++ b/elasticsearch/_async/client/security.py @@ -58,7 +58,7 @@ async def activate_user_profile( Any updates do not change existing content for either the labels or data fields.

    - ``_ + ``_ :param grant_type: The type of grant. :param access_token: The user's Elasticsearch access token or JWT. Both `access` @@ -124,7 +124,7 @@ async def authenticate( If the user cannot be authenticated, this API returns a 401 status code.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/_authenticate" @@ -171,7 +171,7 @@ async def bulk_delete_role( The bulk delete roles API cannot delete roles that are defined in roles files.

    - ``_ + ``_ :param names: An array of role names to delete :param refresh: If `true` (the default) then refresh the affected shards to make @@ -232,7 +232,7 @@ async def bulk_put_role( The bulk create or update roles API cannot update roles that are defined in roles files.

    - ``_ + ``_ :param roles: A dictionary of role name to RoleDescriptor objects to add or update :param refresh: If `true` (the default) then refresh the affected shards to make @@ -300,7 +300,7 @@ async def bulk_update_api_keys(

    A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.

    - ``_ + ``_ :param ids: The API key identifiers. :param expiration: Expiration time for the API keys. By default, API keys never @@ -378,7 +378,7 @@ async def change_password(

    Change the passwords of users in the native realm and built-in users.

    - ``_ + ``_ :param username: The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user. @@ -445,7 +445,7 @@ async def clear_api_key_cache( The cache is also automatically cleared on state changes of the security index.

    - ``_ + ``_ :param ids: Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. @@ -491,7 +491,7 @@ async def clear_cached_privileges( The cache is also automatically cleared for applications that have their privileges updated.

    - ``_ + ``_ :param application: A comma-separated list of applications. To clear all applications, use an asterism (`*`). It does not support other wildcard patterns. @@ -541,7 +541,7 @@ async def clear_cached_realms( For more information, refer to the documentation about controlling the user cache.

    - ``_ + ``_ :param realms: A comma-separated list of realms. To clear all realms, use an asterisk (`*`). It does not support other wildcard patterns. @@ -591,7 +591,7 @@ async def clear_cached_roles(

    Evict roles from the native role cache.

    - ``_ + ``_ :param name: A comma-separated list of roles to evict from the role cache. To evict all roles, use an asterisk (`*`). It does not support other wildcard @@ -643,7 +643,7 @@ async def clear_cached_service_tokens( The cache for tokens backed by the service_tokens file is cleared automatically on file changes.

    - ``_ + ``_ :param namespace: The namespace, which is a top-level grouping of service accounts. :param service: The name of the service, which must be unique within its namespace. @@ -715,7 +715,7 @@ async def create_api_key( To configure or turn off the API key service, refer to API key service setting documentation.

    - ``_ + ``_ :param expiration: The expiration time for the API key. By default, API keys never expire. @@ -805,7 +805,7 @@ async def create_cross_cluster_api_key( Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.

    - ``_ + ``_ :param access: The access to be granted to this API key. The access is composed of permissions for cross-cluster search and cross-cluster replication. At @@ -880,7 +880,7 @@ async def create_service_token( You must actively delete them if they are no longer needed.

    - ``_ + ``_ :param namespace: The name of the namespace, which is a top-level grouping of service accounts. @@ -966,7 +966,7 @@ async def delegate_pki( The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.

    - ``_ + ``_ :param x509_certificate_chain: The X509Certificate chain, which is represented as an ordered string array. Each string in the array is a base64-encoded @@ -1030,7 +1030,7 @@ async def delete_privileges( - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. @@ -1093,7 +1093,7 @@ async def delete_role( The delete roles API cannot remove roles that are defined in roles files.

    - ``_ + ``_ :param name: The name of the role. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1147,7 +1147,7 @@ async def delete_role_mapping( The delete role mappings API cannot remove role mappings that are defined in role mapping files.

    - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -1203,7 +1203,7 @@ async def delete_service_token(

    Delete service account tokens for a service in a specified namespace.

    - ``_ + ``_ :param namespace: The namespace, which is a top-level grouping of service accounts. :param service: The service name. @@ -1265,7 +1265,7 @@ async def delete_user(

    Delete users from the native realm.

    - ``_ + ``_ :param username: An identifier for the user. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1319,7 +1319,7 @@ async def disable_user( You can use this API to revoke a user's access to Elasticsearch.

    - ``_ + ``_ :param username: An identifier for the user. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1376,7 +1376,7 @@ async def disable_user_profile( To re-enable a disabled user profile, use the enable user profile API .

    - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1429,7 +1429,7 @@ async def enable_user( By default, when you create users, they are enabled.

    - ``_ + ``_ :param username: An identifier for the user. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1486,7 +1486,7 @@ async def enable_user_profile( If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.

    - ``_ + ``_ :param uid: A unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1536,7 +1536,7 @@ async def enroll_kibana( Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/kibana" @@ -1577,7 +1577,7 @@ async def enroll_node( The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/node" @@ -1626,7 +1626,7 @@ async def get_api_key( If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

    - ``_ + ``_ :param active_only: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, @@ -1704,7 +1704,7 @@ async def get_builtin_privileges(

    Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/privilege/_builtin" @@ -1749,7 +1749,7 @@ async def get_privileges( - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -1805,7 +1805,7 @@ async def get_role( The get roles API cannot retrieve roles that are defined in roles files.

    - ``_ + ``_ :param name: The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about @@ -1856,7 +1856,7 @@ async def get_role_mapping( The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

    - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -1909,7 +1909,7 @@ async def get_service_accounts(

    NOTE: Currently, only the elastic/fleet-server service account is available.

    - ``_ + ``_ :param namespace: The name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must @@ -1967,7 +1967,7 @@ async def get_service_credentials( Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.

    - ``_ + ``_ :param namespace: The name of the namespace. :param service: The service name. @@ -2023,7 +2023,7 @@ async def get_settings( - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -2099,7 +2099,7 @@ async def get_token( If you want to invalidate a token immediately, you can do so by using the invalidate token API.

    - ``_ + ``_ :param grant_type: The type of grant. Supported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`. @@ -2173,7 +2173,7 @@ async def get_user(

    Get information about users in the native realm and built-in users.

    - ``_ + ``_ :param username: An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves @@ -2231,7 +2231,7 @@ async def get_user_privileges( To check whether a user has a specific list of privileges, use the has privileges API.

    - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -2288,7 +2288,7 @@ async def get_user_profile( Elastic reserves the right to change or remove this feature in future releases without prior notice.

    - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: A comma-separated list of filters for the `data` field of the profile @@ -2372,7 +2372,7 @@ async def grant_api_key(

    By default, API keys never expire. You can specify expiration information when you create the API keys.

    - ``_ + ``_ :param api_key: The API key. :param grant_type: The type of grant. Supported grant types are: `access_token`, @@ -2519,7 +2519,7 @@ async def has_privileges( To check the privileges of other users, you must use the run as feature.

    - ``_ + ``_ :param user: Username :param application: @@ -2584,7 +2584,7 @@ async def has_privileges_user_profile( Elastic reserves the right to change or remove this feature in future releases without prior notice.

    - ``_ + ``_ :param privileges: An object containing all the privileges to be checked. :param uids: A list of profile IDs. The privileges are checked for associated @@ -2658,7 +2658,7 @@ async def invalidate_api_key( - ``_ + ``_ :param id: :param ids: A list of API key ids. This parameter cannot be used with any of @@ -2742,7 +2742,7 @@ async def invalidate_token( If none of these two are specified, then realm_name and/or username need to be specified.

    - ``_ + ``_ :param realm_name: The name of an authentication realm. This parameter cannot be used with either `refresh_token` or `token`. @@ -2810,7 +2810,7 @@ async def oidc_authenticate( These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

    - ``_ + ``_ :param nonce: Associate a client session with an ID token and mitigate replay attacks. This value needs to be the same as the one that was provided to @@ -2890,7 +2890,7 @@ async def oidc_logout( These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

    - ``_ + ``_ :param token: The access token to be invalidated. :param refresh_token: The refresh token to be invalidated. @@ -2952,7 +2952,7 @@ async def oidc_prepare_authentication( These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

    - ``_ + ``_ :param iss: In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request @@ -3048,7 +3048,7 @@ async def put_privileges(

    Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: /, *, :.

    - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -3200,7 +3200,7 @@ async def put_role( File-based role management is not available in Elastic Serverless.

    - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -3332,7 +3332,7 @@ async def put_role_mapping( If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names.

    - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -3434,7 +3434,7 @@ async def put_user( To change a user's password without updating any other fields, use the change password API.

    - ``_ + ``_ :param username: An identifier for the user. NOTE: Usernames must be at least 1 and no more than 507 characters. They can contain alphanumeric characters @@ -3553,7 +3553,7 @@ async def query_api_keys( If you have the read_security, manage_api_key, or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

    - ``_ + ``_ :param aggregations: Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only @@ -3696,7 +3696,7 @@ async def query_role( Also, the results can be paginated and sorted.

    - ``_ + ``_ :param from_: The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` @@ -3789,7 +3789,7 @@ async def query_user( This API is only for native users.

    - ``_ + ``_ :param from_: The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` @@ -3882,7 +3882,7 @@ async def saml_authenticate( This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.

    - ``_ + ``_ :param content: The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document. @@ -3955,7 +3955,7 @@ async def saml_complete_logout( The caller of this API must prepare the request accordingly so that this API can handle either of them.

    - ``_ + ``_ :param ids: A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user. @@ -4031,7 +4031,7 @@ async def saml_invalidate( Thus the user can be redirected back to their IdP.

    - ``_ + ``_ :param query_string: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include @@ -4106,7 +4106,7 @@ async def saml_logout( If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).

    - ``_ + ``_ :param token: The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received @@ -4176,7 +4176,7 @@ async def saml_prepare_authentication( The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.

    - ``_ + ``_ :param acs: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication @@ -4237,7 +4237,7 @@ async def saml_service_provider_metadata( This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.

    - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -4290,7 +4290,7 @@ async def suggest_user_profiles( Elastic reserves the right to change or remove this feature in future releases without prior notice.

    - ``_ + ``_ :param data: A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content, @@ -4377,7 +4377,7 @@ async def update_api_key( This change can occur if the owner user's permissions have changed since the API key was created or last modified.

    - ``_ + ``_ :param id: The ID of the API key to update. :param expiration: The expiration time for the API key. By default, API keys @@ -4465,7 +4465,7 @@ async def update_cross_cluster_api_key(

    NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.

    - ``_ + ``_ :param id: The ID of the cross-cluster API key to update. :param access: The access to be granted to this API key. The access is composed @@ -4544,7 +4544,7 @@ async def update_settings( This API does not yet support configuring the settings for indices before they are in use.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -4629,7 +4629,7 @@ async def update_user_profile_data( The update_profile_data global privilege grants privileges for updating only the allowed namespaces.

    - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: Non-searchable data that you want to associate with the user profile. diff --git a/elasticsearch/_async/client/shutdown.py b/elasticsearch/_async/client/shutdown.py index 8e7380af4..920b3f940 100644 --- a/elasticsearch/_async/client/shutdown.py +++ b/elasticsearch/_async/client/shutdown.py @@ -53,7 +53,7 @@ async def delete_node(

    If the operator privileges feature is enabled, you must be an operator to use this API.

    - ``_ + ``_ :param node_id: The node id of node to be removed from the shutdown state :param master_timeout: Period to wait for a connection to the master node. If @@ -112,7 +112,7 @@ async def get_node(

    If the operator privileges feature is enabled, you must be an operator to use this API.

    - ``_ + ``_ :param node_id: Which node for which to retrieve the shutdown status :param master_timeout: Period to wait for a connection to the master node. If @@ -187,7 +187,7 @@ async def put_node( Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.

    - ``_ + ``_ :param node_id: The node identifier. This parameter is not validated against the cluster's active nodes. This enables you to register a node for shut diff --git a/elasticsearch/_async/client/simulate.py b/elasticsearch/_async/client/simulate.py index 5b2f11b2e..6880607b8 100644 --- a/elasticsearch/_async/client/simulate.py +++ b/elasticsearch/_async/client/simulate.py @@ -81,7 +81,7 @@ async def ingest( These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.

    - ``_ + ``_ :param docs: Sample documents to test in the pipeline. :param index: The index to simulate ingesting into. This value can be overridden diff --git a/elasticsearch/_async/client/slm.py b/elasticsearch/_async/client/slm.py index 62ef2aa53..352080ac1 100644 --- a/elasticsearch/_async/client/slm.py +++ b/elasticsearch/_async/client/slm.py @@ -45,7 +45,7 @@ async def delete_lifecycle( This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.

    - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove :param master_timeout: The period to wait for a connection to the master node. @@ -101,7 +101,7 @@ async def execute_lifecycle( The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

    - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to be executed :param master_timeout: The period to wait for a connection to the master node. @@ -156,7 +156,7 @@ async def execute_retention( The retention policy is normally applied according to its schedule.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -208,7 +208,7 @@ async def get_lifecycle( Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

    - ``_ + ``_ :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve :param master_timeout: The period to wait for a connection to the master node. @@ -265,7 +265,7 @@ async def get_stats( Get global and policy-level statistics about actions taken by snapshot lifecycle management.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -315,7 +315,7 @@ async def get_status(

    Get the snapshot lifecycle management status.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -379,7 +379,7 @@ async def put_lifecycle( Only the latest version of a policy is stored.

    - ``_ + ``_ :param policy_id: The identifier for the snapshot lifecycle policy you want to create or update. @@ -465,7 +465,7 @@ async def start( Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -523,7 +523,7 @@ async def stop( Use the get snapshot lifecycle management status API to see if SLM is running.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails diff --git a/elasticsearch/_async/client/snapshot.py b/elasticsearch/_async/client/snapshot.py index 05b1b1c17..1b5661121 100644 --- a/elasticsearch/_async/client/snapshot.py +++ b/elasticsearch/_async/client/snapshot.py @@ -50,7 +50,7 @@ async def cleanup_repository( Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.

    - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -107,7 +107,7 @@ async def clone( Clone part of all of a snapshot into another snapshot in the same repository.

    - ``_ + ``_ :param repository: A repository name :param snapshot: The name of the snapshot to clone from @@ -191,7 +191,7 @@ async def create( Take a snapshot of a cluster or of data streams and indices.

    - ``_ + ``_ :param repository: Repository for the snapshot. :param snapshot: Name of the snapshot. Must be unique in the repository. @@ -301,7 +301,7 @@ async def create_repository( Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access.

    - ``_ + ``_ :param name: A repository name :param repository: @@ -364,7 +364,7 @@ async def delete(

    Delete snapshots.

    - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -420,7 +420,7 @@ async def delete_repository( The snapshots themselves are left untouched and in place.

    - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -497,7 +497,7 @@ async def get(

    Get snapshot information.

    - ``_ + ``_ :param repository: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. @@ -612,7 +612,7 @@ async def get_repository(

    Get snapshot repository information.

    - ``_ + ``_ :param name: A comma-separated list of repository names :param local: Return local information, do not retrieve the state from master @@ -750,7 +750,7 @@ async def repository_analyze( Some operations also verify the behavior on small blobs with sizes other than 8 bytes.

    - ``_ + ``_ :param name: The name of the repository. :param blob_count: The total number of blobs to write to the repository during @@ -877,7 +877,7 @@ async def repository_verify_integrity(

    NOTE: This API may not work correctly in a mixed-version cluster.

    - ``_ + ``_ :param name: A repository name :param blob_thread_pool_concurrency: Number of threads to use for reading blob @@ -987,7 +987,7 @@ async def restore(

    If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.

    - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -1091,7 +1091,7 @@ async def status( These requests can also tax machine resources and, when using cloud storage, incur high processing costs.

    - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -1154,7 +1154,7 @@ async def verify_repository( Check for common misconfigurations in a snapshot repository.

    - ``_ + ``_ :param name: A repository name :param master_timeout: Explicit operation timeout for connection to master node diff --git a/elasticsearch/_async/client/sql.py b/elasticsearch/_async/client/sql.py index 39ac7c5b9..1763739c5 100644 --- a/elasticsearch/_async/client/sql.py +++ b/elasticsearch/_async/client/sql.py @@ -44,7 +44,7 @@ async def clear_cursor(

    Clear an SQL search cursor.

    - ``_ + ``_ :param cursor: Cursor to clear. """ @@ -99,7 +99,7 @@ async def delete_async( - ``_ + ``_ :param id: The identifier for the search. """ @@ -150,7 +150,7 @@ async def get_async(

    If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

    - ``_ + ``_ :param id: The identifier for the search. :param delimiter: The separator for CSV results. The API supports this parameter @@ -212,7 +212,7 @@ async def get_async_status( Get the current status of an async SQL search or a stored synchronous SQL search.

    - ``_ + ``_ :param id: The identifier for the search. """ @@ -301,7 +301,7 @@ async def query( Run an SQL request.

    - ``_ + ``_ :param allow_partial_search_results: If `true`, the response has partial results when there are shard request timeouts or shard failures. If `false`, the @@ -427,7 +427,7 @@ async def translate( It accepts the same request body parameters as the SQL search API, excluding cursor.

    - ``_ + ``_ :param query: The SQL query to run. :param fetch_size: The maximum number of rows (or entries) to return in one response. diff --git a/elasticsearch/_async/client/ssl.py b/elasticsearch/_async/client/ssl.py index 9fc313614..7f9eb9ea0 100644 --- a/elasticsearch/_async/client/ssl.py +++ b/elasticsearch/_async/client/ssl.py @@ -52,7 +52,7 @@ async def certificates(

    If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ssl/certificates" diff --git a/elasticsearch/_async/client/synonyms.py b/elasticsearch/_async/client/synonyms.py index 21cbd8084..0d2c62522 100644 --- a/elasticsearch/_async/client/synonyms.py +++ b/elasticsearch/_async/client/synonyms.py @@ -53,7 +53,7 @@ async def delete_synonym( When the synonyms set is not used in analyzers, you will be able to delete it.

    - ``_ + ``_ :param id: The synonyms set identifier to delete. """ @@ -98,7 +98,7 @@ async def delete_synonym_rule( Delete a synonym rule from a synonym set.

    - ``_ + ``_ :param set_id: The ID of the synonym set to update. :param rule_id: The ID of the synonym rule to delete. @@ -151,7 +151,7 @@ async def get_synonym(

    Get a synonym set.

    - ``_ + ``_ :param id: The synonyms set identifier to retrieve. :param from_: The starting offset for query rules to retrieve. @@ -202,7 +202,7 @@ async def get_synonym_rule( Get a synonym rule from a synonym set.

    - ``_ + ``_ :param set_id: The ID of the synonym set to retrieve the synonym rule from. :param rule_id: The ID of the synonym rule to retrieve. @@ -255,7 +255,7 @@ async def get_synonyms_sets( Get a summary of all defined synonym sets.

    - ``_ + ``_ :param from_: The starting offset for synonyms sets to retrieve. :param size: The maximum number of synonyms sets to retrieve. @@ -311,7 +311,7 @@ async def put_synonym( This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.

    - ``_ + ``_ :param id: The ID of the synonyms set to be created or updated. :param synonyms_set: The synonym rules definitions for the synonyms set. @@ -370,7 +370,7 @@ async def put_synonym_rule(

    When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.

    - ``_ + ``_ :param set_id: The ID of the synonym set. :param rule_id: The ID of the synonym rule to be updated or created. diff --git a/elasticsearch/_async/client/tasks.py b/elasticsearch/_async/client/tasks.py index af54ecafa..9c3ca19b7 100644 --- a/elasticsearch/_async/client/tasks.py +++ b/elasticsearch/_async/client/tasks.py @@ -60,7 +60,7 @@ async def cancel( You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.

    - ``_ + ``_ :param task_id: The task identifier. :param actions: A comma-separated list or wildcard expression of actions that @@ -128,7 +128,7 @@ async def get(

    If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.

    - ``_ + ``_ :param task_id: The task identifier. :param timeout: The period to wait for a response. If no response is received @@ -238,7 +238,7 @@ async def list( The X-Opaque-Id in the children headers is the child task of the task that was initiated by the REST request.

    - ``_ + ``_ :param actions: A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use `cluser:*` to retrieve all diff --git a/elasticsearch/_async/client/text_structure.py b/elasticsearch/_async/client/text_structure.py index e5d7b1e12..35e4df9b0 100644 --- a/elasticsearch/_async/client/text_structure.py +++ b/elasticsearch/_async/client/text_structure.py @@ -72,7 +72,7 @@ async def find_field_structure( It helps determine why the returned structure was chosen.

    - ``_ + ``_ :param field: The field that should be analyzed. :param index: The name of the index that contains the analyzed field. @@ -259,7 +259,7 @@ async def find_message_structure( It helps determine why the returned structure was chosen.

    - ``_ + ``_ :param messages: The list of messages you want to analyze. :param column_names: If the format is `delimited`, you can specify the column @@ -433,7 +433,7 @@ async def find_structure( However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

    - ``_ + ``_ :param text_files: :param charset: The text's character set. It must be a character set that is @@ -620,7 +620,7 @@ async def test_grok_pattern( The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

    - ``_ + ``_ :param grok_pattern: The Grok pattern to run on the text. :param text: The lines of text to run the Grok pattern on. diff --git a/elasticsearch/_async/client/transform.py b/elasticsearch/_async/client/transform.py index 3d037fdb9..eae63619a 100644 --- a/elasticsearch/_async/client/transform.py +++ b/elasticsearch/_async/client/transform.py @@ -44,7 +44,7 @@ async def delete_transform(

    Delete a transform.

    - ``_ + ``_ :param transform_id: Identifier for the transform. :param delete_dest_index: If this value is true, the destination index is deleted @@ -108,7 +108,7 @@ async def get_transform( Get configuration information for transforms.

    - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -181,7 +181,7 @@ async def get_transform_stats(

    Get usage information for transforms.

    - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -269,7 +269,7 @@ async def preview_transform( types of the source index and the transform aggregations.

    - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -406,7 +406,7 @@ async def put_transform( give users any privileges on .data-frame-internal* indices.

    - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -512,7 +512,7 @@ async def reset_transform( If the destination index was created by the transform, it is deleted.

    - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -572,7 +572,7 @@ async def schedule_now_transform( is called again in the meantime.

    - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Controls the time to wait for the scheduling to take place @@ -635,7 +635,7 @@ async def start_transform( destination indices, the transform fails when it attempts unauthorized operations.

    - ``_ + ``_ :param transform_id: Identifier for the transform. :param from_: Restricts the set of transformed entities to those changed after @@ -693,7 +693,7 @@ async def stop_transform( Stops one or more transforms.

    - ``_ + ``_ :param transform_id: Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, diff --git a/elasticsearch/_async/client/xpack.py b/elasticsearch/_async/client/xpack.py index c9a314fbc..b71476ae9 100644 --- a/elasticsearch/_async/client/xpack.py +++ b/elasticsearch/_async/client/xpack.py @@ -54,7 +54,7 @@ async def info( - ``_ + ``_ :param accept_enterprise: If this param is used it must be set to true :param categories: A comma-separated list of the information categories to include diff --git a/elasticsearch/_sync/client/__init__.py b/elasticsearch/_sync/client/__init__.py index bce9d43fb..8d980f9a2 100644 --- a/elasticsearch/_sync/client/__init__.py +++ b/elasticsearch/_sync/client/__init__.py @@ -729,7 +729,7 @@ def bulk( The other two shards that make up the index do not participate in the _bulk request at all.

    - ``_ + ``_ :param operations: :param index: The name of the data stream, index, or index alias to perform bulk @@ -854,7 +854,7 @@ def clear_scroll( Clear the search context and results for a scrolling search.

    - ``_ + ``_ :param scroll_id: The scroll IDs to clear. To clear all scroll IDs, use `_all`. """ @@ -911,7 +911,7 @@ def close_point_in_time( However, keeping points in time has a cost; close them as soon as they are no longer required for search requests.

    - ``_ + ``_ :param id: The ID of the point-in-time. """ @@ -995,7 +995,7 @@ def count( This means that replicas increase the scalability of the count.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, @@ -1197,7 +1197,7 @@ def create( The _shards section of the API response reveals the number of shard copies on which replication succeeded and failed.

    - ``_ + ``_ :param index: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template @@ -1364,7 +1364,7 @@ def delete( It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group.

    - ``_ + ``_ :param index: The name of the target index. :param id: A unique identifier for the document. @@ -1553,7 +1553,7 @@ def delete_by_query( The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, @@ -1750,7 +1750,7 @@ def delete_by_query_rethrottle( Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

    - ``_ + ``_ :param task_id: The ID for the task. :param requests_per_second: The throttle for this request in sub-requests per @@ -1800,7 +1800,7 @@ def delete_script( Deletes a stored script or search template.

    - ``_ + ``_ :param id: The identifier for the stored script or search template. :param master_timeout: The period to wait for a connection to the master node. @@ -1884,7 +1884,7 @@ def exists( Elasticsearch cleans up deleted documents in the background as you continue to index more data.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`). @@ -2007,7 +2007,7 @@ def exists_source(

    A document's source is not available if it is disabled in the mapping.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases. It supports wildcards (`*`). @@ -2113,7 +2113,7 @@ def explain( It computes a score explanation for a query and a specific document.

    - ``_ + ``_ :param index: Index names that are used to limit the request. Only a single index name can be provided to this parameter. @@ -2248,7 +2248,7 @@ def field_caps( For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the keyword family.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (*). To target all data streams @@ -2409,7 +2409,7 @@ def get( Elasticsearch cleans up deleted documents in the background as you continue to index more data.

    - ``_ + ``_ :param index: The name of the index that contains the document. :param id: A unique document identifier. @@ -2516,7 +2516,7 @@ def get_script( Retrieves a stored script or search template.

    - ``_ + ``_ :param id: The identifier for the stored script or search template. :param master_timeout: The period to wait for the master node. If the master @@ -2565,7 +2565,7 @@ def get_script_context(

    Get a list of supported script contexts and their methods.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_context" @@ -2604,7 +2604,7 @@ def get_script_languages(

    Get a list of available script types, languages, and contexts.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_script_language" @@ -2669,7 +2669,7 @@ def get_source( - ``_ + ``_ :param index: The name of the index that contains the document. :param id: A unique document identifier. @@ -2769,7 +2769,7 @@ def health_report( When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic.

    - ``_ + ``_ :param feature: A feature of the cluster, as returned by the top-level health report API. @@ -2934,7 +2934,7 @@ def index( - ``_ + ``_ :param index: The name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template @@ -3066,7 +3066,7 @@ def info( Get basic build, version, and cluster information.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/" @@ -3140,7 +3140,7 @@ def knn_search( - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or to perform the operation on all indices. @@ -3256,7 +3256,7 @@ def mget( You can include the stored_fields query parameter in the request URI to specify the defaults to use when there are no per-document instructions.

    - ``_ + ``_ :param index: Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. @@ -3391,7 +3391,7 @@ def msearch( When sending requests to this endpoint the Content-Type header should be set to application/x-ndjson.

    - ``_ + ``_ :param searches: :param index: Comma-separated list of data streams, indices, and index aliases @@ -3537,7 +3537,7 @@ def msearch_template( - ``_ + ``_ :param search_templates: :param index: A comma-separated list of data streams, indices, and aliases to @@ -3642,7 +3642,7 @@ def mtermvectors( The mapping used is determined by the specified _index.

    - ``_ + ``_ :param index: The name of the index that contains the documents. :param docs: An array of existing or artificial documents. @@ -3783,7 +3783,7 @@ def open_point_in_time( You can check how many point-in-times (that is, search contexts) are open with the nodes stats API.

    - ``_ + ``_ :param index: A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices @@ -3881,7 +3881,7 @@ def put_script( Creates or updates a stored script or search template.

    - ``_ + ``_ :param id: The identifier for the stored script or search template. It must be unique within the cluster. @@ -3971,7 +3971,7 @@ def rank_eval(

    Evaluate the quality of ranked search results over a set of typical search queries.

    - ``_ + ``_ :param requests: A set of typical search requests, together with their provided ratings. @@ -4203,7 +4203,7 @@ def reindex( It is not possible to configure SSL in the body of the reindex request.

    - ``_ + ``_ :param dest: The destination you are copying to. :param source: The source you are copying from. @@ -4327,7 +4327,7 @@ def reindex_rethrottle( This behavior prevents scroll timeouts.

    - ``_ + ``_ :param task_id: The task identifier, which can be found by using the tasks API. :param requests_per_second: The throttle for this request in sub-requests per @@ -4383,7 +4383,7 @@ def render_search_template(

    Render a search template as a search request body.

    - ``_ + ``_ :param id: The ID of the search template to render. If no `source` is specified, this or the `id` request body parameter is required. @@ -4477,7 +4477,7 @@ def scripts_painless_execute(

    Each context requires a script, but additional parameters depend on the context you're using for that script.

    - ``_ + ``_ :param context: The context that the script should run in. NOTE: Result ordering in the field contexts is not guaranteed. @@ -4550,7 +4550,7 @@ def scroll(

    IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests.

    - ``_ + ``_ :param scroll_id: The scroll ID of the search. :param rest_total_hits_as_int: If true, the API response’s hit.total property @@ -4756,7 +4756,7 @@ def search( This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, @@ -5507,7 +5507,7 @@ def search_mvt( Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, or aliases to search :param field: Field containing geospatial data to return @@ -5681,7 +5681,7 @@ def search_shards(

    If the Elasticsearch security features are enabled, you must have the view_index_metadata or manage index privilege for the target data stream, index, or alias.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams and indices, @@ -5792,7 +5792,7 @@ def search_template(

    Run a search with a search template.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). @@ -5935,7 +5935,7 @@ def terms_enum( - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and index aliases to search. Wildcard (`*`) expressions are supported. To search all data streams @@ -6084,7 +6084,7 @@ def termvectors( Use routing only to hit a particular shard.

    - ``_ + ``_ :param index: The name of the index that contains the document. :param id: A unique identifier for the document. @@ -6255,7 +6255,7 @@ def update( In addition to _source, you can access the following variables through the ctx map: _index, _type, _id, _version, _routing, and _now (the current timestamp).

    - ``_ + ``_ :param index: The name of the target index. By default, the index is created automatically if it doesn't exist. @@ -6493,7 +6493,7 @@ def update_by_query( This API enables you to only modify the source of matching documents; you cannot move them.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to search. It supports wildcards (`*`). To search all data streams or indices, @@ -6713,7 +6713,7 @@ def update_by_query_rethrottle( Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts.

    - ``_ + ``_ :param task_id: The ID for the task. :param requests_per_second: The throttle for this request in sub-requests per diff --git a/elasticsearch/_sync/client/async_search.py b/elasticsearch/_sync/client/async_search.py index 3759ab575..4e3819b47 100644 --- a/elasticsearch/_sync/client/async_search.py +++ b/elasticsearch/_sync/client/async_search.py @@ -44,7 +44,7 @@ def delete( If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the cancel_task cluster privilege.

    - ``_ + ``_ :param id: A unique identifier for the async search. """ @@ -94,7 +94,7 @@ def get( If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it.

    - ``_ + ``_ :param id: A unique identifier for the async search. :param keep_alive: The length of time that the async search should be available @@ -164,7 +164,7 @@ def status( - ``_ + ``_ :param id: A unique identifier for the async search. :param keep_alive: The length of time that the async search needs to be available. @@ -346,7 +346,7 @@ def submit( The maximum allowed size for a stored async search response can be set by changing the search.max_async_search_response_size cluster level setting.

    - ``_ + ``_ :param index: A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices diff --git a/elasticsearch/_sync/client/autoscaling.py b/elasticsearch/_sync/client/autoscaling.py index 6a3768a98..53cfe405a 100644 --- a/elasticsearch/_sync/client/autoscaling.py +++ b/elasticsearch/_sync/client/autoscaling.py @@ -44,7 +44,7 @@ def delete_autoscaling_policy(

    NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

    - ``_ + ``_ :param name: the name of the autoscaling policy :param master_timeout: Period to wait for a connection to the master node. If @@ -104,7 +104,7 @@ def get_autoscaling_capacity( Do not use this information to make autoscaling decisions.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -151,7 +151,7 @@ def get_autoscaling_policy(

    NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

    - ``_ + ``_ :param name: the name of the autoscaling policy :param master_timeout: Period to wait for a connection to the master node. If @@ -206,7 +206,7 @@ def put_autoscaling_policy(

    NOTE: This feature is designed for indirect use by Elasticsearch Service, Elastic Cloud Enterprise, and Elastic Cloud on Kubernetes. Direct use is not supported.

    - ``_ + ``_ :param name: the name of the autoscaling policy :param policy: diff --git a/elasticsearch/_sync/client/cat.py b/elasticsearch/_sync/client/cat.py index 2ca151d5a..991f2f3ae 100644 --- a/elasticsearch/_sync/client/cat.py +++ b/elasticsearch/_sync/client/cat.py @@ -65,7 +65,7 @@ def aliases(

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API.

    - ``_ + ``_ :param name: A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. @@ -161,7 +161,7 @@ def allocation(

    IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

    - ``_ + ``_ :param node_id: A comma-separated list of node identifiers or names used to limit the returned information. @@ -250,7 +250,7 @@ def component_templates( They are not intended for use by applications. For application consumption, use the get component template API.

    - ``_ + ``_ :param name: The name of the component template. It accepts wildcard expressions. If it is omitted, all component templates are returned. @@ -334,7 +334,7 @@ def count( They are not intended for use by applications. For application consumption, use the count API.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. It supports wildcards (`*`). To target all data streams @@ -412,7 +412,7 @@ def fielddata( They are not intended for use by applications. For application consumption, use the nodes stats API.

    - ``_ + ``_ :param fields: Comma-separated list of fields used to limit returned information. To retrieve all fields, omit this parameter. @@ -498,7 +498,7 @@ def health( You also can use the API to track the recovery of a large cluster over a longer period of time.

    - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -556,7 +556,7 @@ def help(self) -> TextApiResponse:

    Get help for the CAT APIs.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_cat" @@ -623,7 +623,7 @@ def indices( They are not intended for use by applications. For application consumption, use an index endpoint.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -721,7 +721,7 @@ def master(

    IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -899,7 +899,7 @@ def ml_data_frame_analytics( application consumption, use the get data frame analytics jobs statistics API.

    - ``_ + ``_ :param id: The ID of the data frame analytics to fetch :param allow_no_match: Whether to ignore if a wildcard expression matches no @@ -1067,7 +1067,7 @@ def ml_datafeeds( application consumption, use the get datafeed statistics API.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. @@ -1433,7 +1433,7 @@ def ml_jobs( application consumption, use the get anomaly detection job statistics API.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param allow_no_match: Specifies what to do when the request: * Contains wildcard @@ -1618,7 +1618,7 @@ def ml_trained_models( application consumption, use the get trained models statistics API.

    - ``_ + ``_ :param model_id: A unique identifier for the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -1711,7 +1711,7 @@ def nodeattrs( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1774,7 +1774,200 @@ def nodes( filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None, format: t.Optional[str] = None, full_id: t.Optional[t.Union[bool, str]] = None, - h: t.Optional[t.Union[str, t.Sequence[str]]] = None, + h: t.Optional[ + t.Union[ + t.Sequence[ + t.Union[ + str, + t.Literal[ + "build", + "completion.size", + "cpu", + "disk.avail", + "disk.total", + "disk.used", + "disk.used_percent", + "fielddata.evictions", + "fielddata.memory_size", + "file_desc.current", + "file_desc.max", + "file_desc.percent", + "flush.total", + "flush.total_time", + "get.current", + "get.exists_time", + "get.exists_total", + "get.missing_time", + "get.missing_total", + "get.time", + "get.total", + "heap.current", + "heap.max", + "heap.percent", + "http_address", + "id", + "indexing.delete_current", + "indexing.delete_time", + "indexing.delete_total", + "indexing.index_current", + "indexing.index_failed", + "indexing.index_failed_due_to_version_conflict", + "indexing.index_time", + "indexing.index_total", + "ip", + "jdk", + "load_15m", + "load_1m", + "load_5m", + "mappings.total_count", + "mappings.total_estimated_overhead_in_bytes", + "master", + "merges.current", + "merges.current_docs", + "merges.current_size", + "merges.total", + "merges.total_docs", + "merges.total_size", + "merges.total_time", + "name", + "node.role", + "pid", + "port", + "query_cache.evictions", + "query_cache.hit_count", + "query_cache.memory_size", + "query_cache.miss_count", + "ram.current", + "ram.max", + "ram.percent", + "refresh.time", + "refresh.total", + "request_cache.evictions", + "request_cache.hit_count", + "request_cache.memory_size", + "request_cache.miss_count", + "script.cache_evictions", + "script.compilations", + "search.fetch_current", + "search.fetch_time", + "search.fetch_total", + "search.open_contexts", + "search.query_current", + "search.query_time", + "search.query_total", + "search.scroll_current", + "search.scroll_time", + "search.scroll_total", + "segments.count", + "segments.fixed_bitset_memory", + "segments.index_writer_memory", + "segments.memory", + "segments.version_map_memory", + "shard_stats.total_count", + "suggest.current", + "suggest.time", + "suggest.total", + "uptime", + "version", + ], + ] + ], + t.Union[ + str, + t.Literal[ + "build", + "completion.size", + "cpu", + "disk.avail", + "disk.total", + "disk.used", + "disk.used_percent", + "fielddata.evictions", + "fielddata.memory_size", + "file_desc.current", + "file_desc.max", + "file_desc.percent", + "flush.total", + "flush.total_time", + "get.current", + "get.exists_time", + "get.exists_total", + "get.missing_time", + "get.missing_total", + "get.time", + "get.total", + "heap.current", + "heap.max", + "heap.percent", + "http_address", + "id", + "indexing.delete_current", + "indexing.delete_time", + "indexing.delete_total", + "indexing.index_current", + "indexing.index_failed", + "indexing.index_failed_due_to_version_conflict", + "indexing.index_time", + "indexing.index_total", + "ip", + "jdk", + "load_15m", + "load_1m", + "load_5m", + "mappings.total_count", + "mappings.total_estimated_overhead_in_bytes", + "master", + "merges.current", + "merges.current_docs", + "merges.current_size", + "merges.total", + "merges.total_docs", + "merges.total_size", + "merges.total_time", + "name", + "node.role", + "pid", + "port", + "query_cache.evictions", + "query_cache.hit_count", + "query_cache.memory_size", + "query_cache.miss_count", + "ram.current", + "ram.max", + "ram.percent", + "refresh.time", + "refresh.total", + "request_cache.evictions", + "request_cache.hit_count", + "request_cache.memory_size", + "request_cache.miss_count", + "script.cache_evictions", + "script.compilations", + "search.fetch_current", + "search.fetch_time", + "search.fetch_total", + "search.open_contexts", + "search.query_current", + "search.query_time", + "search.query_total", + "search.scroll_current", + "search.scroll_time", + "search.scroll_total", + "segments.count", + "segments.fixed_bitset_memory", + "segments.index_writer_memory", + "segments.memory", + "segments.version_map_memory", + "shard_stats.total_count", + "suggest.current", + "suggest.time", + "suggest.total", + "uptime", + "version", + ], + ], + ] + ] = None, help: t.Optional[bool] = None, human: t.Optional[bool] = None, include_unloaded_segments: t.Optional[bool] = None, @@ -1794,23 +1987,24 @@ def nodes( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    - ``_ + ``_ :param bytes: The unit used to display byte values. :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. :param full_id: If `true`, return the full node ID. If `false`, return the shortened node ID. - :param h: List of columns to appear in the response. Supports simple wildcards. + :param h: A comma-separated list of columns names to display. It supports simple + wildcards. :param help: When set to `true` will output available columns. This option can't be combined with any other query string option. :param include_unloaded_segments: If true, the response includes information from segments that are not loaded into memory. - :param master_timeout: Period to wait for a connection to the master node. - :param s: List of columns that determine how the table should be sorted. Sorting - defaults to ascending and can be changed by setting `:asc` or `:desc` as - a suffix to the column name. - :param time: Unit used to display time values. + :param master_timeout: The period to wait for a connection to the master node. + :param s: A comma-separated list of column names or aliases that determines the + sort order. Sorting defaults to ascending and can be changed by setting `:asc` + or `:desc` as a suffix to the column name. + :param time: The unit used to display time values. :param v: When set to `true` will enable verbose output. """ __path_parts: t.Dict[str, str] = {} @@ -1881,7 +2075,7 @@ def pending_tasks( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the pending cluster tasks API.

    - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -1961,7 +2155,7 @@ def plugins( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -2049,7 +2243,7 @@ def recovery( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index recovery API.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2137,7 +2331,7 @@ def repositories( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot repository API.

    - ``_ + ``_ :param format: Specifies the format to return the columnar data in, can be set to `text`, `json`, `cbor`, `yaml`, or `smile`. @@ -2218,7 +2412,7 @@ def segments( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the index segments API.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2312,7 +2506,7 @@ def shards( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2401,7 +2595,7 @@ def snapshots( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get snapshot API.

    - ``_ + ``_ :param repository: A comma-separated list of snapshot repositories used to limit the request. Accepts wildcard expressions. `_all` returns all repositories. @@ -2494,7 +2688,7 @@ def tasks( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.

    - ``_ + ``_ :param actions: The task action names, which are used to limit the response. :param detailed: If `true`, the response includes detailed information about @@ -2588,7 +2782,7 @@ def templates( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the get index template API.

    - ``_ + ``_ :param name: The name of the template to return. Accepts wildcard expressions. If omitted, all templates are returned. @@ -2676,7 +2870,7 @@ def thread_pool( IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

    - ``_ + ``_ :param thread_pool_patterns: A comma-separated list of thread pool names used to limit the request. Accepts wildcard expressions. @@ -2933,7 +3127,7 @@ def transforms( application consumption, use the get transform statistics API.

    - ``_ + ``_ :param transform_id: A transform identifier or a wildcard expression. If you do not specify one of these options, the API returns information for all diff --git a/elasticsearch/_sync/client/ccr.py b/elasticsearch/_sync/client/ccr.py index ab9fe911b..cdd850fb1 100644 --- a/elasticsearch/_sync/client/ccr.py +++ b/elasticsearch/_sync/client/ccr.py @@ -43,7 +43,7 @@ def delete_auto_follow_pattern(

    Delete a collection of cross-cluster replication auto-follow patterns.

    - ``_ + ``_ :param name: The auto-follow pattern collection to delete. :param master_timeout: The period to wait for a connection to the master node. @@ -130,7 +130,7 @@ def follow( When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index.

    - ``_ + ``_ :param index: The name of the follower index. :param leader_index: The name of the index in the leader cluster to follow. @@ -259,7 +259,7 @@ def follow_info( For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused.

    - ``_ + ``_ :param index: A comma-delimited list of follower index patterns. :param master_timeout: The period to wait for a connection to the master node. @@ -311,7 +311,7 @@ def follow_stats( The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.

    - ``_ + ``_ :param index: A comma-delimited list of index patterns. :param timeout: The period to wait for a response. If no response is received @@ -380,7 +380,7 @@ def forget_follower( The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked.

    - ``_ + ``_ :param index: the name of the leader index for which specified follower retention leases should be removed @@ -445,7 +445,7 @@ def get_auto_follow_pattern(

    Get cross-cluster replication auto-follow patterns.

    - ``_ + ``_ :param name: The auto-follow pattern collection that you want to retrieve. If you do not specify a name, the API returns information for all collections. @@ -505,7 +505,7 @@ def pause_auto_follow_pattern( Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim.

    - ``_ + ``_ :param name: The name of the auto-follow pattern to pause. :param master_timeout: The period to wait for a connection to the master node. @@ -559,7 +559,7 @@ def pause_follow( You can pause and resume a follower index to change the configuration of the following task.

    - ``_ + ``_ :param index: The name of the follower index. :param master_timeout: The period to wait for a connection to the master node. @@ -648,7 +648,7 @@ def put_auto_follow_pattern( NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns.

    - ``_ + ``_ :param name: The name of the collection of auto-follow patterns. :param remote_cluster: The remote cluster containing the leader indices to match @@ -782,7 +782,7 @@ def resume_auto_follow_pattern( Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim.

    - ``_ + ``_ :param name: The name of the auto-follow pattern to resume. :param master_timeout: The period to wait for a connection to the master node. @@ -860,7 +860,7 @@ def resume_follow( When this API returns, the follower index will resume fetching operations from the leader index.

    - ``_ + ``_ :param index: The name of the follow index to resume following. :param master_timeout: Period to wait for a connection to the master node. @@ -951,7 +951,7 @@ def stats(

    This API returns stats about auto-following and the same shard-level stats as the get follower stats API.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request @@ -1009,7 +1009,7 @@ def unfollow( - ``_ + ``_ :param index: The name of the follower index. :param master_timeout: The period to wait for a connection to the master node. diff --git a/elasticsearch/_sync/client/cluster.py b/elasticsearch/_sync/client/cluster.py index 77b11fe93..31d35ab8b 100644 --- a/elasticsearch/_sync/client/cluster.py +++ b/elasticsearch/_sync/client/cluster.py @@ -54,7 +54,7 @@ def allocation_explain( This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise.

    - ``_ + ``_ :param current_node: Specifies the node ID or the name of the node to only explain a shard that is currently located on the specified node. @@ -130,7 +130,7 @@ def delete_component_template( Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.

    - ``_ + ``_ :param name: Comma-separated list or wildcard expression of component template names used to limit the request. @@ -239,7 +239,7 @@ def exists_component_template( Returns information about whether a particular component template exists.

    - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (*) expressions are supported. @@ -298,7 +298,7 @@ def get_component_template( Get information about component templates.

    - ``_ + ``_ :param name: Comma-separated list of component template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -365,7 +365,7 @@ def get_settings( By default, it returns only settings that have been explicitly defined.

    - ``_ + ``_ :param flat_settings: If `true`, returns settings in flat format. :param include_defaults: If `true`, returns default cluster settings from the @@ -457,7 +457,7 @@ def health( The cluster status is controlled by the worst index status.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target @@ -565,7 +565,7 @@ def info( Returns basic information about the cluster.

    - ``_ + ``_ :param target: Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. @@ -614,7 +614,7 @@ def pending_tasks( However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API.

    - ``_ + ``_ :param local: If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. @@ -761,7 +761,7 @@ def put_component_template( To be applied, a component template must be included in an index template's composed_of list.

    - ``_ + ``_ :param name: Name of the component template to create. Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; @@ -866,7 +866,7 @@ def put_settings( If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration.

    - ``_ + ``_ :param flat_settings: Return settings in flat format (default: false) :param master_timeout: Explicit operation timeout for connection to master node @@ -932,7 +932,7 @@ def remote_info( - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_remote/info" @@ -989,7 +989,7 @@ def reroute(

    Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the ?retry_failed URI query parameter, which will attempt a single retry round for these shards.

    - ``_ + ``_ :param commands: Defines the commands to perform. :param dry_run: If true, then the request simulates the operation. It will calculate @@ -1094,7 +1094,7 @@ def state( Instead, obtain the information you require using other more stable cluster APIs.

    - ``_ + ``_ :param metric: Limit the information returned to the specified metrics :param index: A comma-separated list of index names; use `_all` or empty string @@ -1182,7 +1182,7 @@ def stats( Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins).

    - ``_ + ``_ :param node_id: Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. diff --git a/elasticsearch/_sync/client/connector.py b/elasticsearch/_sync/client/connector.py index 76c7d8735..e1726c4f0 100644 --- a/elasticsearch/_sync/client/connector.py +++ b/elasticsearch/_sync/client/connector.py @@ -49,7 +49,7 @@ def check_in(

    Update the last_seen field in the connector and set it to the current timestamp.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be checked in """ @@ -98,7 +98,7 @@ def delete( These need to be removed manually.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be deleted :param delete_sync_jobs: A flag indicating if associated sync jobs should be @@ -147,7 +147,7 @@ def get(

    Get the details about a connector.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector """ @@ -247,7 +247,7 @@ def last_sync( This action is used for analytics and monitoring.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param last_access_control_sync_error: @@ -346,7 +346,7 @@ def list(

    Get information about all connectors.

    - ``_ + ``_ :param connector_name: A comma-separated list of connector names to fetch connector documents for @@ -427,7 +427,7 @@ def post( Self-managed connectors (Connector clients) are self-managed on your infrastructure.

    - ``_ + ``_ :param description: :param index_name: @@ -509,7 +509,7 @@ def put(

    Create or update a connector.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be created or updated. ID is auto-generated if not provided. @@ -584,7 +584,7 @@ def sync_job_cancel( The connector service is then responsible for setting the status of connector sync jobs to cancelled.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job """ @@ -635,7 +635,7 @@ def sync_job_check_in( This service runs automatically on Elastic Cloud for Elastic managed connectors.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job to be checked in. @@ -695,7 +695,7 @@ def sync_job_claim( This service runs automatically on Elastic Cloud for Elastic managed connectors.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job. :param worker_hostname: The host name of the current system that will run the @@ -757,7 +757,7 @@ def sync_job_delete( This is a destructive action that is not recoverable.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job to be deleted @@ -811,7 +811,7 @@ def sync_job_error( This service runs automatically on Elastic Cloud for Elastic managed connectors.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier for the connector sync job. :param error: The error for the connector sync job error field. @@ -865,7 +865,7 @@ def sync_job_get(

    Get a connector sync job.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job """ @@ -938,7 +938,7 @@ def sync_job_list(

    Get information about all stored connector sync jobs listed by their creation date in ascending order.

    - ``_ + ``_ :param connector_id: A connector id to fetch connector sync jobs for :param from_: Starting offset (default: 0) @@ -1004,7 +1004,7 @@ def sync_job_post(

    Create a connector sync job document in the internal index and initialize its counters and timestamps with default values.

    - ``_ + ``_ :param id: The id of the associated connector :param job_type: @@ -1080,7 +1080,7 @@ def sync_job_update_stats( This service runs automatically on Elastic Cloud for Elastic managed connectors.

    - ``_ + ``_ :param connector_sync_job_id: The unique identifier of the connector sync job. :param deleted_document_count: The number of documents the sync job deleted. @@ -1163,7 +1163,7 @@ def update_active_filtering(

    Activates the valid draft filtering for a connector.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated """ @@ -1216,7 +1216,7 @@ def update_api_key_id( Self-managed connectors (connector clients) do not use this field.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param api_key_id: @@ -1275,7 +1275,7 @@ def update_configuration(

    Update the configuration field in the connector document.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param configuration: @@ -1335,7 +1335,7 @@ def update_error( Otherwise, if the error is reset to null, the connector status is updated to connected.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param error: @@ -1403,7 +1403,7 @@ def update_features( This service runs automatically on Elastic Cloud for Elastic managed connectors.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated. :param features: @@ -1464,7 +1464,7 @@ def update_filtering( The filtering property is used to configure sync rules (both basic and advanced) for a connector.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param advanced_snippet: @@ -1525,7 +1525,7 @@ def update_filtering_validation(

    Update the draft filtering validation info for a connector.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param validation: @@ -1582,7 +1582,7 @@ def update_index_name(

    Update the index_name field of a connector, specifying the index where the data ingested by the connector is stored.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param index_name: @@ -1639,7 +1639,7 @@ def update_name(

    Update the connector name and description.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param description: @@ -1696,7 +1696,7 @@ def update_native(

    Update the connector is_native flag.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param is_native: @@ -1753,7 +1753,7 @@ def update_pipeline(

    When you create a new connector, the configuration of an ingest pipeline is populated with default settings.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param pipeline: @@ -1809,7 +1809,7 @@ def update_scheduling(

    Update the connector scheduling.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param scheduling: @@ -1865,7 +1865,7 @@ def update_service_type(

    Update the connector service type.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param service_type: @@ -1928,7 +1928,7 @@ def update_status(

    Update the connector status.

    - ``_ + ``_ :param connector_id: The unique identifier of the connector to be updated :param status: diff --git a/elasticsearch/_sync/client/dangling_indices.py b/elasticsearch/_sync/client/dangling_indices.py index 28f228ca6..dd1cee4c3 100644 --- a/elasticsearch/_sync/client/dangling_indices.py +++ b/elasticsearch/_sync/client/dangling_indices.py @@ -46,7 +46,7 @@ def delete_dangling_index( For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

    - ``_ + ``_ :param index_uuid: The UUID of the index to delete. Use the get dangling indices API to find the UUID. @@ -107,7 +107,7 @@ def import_dangling_index( For example, this can happen if you delete more than cluster.indices.tombstones.size indices while an Elasticsearch node is offline.

    - ``_ + ``_ :param index_uuid: The UUID of the index to import. Use the get dangling indices API to locate the UUID. @@ -168,7 +168,7 @@ def list_dangling_indices(

    Use this API to list dangling indices, which you can then import or delete.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_dangling" diff --git a/elasticsearch/_sync/client/enrich.py b/elasticsearch/_sync/client/enrich.py index 90fc153b8..c713b62e9 100644 --- a/elasticsearch/_sync/client/enrich.py +++ b/elasticsearch/_sync/client/enrich.py @@ -43,7 +43,7 @@ def delete_policy( Deletes an existing enrich policy and its enrich index.

    - ``_ + ``_ :param name: Enrich policy to delete. :param master_timeout: Period to wait for a connection to the master node. @@ -92,7 +92,7 @@ def execute_policy( Create the enrich index for an existing enrich policy.

    - ``_ + ``_ :param name: Enrich policy to execute. :param master_timeout: Period to wait for a connection to the master node. @@ -144,7 +144,7 @@ def get_policy( Returns information about an enrich policy.

    - ``_ + ``_ :param name: Comma-separated list of enrich policy names used to limit the request. To return information for all enrich policies, omit this parameter. @@ -202,7 +202,7 @@ def put_policy( Creates an enrich policy.

    - ``_ + ``_ :param name: Name of the enrich policy to create or update. :param geo_match: Matches enrich data to incoming documents based on a `geo_shape` @@ -263,7 +263,7 @@ def stats( Returns enrich coordinator statistics and information about enrich policies that are currently executing.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. """ diff --git a/elasticsearch/_sync/client/eql.py b/elasticsearch/_sync/client/eql.py index 7df6bf4b4..2382cd609 100644 --- a/elasticsearch/_sync/client/eql.py +++ b/elasticsearch/_sync/client/eql.py @@ -93,7 +93,7 @@ def get( Get the current status and available results for an async EQL search or a stored synchronous EQL search.

    - ``_ + ``_ :param id: Identifier for the search. :param keep_alive: Period for which the search and its results are stored on @@ -147,7 +147,7 @@ def get_status( Get the current status for an async EQL search or a stored synchronous EQL search without returning results.

    - ``_ + ``_ :param id: Identifier for the search. """ @@ -246,7 +246,7 @@ def search( EQL assumes each document in a data stream or index corresponds to an event.

    - ``_ + ``_ :param index: The name of the index to scope the operation :param query: EQL query you wish to run. diff --git a/elasticsearch/_sync/client/esql.py b/elasticsearch/_sync/client/esql.py index 410276d83..205441e01 100644 --- a/elasticsearch/_sync/client/esql.py +++ b/elasticsearch/_sync/client/esql.py @@ -84,13 +84,15 @@ def async_query(

    The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties.

    - ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. :param allow_partial_results: If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other - clusters and shards. + clusters and shards. If `false`, the query will fail if there are any failures. + To override the default behavior, you can set the `esql.query.allow_partial_results` + cluster setting to `false`. :param columnar: 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 @@ -212,7 +214,7 @@ def async_query_delete( - ``_ + ``_ :param id: The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the @@ -265,7 +267,7 @@ def async_query_get( If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API.

    - ``_ + ``_ :param id: The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the @@ -332,7 +334,7 @@ def async_query_stop( If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it.

    - ``_ + ``_ :param id: The unique identifier of the query. A query ID is provided in the ES|QL async query API response for a query that does not complete in the @@ -420,13 +422,15 @@ def query( Get search results for an ES|QL (Elasticsearch query language) query.

    - ``_ + ``_ :param query: The ES|QL query API accepts an ES|QL query string in the query parameter, runs it, and returns the results. :param allow_partial_results: If `true`, partial results will be returned if there are shard failures, but the query can continue to execute on other - clusters and shards. + clusters and shards. If `false`, the query will fail if there are any failures. + To override the default behavior, you can set the `esql.query.allow_partial_results` + cluster setting to `false`. :param columnar: 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 diff --git a/elasticsearch/_sync/client/features.py b/elasticsearch/_sync/client/features.py index 70019a24a..a4e1964c4 100644 --- a/elasticsearch/_sync/client/features.py +++ b/elasticsearch/_sync/client/features.py @@ -48,7 +48,7 @@ def get_features( In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. """ @@ -102,7 +102,7 @@ def reset_features(

    IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. """ diff --git a/elasticsearch/_sync/client/fleet.py b/elasticsearch/_sync/client/fleet.py index ba0285e46..d78cb550d 100644 --- a/elasticsearch/_sync/client/fleet.py +++ b/elasticsearch/_sync/client/fleet.py @@ -53,7 +53,7 @@ def global_checkpoints( This API is designed for internal use by the Fleet server project.

    - ``_ + ``_ :param index: A single index or index alias that resolves to a single index. :param checkpoints: A comma separated list of previous global checkpoints. When @@ -143,7 +143,7 @@ def msearch( supports the wait_for_checkpoints parameter.

    - ``_ + ``_ :param searches: :param index: A single target to search. If the target is an index alias, it @@ -392,7 +392,7 @@ def search( after provided checkpoint has been processed and is visible for searches inside of Elasticsearch.

    - ``_ + ``_ :param index: A single target to search. If the target is an index alias, it must resolve to a single index. diff --git a/elasticsearch/_sync/client/graph.py b/elasticsearch/_sync/client/graph.py index 127b6172c..bd19e233e 100644 --- a/elasticsearch/_sync/client/graph.py +++ b/elasticsearch/_sync/client/graph.py @@ -55,7 +55,7 @@ def explore( You can exclude vertices that have already been returned.

    - ``_ + ``_ :param index: Name of the index. :param connections: Specifies or more fields from which you want to extract terms diff --git a/elasticsearch/_sync/client/ilm.py b/elasticsearch/_sync/client/ilm.py index f3dd02684..2e40f6d21 100644 --- a/elasticsearch/_sync/client/ilm.py +++ b/elasticsearch/_sync/client/ilm.py @@ -44,7 +44,7 @@ def delete_lifecycle( You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error.

    - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -102,7 +102,7 @@ def explain_lifecycle(

    The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). To target all data streams and indices, use `*` @@ -163,7 +163,7 @@ def get_lifecycle(

    Get lifecycle policies.

    - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -218,7 +218,7 @@ def get_status(

    Get the current index lifecycle management status.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ilm/status" @@ -274,7 +274,7 @@ def migrate_to_data_tiers( Use the stop ILM and get ILM status APIs to wait until the reported operation mode is STOPPED.

    - ``_ + ``_ :param dry_run: If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides @@ -347,7 +347,7 @@ def move_to_step( An index cannot move to a step that is not part of its policy.

    - ``_ + ``_ :param index: The name of the index whose lifecycle step is to change :param current_step: The step that the index is expected to be in. @@ -415,7 +415,7 @@ def put_lifecycle(

    NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions.

    - ``_ + ``_ :param name: Identifier for the policy. :param master_timeout: Period to wait for a connection to the master node. If @@ -479,7 +479,7 @@ def remove_policy( It also stops managing the indices.

    - ``_ + ``_ :param index: The name of the index to remove policy on """ @@ -525,7 +525,7 @@ def retry( Use the explain lifecycle state API to determine whether an index is in the ERROR step.

    - ``_ + ``_ :param index: The name of the indices (comma-separated) whose failed lifecycle step is to be retry @@ -573,7 +573,7 @@ def start( Restarting ILM is necessary only when it has been stopped using the stop ILM API.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -627,7 +627,7 @@ def stop( Use the get ILM status API to check whether ILM is running.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and diff --git a/elasticsearch/_sync/client/indices.py b/elasticsearch/_sync/client/indices.py index a25c3bc0b..7817ccfc3 100644 --- a/elasticsearch/_sync/client/indices.py +++ b/elasticsearch/_sync/client/indices.py @@ -62,7 +62,7 @@ def add_block( Index blocks limit the operations allowed on an index by blocking specific operation types.

    - ``_ + ``_ :param index: A comma-separated list or wildcard expression of index names used to limit the request. By default, you must explicitly name the indices you @@ -173,7 +173,7 @@ def analyze( The _analyze endpoint without a specified index will always use 10000 as its limit.

    - ``_ + ``_ :param index: Index used to derive the analyzer. If specified, the `analyzer` or field parameter overrides this value. If no index is specified or the @@ -265,7 +265,7 @@ def cancel_migrate_reindex(

    Cancel a migration reindex attempt for a data stream or index.

    - ``_ + ``_ :param index: The index or data stream name """ @@ -327,7 +327,7 @@ def clear_cache( To clear the cache only of specific fields, use the fields parameter.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -449,7 +449,7 @@ def clone(

    Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well.

    - ``_ + ``_ :param index: Name of the source index to clone. :param target: Name of the target index to create. @@ -553,7 +553,7 @@ def close( Closing indices can be turned off with the cluster settings API by setting cluster.indices.close.enable to false.

    - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -654,7 +654,7 @@ def create( Note that changing this setting will also affect the wait_for_active_shards value on all subsequent write operations.

    - ``_ + ``_ :param index: Name of the index you wish to create. :param aliases: Aliases for the index. @@ -731,7 +731,7 @@ def create_data_stream(

    You must have a matching index template with data stream enabled.

    - ``_ + ``_ :param name: Name of the data stream, which must meet the following criteria: Lowercase only; Cannot include `\\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, @@ -794,7 +794,7 @@ def create_from(

    Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

    - ``_ + ``_ :param source: The source index or data stream name :param dest: The destination index or data stream name @@ -861,7 +861,7 @@ def data_streams_stats(

    Get statistics for one or more data streams.

    - ``_ + ``_ :param name: Comma-separated list of data streams used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams in a @@ -930,7 +930,7 @@ def delete( You can then use the delete index API to delete the previous write index.

    - ``_ + ``_ :param index: Comma-separated list of indices to delete. You cannot specify index aliases. By default, this parameter does not support wildcards (`*`) or `_all`. @@ -1004,7 +1004,7 @@ def delete_alias( Removes a data stream or index from an alias.

    - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). @@ -1072,7 +1072,7 @@ def delete_data_lifecycle( Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.

    - ``_ + ``_ :param name: A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams @@ -1136,7 +1136,7 @@ def delete_data_stream( Deletes one or more data streams and their backing indices.

    - ``_ + ``_ :param name: Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. @@ -1194,7 +1194,7 @@ def delete_index_template( existing templates.

    - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -1249,7 +1249,7 @@ def delete_template(

    Delete a legacy index template.

    - ``_ + ``_ :param name: The name of the legacy index template to delete. Wildcard (`*`) expressions are supported. @@ -1321,7 +1321,7 @@ def disk_usage( The stored size of the _id field is likely underestimated while the _source field is overestimated.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. It’s recommended to execute this API with a single @@ -1404,7 +1404,7 @@ def downsample( The source index must be read only (index.blocks.write: true).

    - ``_ + ``_ :param index: Name of the time series index to downsample. :param target_index: Name of the index to create. @@ -1476,7 +1476,7 @@ def exists( Check if one or more indices, index aliases, or data streams exist.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). @@ -1697,7 +1697,7 @@ def exists_template(

    IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

    - ``_ + ``_ :param name: A comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. @@ -1755,7 +1755,7 @@ def explain_data_lifecycle( Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.

    - ``_ + ``_ :param index: The name of the index to explain :param include_defaults: indicates if the API should return the default values @@ -1822,7 +1822,7 @@ def field_usage_stats( A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times.

    - ``_ + ``_ :param index: Comma-separated list or wildcard expression of index names used to limit the request. @@ -1907,7 +1907,7 @@ def flush( If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to flush. Supports wildcards (`*`). To flush all data streams and indices, omit this @@ -2032,7 +2032,7 @@ def forcemerge( - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -2130,7 +2130,7 @@ def get( stream’s backing indices.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. @@ -2223,7 +2223,7 @@ def get_alias( Retrieves information for one or more data stream or index aliases.

    - ``_ + ``_ :param index: Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). To target all data streams and indices, @@ -2309,7 +2309,7 @@ def get_data_lifecycle(

    Get the data stream lifecycle configuration of one or more data streams.

    - ``_ + ``_ :param name: Comma-separated list of data streams to limit the request. Supports wildcards (`*`). To target all data streams, omit this parameter or use `*` @@ -2367,7 +2367,7 @@ def get_data_lifecycle_stats( Get statistics about the data streams that are managed by a data stream lifecycle.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_lifecycle/stats" @@ -2418,7 +2418,7 @@ def get_data_stream(

    Get information about one or more data streams.

    - ``_ + ``_ :param name: Comma-separated list of data stream names used to limit the request. Wildcard (`*`) expressions are supported. If omitted, all data streams are @@ -2499,7 +2499,7 @@ def get_field_mapping(

    This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields.

    - ``_ + ``_ :param fields: Comma-separated list or wildcard expression of fields used to limit returned information. Supports wildcards (`*`). @@ -2580,7 +2580,7 @@ def get_index_template( Get information about one or more index templates.

    - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. @@ -2657,7 +2657,7 @@ def get_mapping( For data streams, the API retrieves mappings for the stream’s backing indices.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2731,7 +2731,7 @@ def get_migrate_reindex_status(

    Get the status of a migration reindex attempt for a data stream or index.

    - ``_ + ``_ :param index: The index or data stream name. """ @@ -2791,7 +2791,7 @@ def get_settings( For data streams, it returns setting information for the stream's backing indices.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -2883,7 +2883,7 @@ def get_template(

    IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.

    - ``_ + ``_ :param name: Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, @@ -2950,7 +2950,7 @@ def migrate_reindex( The persistent task ID is returned immediately and the reindexing work is completed in that task.

    - ``_ + ``_ :param reindex: """ @@ -3146,7 +3146,7 @@ def open(

    Because opening or closing an index allocates its shards, the wait_for_active_shards setting on index creation applies to the _open and _close index actions as well.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly @@ -3716,7 +3716,7 @@ def put_mapping( Instead, add an alias field to create an alternate field name.

    - ``_ + ``_ :param index: A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. @@ -3862,7 +3862,7 @@ def put_settings( To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.

    - ``_ + ``_ :param settings: :param index: Comma-separated list of data streams, indices, and aliases used @@ -3988,7 +3988,7 @@ def put_template( NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order.

    - ``_ + ``_ :param name: The name of the template :param aliases: Aliases for the index. @@ -4090,7 +4090,7 @@ def recovery( This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -4164,7 +4164,7 @@ def refresh( This option ensures the indexing operation waits for a periodic refresh before running the search.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -4248,7 +4248,7 @@ def reload_search_analyzers( This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future.

    - ``_ + ``_ :param index: A comma-separated list of index names to reload analyzers for :param allow_no_indices: Whether to ignore if a wildcard indices expression resolves @@ -4355,7 +4355,7 @@ def resolve_cluster( If a connection was (re-)established, this will also cause the remote/info endpoint to now indicate a connected status.

    - ``_ + ``_ :param name: A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. Resources on remote clusters can be @@ -4457,7 +4457,7 @@ def resolve_index( Multiple patterns and remote clusters are supported.

    - ``_ + ``_ :param name: Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. Resources on remote clusters can be specified @@ -4559,7 +4559,7 @@ def rollover( If you roll over the alias on May 7, 2099, the new index's name is my-index-2099.05.07-000002.

    - ``_ + ``_ :param alias: Name of the data stream or index alias to roll over. :param new_index: Name of the index to create. Supports date math. Data streams @@ -4674,7 +4674,7 @@ def segments( For data streams, the API returns information about the stream's backing indices.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams @@ -4766,7 +4766,7 @@ def shard_stores(

    By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards.

    - ``_ + ``_ :param index: List of data streams, indices, and aliases used to limit the request. :param allow_no_indices: If false, the request returns an error if any wildcard @@ -4868,7 +4868,7 @@ def shrink( - ``_ + ``_ :param index: Name of the source index to shrink. :param target: Name of the target index to create. @@ -4949,7 +4949,7 @@ def simulate_index_template( Get the index configuration that would be applied to the specified index from an existing index template.

    - ``_ + ``_ :param name: Name of the index to simulate :param cause: User defined reason for dry-run creating the new template for simulation @@ -5039,7 +5039,7 @@ def simulate_template( Get the index configuration that would be applied by a particular index template.

    - ``_ + ``_ :param name: Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit this parameter and specify the template @@ -5211,7 +5211,7 @@ def split( - ``_ + ``_ :param index: Name of the source index to split. :param target: Name of the target index to create. @@ -5313,7 +5313,7 @@ def stats( Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed.

    - ``_ + ``_ :param index: A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices @@ -5420,7 +5420,7 @@ def unfreeze( When a frozen index is unfrozen, the index goes through the normal recovery process and becomes writeable again.

    - ``_ + ``_ :param index: Identifier for the index. :param allow_no_indices: If `false`, the request returns an error if any wildcard @@ -5577,7 +5577,7 @@ def validate_query( Validates a query without running it.

    - ``_ + ``_ :param index: Comma-separated list of data streams, indices, and aliases to search. Supports wildcards (`*`). To search all data streams or indices, omit this diff --git a/elasticsearch/_sync/client/inference.py b/elasticsearch/_sync/client/inference.py index e15e6e226..108ea938a 100644 --- a/elasticsearch/_sync/client/inference.py +++ b/elasticsearch/_sync/client/inference.py @@ -47,7 +47,7 @@ def completion(

    Perform completion inference on the service

    - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -123,7 +123,7 @@ def delete(

    Delete an inference endpoint

    - ``_ + ``_ :param inference_id: The inference identifier. :param task_type: The task type @@ -197,7 +197,7 @@ def get(

    Get an inference endpoint

    - ``_ + ``_ :param task_type: The task type :param inference_id: The inference Id @@ -277,7 +277,7 @@ def inference( - ``_ + ``_ :param inference_id: The unique identifier for the inference endpoint. :param input: The text on which you want to perform the inference task. It can @@ -370,18 +370,13 @@ def put( """ .. raw:: html -

    Create an inference endpoint. - When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    +

    Create an inference endpoint.

    IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

    - ``_ + ``_ :param inference_id: The inference Id :param inference_config: @@ -458,14 +453,9 @@ def put_alibabacloud(

    Create an AlibabaCloud AI Search inference endpoint.

    Create an inference endpoint to perform an inference task with the alibabacloud-ai-search service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param alibabacloud_inference_id: The unique identifier of the inference endpoint. @@ -558,14 +548,9 @@ def put_amazonbedrock(

    info You need to provide the access and secret keys only once, during the inference model creation. The get inference API does not retrieve your access or secret keys. After creating the inference model, you cannot change the associated key pairs. If you want to use a different access and secret key pair, delete the inference model and recreate it with the same name and the updated keys.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param amazonbedrock_inference_id: The unique identifier of the inference endpoint. @@ -654,14 +639,9 @@ def put_anthropic(

    Create an Anthropic inference endpoint.

    Create an inference endpoint to perform an inference task with the anthropic service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The task type. The only valid task type for the model to perform is `completion`. @@ -751,14 +731,9 @@ def put_azureaistudio(

    Create an Azure AI studio inference endpoint.

    Create an inference endpoint to perform an inference task with the azureaistudio service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param azureaistudio_inference_id: The unique identifier of the inference endpoint. @@ -853,14 +828,9 @@ def put_azureopenai(
  • GPT-3.5

    • The list of embeddings models that you can choose from in your deployment can be found in the Azure models documentation.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through @@ -951,14 +921,9 @@ def put_cohere(

    Create a Cohere inference endpoint.

    Create an inference endpoint to perform an inference task with the cohere service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param cohere_inference_id: The unique identifier of the inference endpoint. @@ -1062,7 +1027,7 @@ def put_elasticsearch( Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param elasticsearch_inference_id: The unique identifier of the inference endpoint. @@ -1162,7 +1127,7 @@ def put_elser( Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param elser_inference_id: The unique identifier of the inference endpoint. @@ -1239,14 +1204,9 @@ def put_googleaistudio(

    Create an Google AI Studio inference endpoint.

    Create an inference endpoint to perform an inference task with the googleaistudio service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param googleaistudio_inference_id: The unique identifier of the inference endpoint. @@ -1331,14 +1291,9 @@ def put_googlevertexai(

    Create a Google Vertex AI inference endpoint.

    Create an inference endpoint to perform an inference task with the googlevertexai service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param googlevertexai_inference_id: The unique identifier of the inference endpoint. @@ -1434,14 +1389,9 @@ def put_hugging_face(
  • multilingual-e5-base
  • multilingual-e5-small
    • -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param huggingface_inference_id: The unique identifier of the inference endpoint. @@ -1528,14 +1478,9 @@ def put_jinaai(

    Create an inference endpoint to perform an inference task with the jinaai service.

    To review the available rerank models, refer to https://jina.ai/reranker. To review the available text_embedding models, refer to the https://jina.ai/embeddings/.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param jinaai_inference_id: The unique identifier of the inference endpoint. @@ -1616,14 +1561,9 @@ def put_mistral(

    Create a Mistral inference endpoint.

    Creates an inference endpoint to perform an inference task with the mistral service.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The task type. The only valid task type for the model to perform is `text_embedding`. @@ -1709,14 +1649,9 @@ def put_openai(

    Create an OpenAI inference endpoint.

    Create an inference endpoint to perform an inference task with the openai service or openai compatible APIs.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. NOTE: The `chat_completion` task type only supports streaming and only through @@ -1808,7 +1743,7 @@ def put_voyageai(

    Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The type of the inference task that the model will perform. :param voyageai_inference_id: The unique identifier of the inference endpoint. @@ -1890,14 +1825,9 @@ def put_watsonx(

    Create an inference endpoint to perform an inference task with the watsonxai service. You need an IBM Cloud Databases for Elasticsearch deployment to use the watsonxai inference service. You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform.

    -

    When you create an inference endpoint, the associated machine learning model is automatically deployed if it is not already running. - After creating the endpoint, wait for the model deployment to complete before using it. - To verify the deployment status, use the get trained model statistics API. - Look for "state": "fully_allocated" in the response and ensure that the "allocation_count" matches the "target_allocation_count". - Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.

    - ``_ + ``_ :param task_type: The task type. The only valid task type for the model to perform is `text_embedding`. @@ -1973,7 +1903,7 @@ def rerank(

    Perform rereanking inference on the service

    - ``_ + ``_ :param inference_id: The unique identifier for the inference endpoint. :param input: The text on which you want to perform the inference task. It can @@ -2049,7 +1979,7 @@ def sparse_embedding(

    Perform sparse embedding inference on the service

    - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -2117,7 +2047,7 @@ def text_embedding(

    Perform text embedding inference on the service

    - ``_ + ``_ :param inference_id: The inference Id :param input: Inference input. Either a string or an array of strings. @@ -2199,7 +2129,7 @@ def update( However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs.

    - ``_ + ``_ :param inference_id: The unique identifier of the inference endpoint. :param inference_config: diff --git a/elasticsearch/_sync/client/ingest.py b/elasticsearch/_sync/client/ingest.py index f4d8c9241..b30e211d7 100644 --- a/elasticsearch/_sync/client/ingest.py +++ b/elasticsearch/_sync/client/ingest.py @@ -98,7 +98,7 @@ def delete_ip_location_database(

    Delete IP geolocation database configurations.

    - ``_ + ``_ :param id: A comma-separated list of IP location database configurations. :param master_timeout: The period to wait for a connection to the master node. @@ -155,7 +155,7 @@ def delete_pipeline( Delete one or more ingest pipelines.

    - ``_ + ``_ :param id: Pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of `*`. @@ -208,7 +208,7 @@ def geo_ip_stats( Get download statistics for GeoIP2 databases that are used with the GeoIP processor.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/geoip/stats" @@ -297,7 +297,7 @@ def get_ip_location_database(

    Get IP geolocation database configurations.

    - ``_ + ``_ :param id: Comma-separated list of database configuration IDs to retrieve. Wildcard (`*`) expressions are supported. To get all database configurations, omit @@ -355,7 +355,7 @@ def get_pipeline( This API returns a local reference of the pipeline.

    - ``_ + ``_ :param id: Comma-separated list of pipeline IDs to retrieve. Wildcard (`*`) expressions are supported. To get all ingest pipelines, omit this parameter or use `*`. @@ -412,7 +412,7 @@ def processor_grok( A grok pattern is like a regular expression that supports aliased expressions that can be reused.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ingest/processor/grok" @@ -534,7 +534,7 @@ def put_ip_location_database(

    Create or update an IP geolocation database configuration.

    - ``_ + ``_ :param id: The database configuration identifier. :param configuration: @@ -620,7 +620,7 @@ def put_pipeline( Changes made using this API take effect immediately.

    - ``_ + ``_ :param id: ID of the ingest pipeline to create or update. :param deprecated: Marks this ingest pipeline as deprecated. When a deprecated @@ -717,7 +717,7 @@ def simulate( You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.

    - ``_ + ``_ :param docs: Sample documents to test in the pipeline. :param id: The pipeline to test. If you don't specify a `pipeline` in the request diff --git a/elasticsearch/_sync/client/license.py b/elasticsearch/_sync/client/license.py index 2b1174121..e380dbf70 100644 --- a/elasticsearch/_sync/client/license.py +++ b/elasticsearch/_sync/client/license.py @@ -44,7 +44,7 @@ def delete(

    If the operator privileges feature is enabled, only operator users can use this API.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. :param timeout: The period to wait for a response. If no response is received @@ -98,7 +98,7 @@ def get( - ``_ + ``_ :param accept_enterprise: If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum @@ -147,7 +147,7 @@ def get_basic_status(

    Get the basic license status.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/basic_status" @@ -185,7 +185,7 @@ def get_trial_status(

    Get the trial status.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_license/trial_status" @@ -308,7 +308,7 @@ def post_start_basic(

    To check the status of your basic license, use the get basic license API.

    - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) @@ -365,7 +365,7 @@ def post_start_trial(

    To check the status of your trial, use the get trial status API.

    - ``_ + ``_ :param acknowledge: whether the user has acknowledged acknowledge messages (default: false) diff --git a/elasticsearch/_sync/client/logstash.py b/elasticsearch/_sync/client/logstash.py index e329058a3..8f8e6ee4f 100644 --- a/elasticsearch/_sync/client/logstash.py +++ b/elasticsearch/_sync/client/logstash.py @@ -43,7 +43,7 @@ def delete_pipeline( If the request succeeds, you receive an empty response with an appropriate status code.

    - ``_ + ``_ :param id: An identifier for the pipeline. """ @@ -87,7 +87,7 @@ def get_pipeline( Get pipelines that are used for Logstash Central Management.

    - ``_ + ``_ :param id: A comma-separated list of pipeline identifiers. """ @@ -139,7 +139,7 @@ def put_pipeline( If the specified pipeline exists, it is replaced.

    - ``_ + ``_ :param id: An identifier for the pipeline. :param pipeline: diff --git a/elasticsearch/_sync/client/migration.py b/elasticsearch/_sync/client/migration.py index a9476162c..ae803e2ec 100644 --- a/elasticsearch/_sync/client/migration.py +++ b/elasticsearch/_sync/client/migration.py @@ -44,7 +44,7 @@ def deprecations( You are strongly recommended to use the Upgrade Assistant.

    - ``_ + ``_ :param index: Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. @@ -94,7 +94,7 @@ def get_feature_upgrade_status( You are strongly recommended to use the Upgrade Assistant.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" @@ -136,7 +136,7 @@ def post_feature_upgrade(

    TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_migration/system_features" diff --git a/elasticsearch/_sync/client/ml.py b/elasticsearch/_sync/client/ml.py index 15ebddb41..8fed5c2d6 100644 --- a/elasticsearch/_sync/client/ml.py +++ b/elasticsearch/_sync/client/ml.py @@ -45,7 +45,7 @@ def clear_trained_model_deployment_cache( Calling this API clears the caches without restarting the deployment.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. """ @@ -100,7 +100,7 @@ def close_job( When a datafeed that has a specified end date stops, it automatically closes its associated job.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection @@ -165,7 +165,7 @@ def delete_calendar(

    Remove all scheduled events from a calendar, then delete it.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. """ @@ -209,7 +209,7 @@ def delete_calendar_event(

    Delete events from a calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param event_id: Identifier for the scheduled event. You can obtain this identifier @@ -260,7 +260,7 @@ def delete_calendar_job(

    Delete anomaly jobs from a calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -312,7 +312,7 @@ def delete_data_frame_analytics(

    Delete a data frame analytics job.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param force: If `true`, it deletes a job that is not stopped; this method is @@ -363,7 +363,7 @@ def delete_datafeed(

    Delete a datafeed.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -426,7 +426,7 @@ def delete_expired_data( <job_id>.

    - ``_ + ``_ :param job_id: Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. @@ -490,7 +490,7 @@ def delete_filter( filter. You must update or delete the job before you can delete the filter.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. """ @@ -540,7 +540,7 @@ def delete_forecast( forecasts before they expire.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param forecast_id: A comma-separated list of forecast identifiers. If you do @@ -616,7 +616,7 @@ def delete_job( delete job request.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param delete_user_annotations: Specifies whether annotations that have been @@ -676,7 +676,7 @@ def delete_model_snapshot( the model_snapshot_id in the results from the get jobs API.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -728,7 +728,7 @@ def delete_trained_model(

    The request deletes a trained inference model that is not referenced by an ingest pipeline.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param force: Forcefully deletes a trained model that is referenced by ingest @@ -783,7 +783,7 @@ def delete_trained_model_alias( by the model_id, this API returns an error.

    - ``_ + ``_ :param model_id: The trained model ID to which the model alias refers. :param model_alias: The model alias to delete. @@ -844,7 +844,7 @@ def estimate_model_memory( estimates for the fields it references.

    - ``_ + ``_ :param analysis_config: For a list of the properties that you can specify in the `analysis_config` component of the body of this API. @@ -916,7 +916,7 @@ def evaluate_data_frame( field and an analytics result field to be present.

    - ``_ + ``_ :param evaluation: Defines the type of evaluation you want to perform. :param index: Defines the `index` in which the evaluation will be performed. @@ -1001,7 +1001,7 @@ def explain_data_frame_analytics( - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -1112,7 +1112,7 @@ def flush_job( analyzing further data.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param advance_time: Refer to the description for the `advance_time` query parameter. @@ -1187,7 +1187,7 @@ def forecast( based on historical data.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must be open when you create a forecast; otherwise, an error occurs. @@ -1273,7 +1273,7 @@ def get_buckets( The API presents a chronological view of the records, grouped by bucket.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timestamp: The timestamp of a single bucket result. If you do not specify @@ -1371,7 +1371,7 @@ def get_calendar_events(

    Get info about events in calendars.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1440,7 +1440,7 @@ def get_calendars(

    Get calendar configuration info.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids @@ -1516,7 +1516,7 @@ def get_categories(

    Get anomaly detection job results for categories.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param category_id: Identifier for the category, which is unique in the job. @@ -1604,7 +1604,7 @@ def get_data_frame_analytics( wildcard expression.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1679,7 +1679,7 @@ def get_data_frame_analytics_stats(

    Get data frame analytics job stats.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame @@ -1753,7 +1753,7 @@ def get_datafeed_stats( This API returns a maximum of 10,000 datafeeds.

    - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1817,7 +1817,7 @@ def get_datafeeds( This API returns a maximum of 10,000 datafeeds.

    - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the @@ -1884,7 +1884,7 @@ def get_filters( You can get a single filter or all filters.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param from_: Skips the specified number of filters. @@ -1952,7 +1952,7 @@ def get_influencers( influencer_field_name is specified in the job configuration.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: If true, the results are sorted in descending order. @@ -2036,7 +2036,7 @@ def get_job_stats(

    Get anomaly detection job stats.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. If @@ -2100,7 +2100,7 @@ def get_jobs( _all, by specifying * as the <job_id>, or by omitting the <job_id>.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. If you do not specify one of these @@ -2166,7 +2166,7 @@ def get_memory_stats( on each node, both within the JVM heap, and natively, outside of the JVM.

    - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or `ml:true` @@ -2224,7 +2224,7 @@ def get_model_snapshot_upgrade_stats(

    Get anomaly detection job model snapshot upgrade usage info.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2298,7 +2298,7 @@ def get_model_snapshots(

    Get model snapshots info.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -2418,7 +2418,7 @@ def get_overall_buckets( jobs' largest bucket span.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. It can be a job identifier, a group name, a comma-separated list of jobs or groups, or a wildcard expression. @@ -2528,7 +2528,7 @@ def get_records( number of detectors.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param desc: Refer to the description for the `desc` query parameter. @@ -2627,7 +2627,7 @@ def get_trained_models(

    Get trained model configuration info.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. You can get information for multiple trained models in a single API request @@ -2718,7 +2718,7 @@ def get_trained_models_stats( models in a single API request by using a comma-separated list of model IDs or a wildcard expression.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model or a model alias. It can be a comma-separated list or a wildcard expression. @@ -2784,7 +2784,7 @@ def infer_trained_model(

    Evaluate a trained model.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param docs: An array of objects to pass to the model for inference. The objects @@ -2851,7 +2851,7 @@ def info( cluster configuration.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ml/info" @@ -2900,7 +2900,7 @@ def open_job( new data is received.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param timeout: Refer to the description for the `timeout` query parameter. @@ -2957,7 +2957,7 @@ def post_calendar_events(

    Add scheduled events to the calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param events: A list of one of more scheduled events. The event’s start and @@ -3018,7 +3018,7 @@ def post_data( It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. @@ -3085,7 +3085,7 @@ def preview_data_frame_analytics( Preview the extracted features used by a data frame analytics config.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. :param config: A data frame analytics config as described in create data frame @@ -3158,7 +3158,7 @@ def preview_datafeed( You can also use secondary authorization headers to supply the credentials.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3237,7 +3237,7 @@ def put_calendar(

    Create a calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param description: A description of the calendar. @@ -3294,7 +3294,7 @@ def put_calendar_job(

    Add anomaly detection job to calendar.

    - ``_ + ``_ :param calendar_id: A string that uniquely identifies a calendar. :param job_id: An identifier for the anomaly detection jobs. It can be a job @@ -3377,7 +3377,7 @@ def put_data_frame_analytics(

    If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -3562,7 +3562,7 @@ def put_datafeed( directly to the .ml-config index. Do not give users write privileges on the .ml-config index.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -3724,7 +3724,7 @@ def put_filter( Specifically, filters are referenced in the custom_rules property of detector configuration objects.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param description: A description of the filter. @@ -3826,7 +3826,7 @@ def put_job( If you include a datafeed_config but do not provide a query, the datafeed uses {"match_all": {"boost": 1}}.

    - ``_ + ``_ :param job_id: The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and @@ -4034,7 +4034,7 @@ def put_trained_model( Enable you to supply a trained model that is not created by data frame analytics.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param compressed_definition: The compressed (GZipped and Base64 encoded) inference @@ -4155,7 +4155,7 @@ def put_trained_model_alias( returns a warning.

    - ``_ + ``_ :param model_id: The identifier for the trained model that the alias refers to. :param model_alias: The alias to create or update. This value cannot end in numbers. @@ -4216,7 +4216,7 @@ def put_trained_model_definition_part(

    Create part of a trained model definition.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param part: The definition part number. When the definition is loaded for inference @@ -4298,7 +4298,7 @@ def put_trained_model_vocabulary( The vocabulary is stored in the index as described in inference_config.*.vocabulary of the trained model definition.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param vocabulary: The model vocabulary, which must not be empty. @@ -4361,7 +4361,7 @@ def reset_job( comma separated list.

    - ``_ + ``_ :param job_id: The ID of the job to reset. :param delete_user_annotations: Specifies whether annotations that have been @@ -4425,7 +4425,7 @@ def revert_model_snapshot( snapshot after Black Friday or a critical system failure.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: You can specify `empty` as the . Reverting to @@ -4500,7 +4500,7 @@ def set_upgrade_mode( machine learning info API.

    - ``_ + ``_ :param enabled: When `true`, it enables `upgrade_mode` which temporarily halts all job and datafeed tasks and prohibits new job and datafeed tasks from @@ -4560,7 +4560,7 @@ def start_data_frame_analytics( the destination index in advance with custom settings and mappings.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4623,7 +4623,7 @@ def start_datafeed( authorization headers when you created or updated the datafeed, those credentials are used instead.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -4700,7 +4700,7 @@ def start_trained_model_deployment( It allocates the model to every machine learning node.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. Currently, only PyTorch models are supported. @@ -4801,7 +4801,7 @@ def stop_data_frame_analytics( throughout its lifecycle.

    - ``_ + ``_ :param id: Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -4871,7 +4871,7 @@ def stop_datafeed( multiple times throughout its lifecycle.

    - ``_ + ``_ :param datafeed_id: Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a @@ -4936,7 +4936,7 @@ def stop_trained_model_deployment(

    Stop a trained model deployment.

    - ``_ + ``_ :param model_id: The unique identifier of the trained model. :param allow_no_match: Specifies what to do when the request: contains wildcard @@ -5119,7 +5119,7 @@ def update_datafeed( those credentials are used instead.

    - ``_ + ``_ :param datafeed_id: A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z @@ -5286,7 +5286,7 @@ def update_filter( Updates the description of a filter, adds items, or removes items from the list.

    - ``_ + ``_ :param filter_id: A string that uniquely identifies a filter. :param add_items: The items to add to the filter. @@ -5380,7 +5380,7 @@ def update_job( Updates certain properties of an anomaly detection job.

    - ``_ + ``_ :param job_id: Identifier for the job. :param allow_lazy_open: Advanced configuration option. Specifies whether this @@ -5512,7 +5512,7 @@ def update_model_snapshot( Updates certain properties of a snapshot.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: Identifier for the model snapshot. @@ -5654,7 +5654,7 @@ def upgrade_job_snapshot( job.

    - ``_ + ``_ :param job_id: Identifier for the anomaly detection job. :param snapshot_id: A numerical character string that uniquely identifies the @@ -5733,7 +5733,7 @@ def validate(

    Validate an anomaly detection job.

    - ``_ + ``_ :param analysis_config: :param analysis_limits: diff --git a/elasticsearch/_sync/client/nodes.py b/elasticsearch/_sync/client/nodes.py index b64f3abf0..cabcfc1db 100644 --- a/elasticsearch/_sync/client/nodes.py +++ b/elasticsearch/_sync/client/nodes.py @@ -50,7 +50,7 @@ def clear_repositories_metering_archive( Clear the archived repositories metering information in the cluster.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -105,7 +105,7 @@ def get_repositories_metering_info( Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. All the nodes selective options are explained [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster.html#cluster-nodes). @@ -162,7 +162,7 @@ def hot_threads( The output is plain text with a breakdown of the top hot threads for each node.

    - ``_ + ``_ :param node_id: List of node IDs or names used to limit returned information. :param ignore_idle_threads: If true, known idle threads (e.g. waiting in a socket @@ -235,7 +235,7 @@ def info(

    By default, the API returns all attributes and core settings for cluster nodes.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -308,7 +308,7 @@ def reload_secure_settings( Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password.

    - ``_ + ``_ :param node_id: The names of particular nodes in the cluster to target. :param secure_settings_password: The password for the Elasticsearch keystore. @@ -383,7 +383,7 @@ def stats( By default, all stats are returned. You can limit the returned information by using metrics.

    - ``_ + ``_ :param node_id: Comma-separated list of node IDs or names used to limit returned information. @@ -498,7 +498,7 @@ def usage(

    Get feature usage information.

    - ``_ + ``_ :param node_id: A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting diff --git a/elasticsearch/_sync/client/query_rules.py b/elasticsearch/_sync/client/query_rules.py index 2b322949c..f1134650b 100644 --- a/elasticsearch/_sync/client/query_rules.py +++ b/elasticsearch/_sync/client/query_rules.py @@ -44,7 +44,7 @@ def delete_rule( This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to delete @@ -97,7 +97,7 @@ def delete_ruleset( This is a destructive action that is not recoverable.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to delete """ @@ -142,7 +142,7 @@ def get_rule( Get details about a query rule within a query ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to retrieve @@ -194,7 +194,7 @@ def get_ruleset( Get details about a query ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset """ @@ -241,7 +241,7 @@ def list_rulesets( Get summarized information about the query rulesets.

    - ``_ + ``_ :param from_: The offset from the first result to fetch. :param size: The maximum number of results to retrieve. @@ -302,7 +302,7 @@ def put_rule( If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset containing the rule to be created or updated. @@ -389,7 +389,7 @@ def put_ruleset( If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated. @@ -446,7 +446,7 @@ def test( Evaluate match criteria against a query ruleset to identify the rules that would match that criteria.

    - ``_ + ``_ :param ruleset_id: The unique identifier of the query ruleset to be created or updated diff --git a/elasticsearch/_sync/client/rollup.py b/elasticsearch/_sync/client/rollup.py index 84ca3d410..ae8b0c946 100644 --- a/elasticsearch/_sync/client/rollup.py +++ b/elasticsearch/_sync/client/rollup.py @@ -67,7 +67,7 @@ def delete_job( - ``_ + ``_ :param id: Identifier for the job. """ @@ -115,7 +115,7 @@ def get_jobs( For details about a historical rollup job, the rollup capabilities API may be more useful.

    - ``_ + ``_ :param id: Identifier for the rollup job. If it is `_all` or omitted, the API returns all rollup jobs. @@ -171,7 +171,7 @@ def get_rollup_caps( - ``_ + ``_ :param id: Index, indices or index-pattern to return rollup capabilities for. `_all` may be used to fetch rollup capabilities from all jobs. @@ -225,7 +225,7 @@ def get_rollup_index_caps( - ``_ + ``_ :param index: Data stream or index to check for rollup capabilities. Wildcard (`*`) expressions are supported. @@ -295,7 +295,7 @@ def put_job(

    Jobs are created in a STOPPED state. You can start them with the start rollup jobs API.

    - ``_ + ``_ :param id: Identifier for the rollup job. This can be any alphanumeric string and uniquely identifies the data that is associated with the rollup job. @@ -443,7 +443,7 @@ def rollup_search( During the merging process, if there is any overlap in buckets between the two responses, the buckets from the non-rollup index are used.

    - ``_ + ``_ :param index: A comma-separated list of data streams and indices used to limit the request. This parameter has the following rules: * At least one data @@ -521,7 +521,7 @@ def start_job( If you try to start a job that is already started, nothing happens.

    - ``_ + ``_ :param id: Identifier for the rollup job. """ @@ -575,7 +575,7 @@ def stop_job( If the specified time elapses without the job moving to STOPPED, a timeout exception occurs.

    - ``_ + ``_ :param id: Identifier for the rollup job. :param timeout: If `wait_for_completion` is `true`, the API blocks for (at maximum) diff --git a/elasticsearch/_sync/client/search_application.py b/elasticsearch/_sync/client/search_application.py index 7309f9ec4..d50dc454b 100644 --- a/elasticsearch/_sync/client/search_application.py +++ b/elasticsearch/_sync/client/search_application.py @@ -49,7 +49,7 @@ def delete(

    Remove a search application and its associated alias. Indices attached to the search application are not removed.

    - ``_ + ``_ :param name: The name of the search application to delete. """ @@ -94,7 +94,7 @@ def delete_behavioral_analytics( The associated data stream is also deleted.

    - ``_ + ``_ :param name: The name of the analytics collection to be deleted """ @@ -138,7 +138,7 @@ def get(

    Get search application details.

    - ``_ + ``_ :param name: The name of the search application """ @@ -182,7 +182,7 @@ def get_behavioral_analytics(

    Get behavioral analytics collections.

    - ``_ + ``_ :param name: A list of analytics collections to limit the returned information """ @@ -234,7 +234,7 @@ def list( Get information about search applications.

    - ``_ + ``_ :param from_: Starting offset. :param q: Query in the Lucene query string syntax. @@ -290,7 +290,7 @@ def post_behavioral_analytics_event(

    Create a behavioral analytics collection event.

    - ``_ + ``_ :param collection_name: The name of the behavioral analytics collection. :param event_type: The analytics event type. @@ -357,7 +357,7 @@ def put(

    Create or update a search application.

    - ``_ + ``_ :param name: The name of the search application to be created or updated. :param search_application: @@ -414,7 +414,7 @@ def put_behavioral_analytics(

    Create a behavioral analytics collection.

    - ``_ + ``_ :param name: The name of the analytics collection to be created or updated. """ @@ -467,7 +467,7 @@ def render_query(

    You must have read privileges on the backing alias of the search application.

    - ``_ + ``_ :param name: The name of the search application to render teh query for. :param params: @@ -531,7 +531,7 @@ def search( Unspecified template parameters are assigned their default values if applicable.

    - ``_ + ``_ :param name: The name of the search application to be searched. :param params: Query parameters specific to this request, which will override diff --git a/elasticsearch/_sync/client/searchable_snapshots.py b/elasticsearch/_sync/client/searchable_snapshots.py index 0d5575c0c..b5eee7a42 100644 --- a/elasticsearch/_sync/client/searchable_snapshots.py +++ b/elasticsearch/_sync/client/searchable_snapshots.py @@ -50,7 +50,7 @@ def cache_stats( Get statistics about the shared cache for partially mounted indices.

    - ``_ + ``_ :param node_id: The names of the nodes in the cluster to target. :param master_timeout: @@ -111,7 +111,7 @@ def clear_cache( Clear indices and data streams from the shared cache for partially mounted indices.

    - ``_ + ``_ :param index: A comma-separated list of data streams, indices, and aliases to clear from the cache. It supports wildcards (`*`). @@ -190,7 +190,7 @@ def mount( Manually mounting ILM-managed snapshots can interfere with ILM processes.

    - ``_ + ``_ :param repository: The name of the repository containing the snapshot of the index to mount. @@ -278,7 +278,7 @@ def stats(

    Get searchable snapshot statistics.

    - ``_ + ``_ :param index: A comma-separated list of data streams and indices to retrieve statistics for. diff --git a/elasticsearch/_sync/client/security.py b/elasticsearch/_sync/client/security.py index c0c7840ec..055f73c8b 100644 --- a/elasticsearch/_sync/client/security.py +++ b/elasticsearch/_sync/client/security.py @@ -58,7 +58,7 @@ def activate_user_profile( Any updates do not change existing content for either the labels or data fields.

    - ``_ + ``_ :param grant_type: The type of grant. :param access_token: The user's Elasticsearch access token or JWT. Both `access` @@ -124,7 +124,7 @@ def authenticate( If the user cannot be authenticated, this API returns a 401 status code.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/_authenticate" @@ -171,7 +171,7 @@ def bulk_delete_role( The bulk delete roles API cannot delete roles that are defined in roles files.

    - ``_ + ``_ :param names: An array of role names to delete :param refresh: If `true` (the default) then refresh the affected shards to make @@ -232,7 +232,7 @@ def bulk_put_role( The bulk create or update roles API cannot update roles that are defined in roles files.

    - ``_ + ``_ :param roles: A dictionary of role name to RoleDescriptor objects to add or update :param refresh: If `true` (the default) then refresh the affected shards to make @@ -300,7 +300,7 @@ def bulk_update_api_keys(

    A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update.

    - ``_ + ``_ :param ids: The API key identifiers. :param expiration: Expiration time for the API keys. By default, API keys never @@ -378,7 +378,7 @@ def change_password(

    Change the passwords of users in the native realm and built-in users.

    - ``_ + ``_ :param username: The user whose password you want to change. If you do not specify this parameter, the password is changed for the current user. @@ -445,7 +445,7 @@ def clear_api_key_cache( The cache is also automatically cleared on state changes of the security index.

    - ``_ + ``_ :param ids: Comma-separated list of API key IDs to evict from the API key cache. To evict all API keys, use `*`. Does not support other wildcard patterns. @@ -491,7 +491,7 @@ def clear_cached_privileges( The cache is also automatically cleared for applications that have their privileges updated.

    - ``_ + ``_ :param application: A comma-separated list of applications. To clear all applications, use an asterism (`*`). It does not support other wildcard patterns. @@ -541,7 +541,7 @@ def clear_cached_realms( For more information, refer to the documentation about controlling the user cache.

    - ``_ + ``_ :param realms: A comma-separated list of realms. To clear all realms, use an asterisk (`*`). It does not support other wildcard patterns. @@ -591,7 +591,7 @@ def clear_cached_roles(

    Evict roles from the native role cache.

    - ``_ + ``_ :param name: A comma-separated list of roles to evict from the role cache. To evict all roles, use an asterisk (`*`). It does not support other wildcard @@ -643,7 +643,7 @@ def clear_cached_service_tokens( The cache for tokens backed by the service_tokens file is cleared automatically on file changes.

    - ``_ + ``_ :param namespace: The namespace, which is a top-level grouping of service accounts. :param service: The name of the service, which must be unique within its namespace. @@ -715,7 +715,7 @@ def create_api_key( To configure or turn off the API key service, refer to API key service setting documentation.

    - ``_ + ``_ :param expiration: The expiration time for the API key. By default, API keys never expire. @@ -805,7 +805,7 @@ def create_cross_cluster_api_key( Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error.

    - ``_ + ``_ :param access: The access to be granted to this API key. The access is composed of permissions for cross-cluster search and cross-cluster replication. At @@ -880,7 +880,7 @@ def create_service_token( You must actively delete them if they are no longer needed.

    - ``_ + ``_ :param namespace: The name of the namespace, which is a top-level grouping of service accounts. @@ -966,7 +966,7 @@ def delegate_pki( The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token.

    - ``_ + ``_ :param x509_certificate_chain: The X509Certificate chain, which is represented as an ordered string array. Each string in the array is a base64-encoded @@ -1030,7 +1030,7 @@ def delete_privileges( - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. @@ -1093,7 +1093,7 @@ def delete_role( The delete roles API cannot remove roles that are defined in roles files.

    - ``_ + ``_ :param name: The name of the role. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1147,7 +1147,7 @@ def delete_role_mapping( The delete role mappings API cannot remove role mappings that are defined in role mapping files.

    - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -1203,7 +1203,7 @@ def delete_service_token(

    Delete service account tokens for a service in a specified namespace.

    - ``_ + ``_ :param namespace: The namespace, which is a top-level grouping of service accounts. :param service: The service name. @@ -1265,7 +1265,7 @@ def delete_user(

    Delete users from the native realm.

    - ``_ + ``_ :param username: An identifier for the user. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1319,7 +1319,7 @@ def disable_user( You can use this API to revoke a user's access to Elasticsearch.

    - ``_ + ``_ :param username: An identifier for the user. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1376,7 +1376,7 @@ def disable_user_profile( To re-enable a disabled user profile, use the enable user profile API .

    - ``_ + ``_ :param uid: Unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1429,7 +1429,7 @@ def enable_user( By default, when you create users, they are enabled.

    - ``_ + ``_ :param username: An identifier for the user. :param refresh: If `true` (the default) then refresh the affected shards to make @@ -1486,7 +1486,7 @@ def enable_user_profile( If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again.

    - ``_ + ``_ :param uid: A unique identifier for the user profile. :param refresh: If 'true', Elasticsearch refreshes the affected shards to make @@ -1536,7 +1536,7 @@ def enroll_kibana( Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/kibana" @@ -1577,7 +1577,7 @@ def enroll_node( The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/enroll/node" @@ -1626,7 +1626,7 @@ def get_api_key( If you have read_security, manage_api_key or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

    - ``_ + ``_ :param active_only: A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, @@ -1704,7 +1704,7 @@ def get_builtin_privileges(

    Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_security/privilege/_builtin" @@ -1749,7 +1749,7 @@ def get_privileges( - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -1805,7 +1805,7 @@ def get_role( The get roles API cannot retrieve roles that are defined in roles files.

    - ``_ + ``_ :param name: The name of the role. You can specify multiple roles as a comma-separated list. If you do not specify this parameter, the API returns information about @@ -1856,7 +1856,7 @@ def get_role_mapping( The get role mappings API cannot retrieve role mappings that are defined in role mapping files.

    - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -1909,7 +1909,7 @@ def get_service_accounts(

    NOTE: Currently, only the elastic/fleet-server service account is available.

    - ``_ + ``_ :param namespace: The name of the namespace. Omit this parameter to retrieve information about all service accounts. If you omit this parameter, you must @@ -1967,7 +1967,7 @@ def get_service_credentials( Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens.

    - ``_ + ``_ :param namespace: The name of the namespace. :param service: The service name. @@ -2023,7 +2023,7 @@ def get_settings( - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -2099,7 +2099,7 @@ def get_token( If you want to invalidate a token immediately, you can do so by using the invalidate token API.

    - ``_ + ``_ :param grant_type: The type of grant. Supported grant types are: `password`, `_kerberos`, `client_credentials`, and `refresh_token`. @@ -2173,7 +2173,7 @@ def get_user(

    Get information about users in the native realm and built-in users.

    - ``_ + ``_ :param username: An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves @@ -2231,7 +2231,7 @@ def get_user_privileges( To check whether a user has a specific list of privileges, use the has privileges API.

    - ``_ + ``_ :param application: The name of the application. Application privileges are always associated with exactly one application. If you do not specify this parameter, @@ -2288,7 +2288,7 @@ def get_user_profile( Elastic reserves the right to change or remove this feature in future releases without prior notice.

    - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: A comma-separated list of filters for the `data` field of the profile @@ -2372,7 +2372,7 @@ def grant_api_key(

    By default, API keys never expire. You can specify expiration information when you create the API keys.

    - ``_ + ``_ :param api_key: The API key. :param grant_type: The type of grant. Supported grant types are: `access_token`, @@ -2519,7 +2519,7 @@ def has_privileges( To check the privileges of other users, you must use the run as feature.

    - ``_ + ``_ :param user: Username :param application: @@ -2584,7 +2584,7 @@ def has_privileges_user_profile( Elastic reserves the right to change or remove this feature in future releases without prior notice.

    - ``_ + ``_ :param privileges: An object containing all the privileges to be checked. :param uids: A list of profile IDs. The privileges are checked for associated @@ -2658,7 +2658,7 @@ def invalidate_api_key( - ``_ + ``_ :param id: :param ids: A list of API key ids. This parameter cannot be used with any of @@ -2742,7 +2742,7 @@ def invalidate_token( If none of these two are specified, then realm_name and/or username need to be specified.

    - ``_ + ``_ :param realm_name: The name of an authentication realm. This parameter cannot be used with either `refresh_token` or `token`. @@ -2810,7 +2810,7 @@ def oidc_authenticate( These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

    - ``_ + ``_ :param nonce: Associate a client session with an ID token and mitigate replay attacks. This value needs to be the same as the one that was provided to @@ -2890,7 +2890,7 @@ def oidc_logout( These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

    - ``_ + ``_ :param token: The access token to be invalidated. :param refresh_token: The refresh token to be invalidated. @@ -2952,7 +2952,7 @@ def oidc_prepare_authentication( These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients.

    - ``_ + ``_ :param iss: In the case of a third party initiated single sign on, this is the issuer identifier for the OP that the RP is to send the authentication request @@ -3048,7 +3048,7 @@ def put_privileges(

    Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: /, *, :.

    - ``_ + ``_ :param privileges: :param refresh: If `true` (the default) then refresh the affected shards to make @@ -3200,7 +3200,7 @@ def put_role( File-based role management is not available in Elastic Serverless.

    - ``_ + ``_ :param name: The name of the role. :param applications: A list of application privilege entries. @@ -3332,7 +3332,7 @@ def put_role_mapping( If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names.

    - ``_ + ``_ :param name: The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does @@ -3434,7 +3434,7 @@ def put_user( To change a user's password without updating any other fields, use the change password API.

    - ``_ + ``_ :param username: An identifier for the user. NOTE: Usernames must be at least 1 and no more than 507 characters. They can contain alphanumeric characters @@ -3553,7 +3553,7 @@ def query_api_keys( If you have the read_security, manage_api_key, or greater privileges (including manage_security), this API returns all API keys regardless of ownership.

    - ``_ + ``_ :param aggregations: Any aggregations to run over the corpus of returned API keys. Aggregations and queries work together. Aggregations are computed only @@ -3696,7 +3696,7 @@ def query_role( Also, the results can be paginated and sorted.

    - ``_ + ``_ :param from_: The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` @@ -3789,7 +3789,7 @@ def query_user( This API is only for native users.

    - ``_ + ``_ :param from_: The starting document offset. It must not be negative. By default, you cannot page through more than 10,000 hits using the `from` and `size` @@ -3882,7 +3882,7 @@ def saml_authenticate( This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch.

    - ``_ + ``_ :param content: The SAML response as it was sent by the user's browser, usually a Base64 encoded XML document. @@ -3955,7 +3955,7 @@ def saml_complete_logout( The caller of this API must prepare the request accordingly so that this API can handle either of them.

    - ``_ + ``_ :param ids: A JSON array with all the valid SAML Request Ids that the caller of the API has for the current user. @@ -4031,7 +4031,7 @@ def saml_invalidate( Thus the user can be redirected back to their IdP.

    - ``_ + ``_ :param query_string: The query part of the URL that the user was redirected to by the SAML IdP to initiate the Single Logout. This query should include @@ -4106,7 +4106,7 @@ def saml_logout( If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout).

    - ``_ + ``_ :param token: The access token that was returned as a response to calling the SAML authenticate API. Alternatively, the most recent token that was received @@ -4176,7 +4176,7 @@ def saml_prepare_authentication( The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.

    - ``_ + ``_ :param acs: The Assertion Consumer Service URL that matches the one of the SAML realms in Elasticsearch. The realm is used to generate the authentication @@ -4237,7 +4237,7 @@ def saml_service_provider_metadata( This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.

    - ``_ + ``_ :param realm_name: The name of the SAML realm in Elasticsearch. """ @@ -4290,7 +4290,7 @@ def suggest_user_profiles( Elastic reserves the right to change or remove this feature in future releases without prior notice.

    - ``_ + ``_ :param data: A comma-separated list of filters for the `data` field of the profile document. To return all content use `data=*`. To return a subset of content, @@ -4377,7 +4377,7 @@ def update_api_key( This change can occur if the owner user's permissions have changed since the API key was created or last modified.

    - ``_ + ``_ :param id: The ID of the API key to update. :param expiration: The expiration time for the API key. By default, API keys @@ -4465,7 +4465,7 @@ def update_cross_cluster_api_key(

    NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.

    - ``_ + ``_ :param id: The ID of the cross-cluster API key to update. :param access: The access to be granted to this API key. The access is composed @@ -4544,7 +4544,7 @@ def update_settings( This API does not yet support configuring the settings for indices before they are in use.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -4629,7 +4629,7 @@ def update_user_profile_data( The update_profile_data global privilege grants privileges for updating only the allowed namespaces.

    - ``_ + ``_ :param uid: A unique identifier for the user profile. :param data: Non-searchable data that you want to associate with the user profile. diff --git a/elasticsearch/_sync/client/shutdown.py b/elasticsearch/_sync/client/shutdown.py index 9b30f3f51..6d0f2da87 100644 --- a/elasticsearch/_sync/client/shutdown.py +++ b/elasticsearch/_sync/client/shutdown.py @@ -53,7 +53,7 @@ def delete_node(

    If the operator privileges feature is enabled, you must be an operator to use this API.

    - ``_ + ``_ :param node_id: The node id of node to be removed from the shutdown state :param master_timeout: Period to wait for a connection to the master node. If @@ -112,7 +112,7 @@ def get_node(

    If the operator privileges feature is enabled, you must be an operator to use this API.

    - ``_ + ``_ :param node_id: Which node for which to retrieve the shutdown status :param master_timeout: Period to wait for a connection to the master node. If @@ -187,7 +187,7 @@ def put_node( Monitor the node shutdown status to determine when it is safe to stop Elasticsearch.

    - ``_ + ``_ :param node_id: The node identifier. This parameter is not validated against the cluster's active nodes. This enables you to register a node for shut diff --git a/elasticsearch/_sync/client/simulate.py b/elasticsearch/_sync/client/simulate.py index 939754394..3a32869ee 100644 --- a/elasticsearch/_sync/client/simulate.py +++ b/elasticsearch/_sync/client/simulate.py @@ -81,7 +81,7 @@ def ingest( These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.

    - ``_ + ``_ :param docs: Sample documents to test in the pipeline. :param index: The index to simulate ingesting into. This value can be overridden diff --git a/elasticsearch/_sync/client/slm.py b/elasticsearch/_sync/client/slm.py index 9196bc57c..8647cd972 100644 --- a/elasticsearch/_sync/client/slm.py +++ b/elasticsearch/_sync/client/slm.py @@ -45,7 +45,7 @@ def delete_lifecycle( This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.

    - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to remove :param master_timeout: The period to wait for a connection to the master node. @@ -101,7 +101,7 @@ def execute_lifecycle( The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.

    - ``_ + ``_ :param policy_id: The id of the snapshot lifecycle policy to be executed :param master_timeout: The period to wait for a connection to the master node. @@ -156,7 +156,7 @@ def execute_retention( The retention policy is normally applied according to its schedule.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -208,7 +208,7 @@ def get_lifecycle( Get snapshot lifecycle policy definitions and information about the latest snapshot attempts.

    - ``_ + ``_ :param policy_id: Comma-separated list of snapshot lifecycle policies to retrieve :param master_timeout: The period to wait for a connection to the master node. @@ -265,7 +265,7 @@ def get_stats( Get global and policy-level statistics about actions taken by snapshot lifecycle management.

    - ``_ + ``_ :param master_timeout: Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and @@ -315,7 +315,7 @@ def get_status(

    Get the snapshot lifecycle management status.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -379,7 +379,7 @@ def put_lifecycle( Only the latest version of a policy is stored.

    - ``_ + ``_ :param policy_id: The identifier for the snapshot lifecycle policy you want to create or update. @@ -465,7 +465,7 @@ def start( Manually starting SLM is necessary only if it has been stopped using the stop SLM API.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails @@ -523,7 +523,7 @@ def stop( Use the get snapshot lifecycle management status API to see if SLM is running.

    - ``_ + ``_ :param master_timeout: The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails diff --git a/elasticsearch/_sync/client/snapshot.py b/elasticsearch/_sync/client/snapshot.py index 99d89a35b..6decaacdd 100644 --- a/elasticsearch/_sync/client/snapshot.py +++ b/elasticsearch/_sync/client/snapshot.py @@ -50,7 +50,7 @@ def cleanup_repository( Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.

    - ``_ + ``_ :param name: Snapshot repository to clean up. :param master_timeout: Period to wait for a connection to the master node. @@ -107,7 +107,7 @@ def clone( Clone part of all of a snapshot into another snapshot in the same repository.

    - ``_ + ``_ :param repository: A repository name :param snapshot: The name of the snapshot to clone from @@ -191,7 +191,7 @@ def create( Take a snapshot of a cluster or of data streams and indices.

    - ``_ + ``_ :param repository: Repository for the snapshot. :param snapshot: Name of the snapshot. Must be unique in the repository. @@ -301,7 +301,7 @@ def create_repository( Ensure there are no cluster blocks (for example, cluster.blocks.read_only and clsuter.blocks.read_only_allow_delete settings) that prevent write access.

    - ``_ + ``_ :param name: A repository name :param repository: @@ -364,7 +364,7 @@ def delete(

    Delete snapshots.

    - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -420,7 +420,7 @@ def delete_repository( The snapshots themselves are left untouched and in place.

    - ``_ + ``_ :param name: Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. @@ -497,7 +497,7 @@ def get(

    Get snapshot information.

    - ``_ + ``_ :param repository: Comma-separated list of snapshot repository names used to limit the request. Wildcard (*) expressions are supported. @@ -612,7 +612,7 @@ def get_repository(

    Get snapshot repository information.

    - ``_ + ``_ :param name: A comma-separated list of repository names :param local: Return local information, do not retrieve the state from master @@ -750,7 +750,7 @@ def repository_analyze( Some operations also verify the behavior on small blobs with sizes other than 8 bytes.

    - ``_ + ``_ :param name: The name of the repository. :param blob_count: The total number of blobs to write to the repository during @@ -877,7 +877,7 @@ def repository_verify_integrity(

    NOTE: This API may not work correctly in a mixed-version cluster.

    - ``_ + ``_ :param name: A repository name :param blob_thread_pool_concurrency: Number of threads to use for reading blob @@ -987,7 +987,7 @@ def restore(

    If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot.

    - ``_ + ``_ :param repository: A repository name :param snapshot: A snapshot name @@ -1091,7 +1091,7 @@ def status( These requests can also tax machine resources and, when using cloud storage, incur high processing costs.

    - ``_ + ``_ :param repository: A repository name :param snapshot: A comma-separated list of snapshot names @@ -1154,7 +1154,7 @@ def verify_repository( Check for common misconfigurations in a snapshot repository.

    - ``_ + ``_ :param name: A repository name :param master_timeout: Explicit operation timeout for connection to master node diff --git a/elasticsearch/_sync/client/sql.py b/elasticsearch/_sync/client/sql.py index ecdb49a22..cde458be5 100644 --- a/elasticsearch/_sync/client/sql.py +++ b/elasticsearch/_sync/client/sql.py @@ -44,7 +44,7 @@ def clear_cursor(

    Clear an SQL search cursor.

    - ``_ + ``_ :param cursor: Cursor to clear. """ @@ -99,7 +99,7 @@ def delete_async( - ``_ + ``_ :param id: The identifier for the search. """ @@ -150,7 +150,7 @@ def get_async(

    If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API.

    - ``_ + ``_ :param id: The identifier for the search. :param delimiter: The separator for CSV results. The API supports this parameter @@ -212,7 +212,7 @@ def get_async_status( Get the current status of an async SQL search or a stored synchronous SQL search.

    - ``_ + ``_ :param id: The identifier for the search. """ @@ -301,7 +301,7 @@ def query( Run an SQL request.

    - ``_ + ``_ :param allow_partial_search_results: If `true`, the response has partial results when there are shard request timeouts or shard failures. If `false`, the @@ -427,7 +427,7 @@ def translate( It accepts the same request body parameters as the SQL search API, excluding cursor.

    - ``_ + ``_ :param query: The SQL query to run. :param fetch_size: The maximum number of rows (or entries) to return in one response. diff --git a/elasticsearch/_sync/client/ssl.py b/elasticsearch/_sync/client/ssl.py index d65003825..69e531aab 100644 --- a/elasticsearch/_sync/client/ssl.py +++ b/elasticsearch/_sync/client/ssl.py @@ -52,7 +52,7 @@ def certificates(

    If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster.

    - ``_ + ``_ """ __path_parts: t.Dict[str, str] = {} __path = "/_ssl/certificates" diff --git a/elasticsearch/_sync/client/synonyms.py b/elasticsearch/_sync/client/synonyms.py index e58ab5ee4..837b39eca 100644 --- a/elasticsearch/_sync/client/synonyms.py +++ b/elasticsearch/_sync/client/synonyms.py @@ -53,7 +53,7 @@ def delete_synonym( When the synonyms set is not used in analyzers, you will be able to delete it.

    - ``_ + ``_ :param id: The synonyms set identifier to delete. """ @@ -98,7 +98,7 @@ def delete_synonym_rule( Delete a synonym rule from a synonym set.

    - ``_ + ``_ :param set_id: The ID of the synonym set to update. :param rule_id: The ID of the synonym rule to delete. @@ -151,7 +151,7 @@ def get_synonym(

    Get a synonym set.

    - ``_ + ``_ :param id: The synonyms set identifier to retrieve. :param from_: The starting offset for query rules to retrieve. @@ -202,7 +202,7 @@ def get_synonym_rule( Get a synonym rule from a synonym set.

    - ``_ + ``_ :param set_id: The ID of the synonym set to retrieve the synonym rule from. :param rule_id: The ID of the synonym rule to retrieve. @@ -255,7 +255,7 @@ def get_synonyms_sets( Get a summary of all defined synonym sets.

    - ``_ + ``_ :param from_: The starting offset for synonyms sets to retrieve. :param size: The maximum number of synonyms sets to retrieve. @@ -311,7 +311,7 @@ def put_synonym( This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.

    - ``_ + ``_ :param id: The ID of the synonyms set to be created or updated. :param synonyms_set: The synonym rules definitions for the synonyms set. @@ -370,7 +370,7 @@ def put_synonym_rule(

    When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.

    - ``_ + ``_ :param set_id: The ID of the synonym set. :param rule_id: The ID of the synonym rule to be updated or created. diff --git a/elasticsearch/_sync/client/tasks.py b/elasticsearch/_sync/client/tasks.py index 758925370..946b911ba 100644 --- a/elasticsearch/_sync/client/tasks.py +++ b/elasticsearch/_sync/client/tasks.py @@ -60,7 +60,7 @@ def cancel( You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task.

    - ``_ + ``_ :param task_id: The task identifier. :param actions: A comma-separated list or wildcard expression of actions that @@ -128,7 +128,7 @@ def get(

    If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.

    - ``_ + ``_ :param task_id: The task identifier. :param timeout: The period to wait for a response. If no response is received @@ -238,7 +238,7 @@ def list( The X-Opaque-Id in the children headers is the child task of the task that was initiated by the REST request.

    - ``_ + ``_ :param actions: A comma-separated list or wildcard expression of actions used to limit the request. For example, you can use `cluser:*` to retrieve all diff --git a/elasticsearch/_sync/client/text_structure.py b/elasticsearch/_sync/client/text_structure.py index b5c7b67d2..4050bcc16 100644 --- a/elasticsearch/_sync/client/text_structure.py +++ b/elasticsearch/_sync/client/text_structure.py @@ -72,7 +72,7 @@ def find_field_structure( It helps determine why the returned structure was chosen.

    - ``_ + ``_ :param field: The field that should be analyzed. :param index: The name of the index that contains the analyzed field. @@ -259,7 +259,7 @@ def find_message_structure( It helps determine why the returned structure was chosen.

    - ``_ + ``_ :param messages: The list of messages you want to analyze. :param column_names: If the format is `delimited`, you can specify the column @@ -433,7 +433,7 @@ def find_structure( However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.

    - ``_ + ``_ :param text_files: :param charset: The text's character set. It must be a character set that is @@ -620,7 +620,7 @@ def test_grok_pattern( The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.

    - ``_ + ``_ :param grok_pattern: The Grok pattern to run on the text. :param text: The lines of text to run the Grok pattern on. diff --git a/elasticsearch/_sync/client/transform.py b/elasticsearch/_sync/client/transform.py index 13ad2c232..7afb9d45d 100644 --- a/elasticsearch/_sync/client/transform.py +++ b/elasticsearch/_sync/client/transform.py @@ -44,7 +44,7 @@ def delete_transform(

    Delete a transform.

    - ``_ + ``_ :param transform_id: Identifier for the transform. :param delete_dest_index: If this value is true, the destination index is deleted @@ -108,7 +108,7 @@ def get_transform( Get configuration information for transforms.

    - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -181,7 +181,7 @@ def get_transform_stats(

    Get usage information for transforms.

    - ``_ + ``_ :param transform_id: Identifier for the transform. It can be a transform identifier or a wildcard expression. You can get information for all transforms by using @@ -269,7 +269,7 @@ def preview_transform( types of the source index and the transform aggregations.

    - ``_ + ``_ :param transform_id: Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform configuration details in @@ -406,7 +406,7 @@ def put_transform( give users any privileges on .data-frame-internal* indices.

    - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -512,7 +512,7 @@ def reset_transform( If the destination index was created by the transform, it is deleted.

    - ``_ + ``_ :param transform_id: Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. @@ -572,7 +572,7 @@ def schedule_now_transform( is called again in the meantime.

    - ``_ + ``_ :param transform_id: Identifier for the transform. :param timeout: Controls the time to wait for the scheduling to take place @@ -635,7 +635,7 @@ def start_transform( destination indices, the transform fails when it attempts unauthorized operations.

    - ``_ + ``_ :param transform_id: Identifier for the transform. :param from_: Restricts the set of transformed entities to those changed after @@ -693,7 +693,7 @@ def stop_transform( Stops one or more transforms.

    - ``_ + ``_ :param transform_id: Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. To stop all transforms, diff --git a/elasticsearch/_sync/client/xpack.py b/elasticsearch/_sync/client/xpack.py index 73121d5cb..36b5fdecf 100644 --- a/elasticsearch/_sync/client/xpack.py +++ b/elasticsearch/_sync/client/xpack.py @@ -54,7 +54,7 @@ def info( - ``_ + ``_ :param accept_enterprise: If this param is used it must be set to true :param categories: A comma-separated list of the information categories to include diff --git a/elasticsearch/dsl/query.py b/elasticsearch/dsl/query.py index c58d3080a..720f49f78 100644 --- a/elasticsearch/dsl/query.py +++ b/elasticsearch/dsl/query.py @@ -1382,7 +1382,49 @@ def __init__( min_term_freq: Union[int, "DefaultType"] = DEFAULT, min_word_length: Union[int, "DefaultType"] = DEFAULT, routing: Union[str, "DefaultType"] = DEFAULT, - stop_words: Union[str, Sequence[str], "DefaultType"] = DEFAULT, + stop_words: Union[ + Literal[ + "_arabic_", + "_armenian_", + "_basque_", + "_bengali_", + "_brazilian_", + "_bulgarian_", + "_catalan_", + "_cjk_", + "_czech_", + "_danish_", + "_dutch_", + "_english_", + "_estonian_", + "_finnish_", + "_french_", + "_galician_", + "_german_", + "_greek_", + "_hindi_", + "_hungarian_", + "_indonesian_", + "_irish_", + "_italian_", + "_latvian_", + "_lithuanian_", + "_norwegian_", + "_persian_", + "_portuguese_", + "_romanian_", + "_russian_", + "_serbian_", + "_sorani_", + "_spanish_", + "_swedish_", + "_thai_", + "_turkish_", + "_none_", + ], + Sequence[str], + "DefaultType", + ] = DEFAULT, unlike: Union[ Union[str, "types.LikeDocument"], Sequence[Union[str, "types.LikeDocument"]], diff --git a/elasticsearch/dsl/types.py b/elasticsearch/dsl/types.py index 0cd673bda..4bce2c1a6 100644 --- a/elasticsearch/dsl/types.py +++ b/elasticsearch/dsl/types.py @@ -1617,11 +1617,7 @@ class InnerHits(AttrDict[Any]): DefaultType, ] seq_no_primary_term: Union[bool, DefaultType] - fields: Union[ - Union[str, InstrumentedField], - Sequence[Union[str, InstrumentedField]], - DefaultType, - ] + fields: Union[Sequence[Union[str, InstrumentedField]], DefaultType] sort: Union[ Union[Union[str, InstrumentedField], "SortOptions"], Sequence[Union[Union[str, InstrumentedField], "SortOptions"]], @@ -1656,11 +1652,7 @@ def __init__( DefaultType, ] = DEFAULT, seq_no_primary_term: Union[bool, DefaultType] = DEFAULT, - fields: Union[ - Union[str, InstrumentedField], - Sequence[Union[str, InstrumentedField]], - DefaultType, - ] = DEFAULT, + fields: Union[Sequence[Union[str, InstrumentedField]], DefaultType] = DEFAULT, sort: Union[ Union[Union[str, InstrumentedField], "SortOptions"], Sequence[Union[Union[str, InstrumentedField], "SortOptions"]],