Auto-generated API code

Author: elasticmachine

elasticsearch/_async/client/cat.py

@@ -3310,10 +3310,20 @@ async def segments(
         self,
         *,
         index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        allow_closed: t.Optional[bool] = None,
+        allow_no_indices: t.Optional[bool] = None,
         bytes: t.Optional[
             t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
         ] = None,
         error_trace: t.Optional[bool] = None,
+        expand_wildcards: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
+                ],
+                t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
+            ]
+        ] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         format: t.Optional[str] = None,
         h: t.Optional[
@@ -3364,6 +3374,8 @@ async def segments(
         ] = None,
         help: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
+        ignore_throttled: t.Optional[bool] = None,
+        ignore_unavailable: t.Optional[bool] = None,
         local: t.Optional[bool] = None,
         master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
@@ -3387,6 +3399,14 @@ async def segments(
         :param index: A comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
             and indices, omit this parameter or use `*` or `_all`.
+        :param allow_closed: If true, allow closed indices to be returned in the response
+            otherwise if false, keep the legacy behaviour of throwing an exception if
+            index pattern matches closed indices
+        :param allow_no_indices: If false, the request returns an error if any wildcard
+            expression, index alias, or _all value targets only missing or closed indices.
+            This behavior applies even if the request targets other open indices. For
+            example, a request targeting foo*,bar* returns an error if an index starts
+            with foo but no index starts with bar.
         :param bytes: Sets the units for columns that contain a byte-size value. Note
             that byte-size value units work in terms of powers of 1024. For instance
             `1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
@@ -3395,12 +3415,20 @@ async def segments(
             least `1.0`. If given, byte-size values are rendered as an integer with no
             suffix, representing the value of the column in the chosen unit. Values that
             are not an exact multiple of the chosen unit are rounded down.
+        :param expand_wildcards: Type of index that wildcard expressions can match. If
+            the request can target data streams, this argument determines whether wildcard
+            expressions match hidden data streams. Supports comma-separated values, such
+            as open,hidden.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :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 ignore_throttled: If true, concrete, expanded or aliased indices are ignored
+            when frozen.
+        :param ignore_unavailable: If true, missing or closed indices are not included
+            in the response.
         :param local: If `true`, the request computes the list of selected nodes from
             the local cluster state. If `false` the list of selected nodes are computed
             from the cluster state of the master node. In both cases the coordinating
@@ -3425,10 +3453,16 @@ async def segments(
             __path_parts = {}
             __path = "/_cat/segments"
         __query: t.Dict[str, t.Any] = {}
+        if allow_closed is not None:
+            __query["allow_closed"] = allow_closed
+        if allow_no_indices is not None:
+            __query["allow_no_indices"] = allow_no_indices
         if bytes is not None:
             __query["bytes"] = bytes
         if error_trace is not None:
             __query["error_trace"] = error_trace
+        if expand_wildcards is not None:
+            __query["expand_wildcards"] = expand_wildcards
         if filter_path is not None:
             __query["filter_path"] = filter_path
         if format is not None:
@@ -3439,6 +3473,10 @@ async def segments(
             __query["help"] = help
         if human is not None:
             __query["human"] = human
+        if ignore_throttled is not None:
+            __query["ignore_throttled"] = ignore_throttled
+        if ignore_unavailable is not None:
+            __query["ignore_unavailable"] = ignore_unavailable
         if local is not None:
             __query["local"] = local
         if master_timeout is not None:

elasticsearch/_async/client/indices.py

@@ -1467,12 +1467,17 @@ async def downsample(
         .. raw:: html
 
           <p>Downsample an index.
-          Aggregate a time series (TSDS) index and store pre-computed statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>) for each metric field grouped by a configured time interval.
-          For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
+          Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:</p>
+          <ul>
+          <li>When running in <code>aggregate</code> mode, it pre-calculates and stores statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>)
+          for each metric field grouped by a configured time interval and their dimensions.</li>
+          <li>When running in <code>last_value</code> mode, it keeps the last value for each metric in the configured interval and their dimensions.</li>
+          </ul>
+          <p>For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
           All documents within an hour interval are summarized and stored as a single document in the downsample index.</p>
           <p>NOTE: Only indices in a time series data stream are supported.
           Neither field nor document level security can be defined on the source index.
-          The source index must be read only (<code>index.blocks.write: true</code>).</p>
+          The source index must be read-only (<code>index.blocks.write: true</code>).</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample>`_
@@ -3701,7 +3706,7 @@ async def put_data_lifecycle(
         *,
         name: t.Union[str, t.Sequence[str]],
         data_retention: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
-        downsampling: t.Optional[t.Mapping[str, t.Any]] = None,
+        downsampling: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         enabled: t.Optional[bool] = None,
         error_trace: t.Optional[bool] = None,
         expand_wildcards: t.Optional[

elasticsearch/_async/client/inference.py

@@ -55,7 +55,9 @@ async def completion(
 
         :param inference_id: The inference Id
         :param input: Inference input. Either a string or an array of strings.
-        :param task_settings: Optional task settings
+        :param task_settings: Task settings for the individual inference request. These
+            settings are specific to the <task_type> you specified and override the task
+            settings specified when initializing the service.
         :param timeout: Specifies the amount of time to wait for the inference request
             to complete.
         """
@@ -127,8 +129,9 @@ async def delete(
 
         :param inference_id: The inference identifier.
         :param task_type: The task type
-        :param dry_run: When true, the endpoint is not deleted and a list of ingest processors
-            which reference this endpoint is returned.
+        :param dry_run: When true, checks the semantic_text fields and inference processors
+            that reference the endpoint and returns them in a list, but does not delete
+            the endpoint.
         :param force: When true, the inference endpoint is forcefully deleted even if
             it is still being used by ingest processors or semantic text fields.
         """
@@ -867,7 +870,7 @@ async def put_anthropic(
         :param service: The type of service supported for the specified task type. In
             this case, `anthropic`.
         :param service_settings: Settings used to install the inference model. These
-            settings are specific to the `watsonxai` service.
+            settings are specific to the `anthropic` service.
         :param chunking_settings: The chunking configuration object.
         :param task_settings: Settings to configure the inference task. These settings
             are specific to the task type you specified.
@@ -959,7 +962,7 @@ async def put_azureaistudio(
         :param service: The type of service supported for the specified task type. In
             this case, `azureaistudio`.
         :param service_settings: Settings used to install the inference model. These
-            settings are specific to the `openai` service.
+            settings are specific to the `azureaistudio` service.
         :param chunking_settings: The chunking configuration object.
         :param task_settings: Settings to configure the inference task. These settings
             are specific to the task type you specified.
@@ -2638,7 +2641,9 @@ async def sparse_embedding(
 
         :param inference_id: The inference Id
         :param input: Inference input. Either a string or an array of strings.
-        :param task_settings: Optional task settings
+        :param task_settings: Task settings for the individual inference request. These
+            settings are specific to the <task_type> you specified and override the task
+            settings specified when initializing the service.
         :param timeout: Specifies the amount of time to wait for the inference request
             to complete.
         """
@@ -2710,7 +2715,9 @@ async def text_embedding(
             to the relevant service-specific documentation for more info. > info > The
             `input_type` parameter specified on the root level of the request body will
             take precedence over the `input_type` parameter specified in `task_settings`.
-        :param task_settings: Optional task settings
+        :param task_settings: Task settings for the individual inference request. These
+            settings are specific to the <task_type> you specified and override the task
+            settings specified when initializing the service.
         :param timeout: Specifies the amount of time to wait for the inference request
             to complete.
         """

elasticsearch/_async/client/security.py

@@ -3763,7 +3763,8 @@ async def query_role(
         :param size: The number of hits to return. It must not be negative. By default,
             you cannot page through more than 10,000 hits using the `from` and `size`
             parameters. To page through more hits, use the `search_after` parameter.
-        :param sort: The sort definition. You can sort on `username`, `roles`, or `enabled`.
+        :param sort: The sort definition. You can sort on `name`, `description`, `metadata`,
+            `applications.application`, `applications.privileges`, and `applications.resources`.
             In addition, sort can also be applied to the `_doc` field to sort by index
             order.
         """

elasticsearch/_sync/client/cat.py

@@ -3310,10 +3310,20 @@ def segments(
         self,
         *,
         index: t.Optional[t.Union[str, t.Sequence[str]]] = None,
+        allow_closed: t.Optional[bool] = None,
+        allow_no_indices: t.Optional[bool] = None,
         bytes: t.Optional[
             t.Union[str, t.Literal["b", "gb", "kb", "mb", "pb", "tb"]]
         ] = None,
         error_trace: t.Optional[bool] = None,
+        expand_wildcards: t.Optional[
+            t.Union[
+                t.Sequence[
+                    t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]]
+                ],
+                t.Union[str, t.Literal["all", "closed", "hidden", "none", "open"]],
+            ]
+        ] = None,
         filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
         format: t.Optional[str] = None,
         h: t.Optional[
@@ -3364,6 +3374,8 @@ def segments(
         ] = None,
         help: t.Optional[bool] = None,
         human: t.Optional[bool] = None,
+        ignore_throttled: t.Optional[bool] = None,
+        ignore_unavailable: t.Optional[bool] = None,
         local: t.Optional[bool] = None,
         master_timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
         pretty: t.Optional[bool] = None,
@@ -3387,6 +3399,14 @@ def segments(
         :param index: A comma-separated list of data streams, indices, and aliases used
             to limit the request. Supports wildcards (`*`). To target all data streams
             and indices, omit this parameter or use `*` or `_all`.
+        :param allow_closed: If true, allow closed indices to be returned in the response
+            otherwise if false, keep the legacy behaviour of throwing an exception if
+            index pattern matches closed indices
+        :param allow_no_indices: If false, the request returns an error if any wildcard
+            expression, index alias, or _all value targets only missing or closed indices.
+            This behavior applies even if the request targets other open indices. For
+            example, a request targeting foo*,bar* returns an error if an index starts
+            with foo but no index starts with bar.
         :param bytes: Sets the units for columns that contain a byte-size value. Note
             that byte-size value units work in terms of powers of 1024. For instance
             `1kb` means 1024 bytes, not 1000 bytes. If omitted, byte-size values are
@@ -3395,12 +3415,20 @@ def segments(
             least `1.0`. If given, byte-size values are rendered as an integer with no
             suffix, representing the value of the column in the chosen unit. Values that
             are not an exact multiple of the chosen unit are rounded down.
+        :param expand_wildcards: Type of index that wildcard expressions can match. If
+            the request can target data streams, this argument determines whether wildcard
+            expressions match hidden data streams. Supports comma-separated values, such
+            as open,hidden.
         :param format: Specifies the format to return the columnar data in, can be set
             to `text`, `json`, `cbor`, `yaml`, or `smile`.
         :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 ignore_throttled: If true, concrete, expanded or aliased indices are ignored
+            when frozen.
+        :param ignore_unavailable: If true, missing or closed indices are not included
+            in the response.
         :param local: If `true`, the request computes the list of selected nodes from
             the local cluster state. If `false` the list of selected nodes are computed
             from the cluster state of the master node. In both cases the coordinating
@@ -3425,10 +3453,16 @@ def segments(
             __path_parts = {}
             __path = "/_cat/segments"
         __query: t.Dict[str, t.Any] = {}
+        if allow_closed is not None:
+            __query["allow_closed"] = allow_closed
+        if allow_no_indices is not None:
+            __query["allow_no_indices"] = allow_no_indices
         if bytes is not None:
             __query["bytes"] = bytes
         if error_trace is not None:
             __query["error_trace"] = error_trace
+        if expand_wildcards is not None:
+            __query["expand_wildcards"] = expand_wildcards
         if filter_path is not None:
             __query["filter_path"] = filter_path
         if format is not None:
@@ -3439,6 +3473,10 @@ def segments(
             __query["help"] = help
         if human is not None:
             __query["human"] = human
+        if ignore_throttled is not None:
+            __query["ignore_throttled"] = ignore_throttled
+        if ignore_unavailable is not None:
+            __query["ignore_unavailable"] = ignore_unavailable
         if local is not None:
             __query["local"] = local
         if master_timeout is not None:

elasticsearch/_sync/client/indices.py

@@ -1467,12 +1467,17 @@ def downsample(
         .. raw:: html
 
           <p>Downsample an index.
-          Aggregate a time series (TSDS) index and store pre-computed statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>) for each metric field grouped by a configured time interval.
-          For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
+          Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:</p>
+          <ul>
+          <li>When running in <code>aggregate</code> mode, it pre-calculates and stores statistical summaries (<code>min</code>, <code>max</code>, <code>sum</code>, <code>value_count</code> and <code>avg</code>)
+          for each metric field grouped by a configured time interval and their dimensions.</li>
+          <li>When running in <code>last_value</code> mode, it keeps the last value for each metric in the configured interval and their dimensions.</li>
+          </ul>
+          <p>For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.
           All documents within an hour interval are summarized and stored as a single document in the downsample index.</p>
           <p>NOTE: Only indices in a time series data stream are supported.
           Neither field nor document level security can be defined on the source index.
-          The source index must be read only (<code>index.blocks.write: true</code>).</p>
+          The source index must be read-only (<code>index.blocks.write: true</code>).</p>
 
 
         `<https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-downsample>`_
@@ -3701,7 +3706,7 @@ def put_data_lifecycle(
         *,
         name: t.Union[str, t.Sequence[str]],
         data_retention: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
-        downsampling: t.Optional[t.Mapping[str, t.Any]] = None,
+        downsampling: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
         enabled: t.Optional[bool] = None,
         error_trace: t.Optional[bool] = None,
         expand_wildcards: t.Optional[