elasticsearch 8.17.1__py3-none-any.whl → 8.17.2__py3-none-any.whl

elasticsearch/_async/client/ssl.py

@@ -35,23 +35,22 @@ class SslClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get SSL certificates. Get information about the X.509 certificates that are used
-        to encrypt communications in the cluster. The API returns a list that includes
-        certificates from all TLS contexts including: - Settings for transport and HTTP
-        interfaces - TLS settings that are used within authentication realms - TLS settings
-        for remote monitoring exporters The list includes certificates that are used
-        for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore`
-        and `xpack.security.transport.ssl.certificate_authorities` settings. It also
-        includes certificates that are used for configuring server identity, such as
-        `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`.
-        The list does not include certificates that are sourced from the default SSL
-        context of the Java Runtime Environment (JRE), even if those certificates are
-        in use within Elasticsearch. NOTE: When a PKCS#11 token is configured as the
-        truststore of the JRE, the API returns all the certificates that are included
-        in the PKCS#11 token irrespective of whether these are used in the Elasticsearch
-        TLS configuration. 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.
+        .. raw:: html
+
+          <p>Get SSL certificates.</p>
+          <p>Get information about the X.509 certificates that are used to encrypt communications in the cluster.
+          The API returns a list that includes certificates from all TLS contexts including:</p>
+          <ul>
+          <li>Settings for transport and HTTP interfaces</li>
+          <li>TLS settings that are used within authentication realms</li>
+          <li>TLS settings for remote monitoring exporters</li>
+          </ul>
+          <p>The list includes certificates that are used for configuring trust, such as those configured in the <code>xpack.security.transport.ssl.truststore</code> and <code>xpack.security.transport.ssl.certificate_authorities</code> settings.
+          It also includes certificates that are used for configuring server identity, such as <code>xpack.security.http.ssl.keystore</code> and <code>xpack.security.http.ssl.certificate settings</code>.</p>
+          <p>The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch.</p>
+          <p>NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/security-api-ssl.html>`_
         """

elasticsearch/_async/client/synonyms.py

@@ -36,21 +36,22 @@ class SynonymsClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a synonym set. You can only delete a synonyms set that is not in use by
-        any index analyzer. Synonyms sets can be used in synonym graph token filters
-        and synonym token filters. These synonym filters can be used as part of search
-        analyzers. Analyzers need to be loaded when an index is restored (such as when
-        a node starts, or the index becomes open). Even if the analyzer is not used on
-        any field mapping, it still needs to be loaded on the index recovery phase. If
-        any analyzers cannot be loaded, the index becomes unavailable and the cluster
-        status becomes red or yellow as index shards are not available. To prevent that,
-        synonyms sets that are used in analyzers can't be deleted. A delete request in
-        this case will return a 400 response code. To remove a synonyms set, you must
-        first remove all indices that contain analyzers using it. You can migrate an
-        index by creating a new index that does not contain the token filter with the
-        synonyms set, and use the reindex API in order to copy over the index data. Once
-        finished, you can delete the index. When the synonyms set is not used in analyzers,
-        you will be able to delete it.
+        .. raw:: html
+
+          <p>Delete a synonym set.</p>
+          <p>You can only delete a synonyms set that is not in use by any index analyzer.</p>
+          <p>Synonyms sets can be used in synonym graph token filters and synonym token filters.
+          These synonym filters can be used as part of search analyzers.</p>
+          <p>Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open).
+          Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase.</p>
+          <p>If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available.
+          To prevent that, synonyms sets that are used in analyzers can't be deleted.
+          A delete request in this case will return a 400 response code.</p>
+          <p>To remove a synonyms set, you must first remove all indices that contain analyzers using it.
+          You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data.
+          Once finished, you can delete the index.
+          When the synonyms set is not used in analyzers, you will be able to delete it.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonyms-set.html>`_
 
@@ -91,7 +92,11 @@ class SynonymsClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a synonym rule. Delete a synonym rule from a synonym set.
+        .. raw:: html
+
+          <p>Delete a synonym rule.
+          Delete a synonym rule from a synonym set.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-synonym-rule.html>`_
 
@@ -141,7 +146,10 @@ class SynonymsClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get a synonym set.
+        .. raw:: html
+
+          <p>Get a synonym set.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonyms-set.html>`_
 
@@ -188,7 +196,11 @@ class SynonymsClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get a synonym rule. Get a synonym rule from a synonym set.
+        .. raw:: html
+
+          <p>Get a synonym rule.
+          Get a synonym rule from a synonym set.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonym-rule.html>`_
 
@@ -237,7 +249,11 @@ class SynonymsClient(NamespacedClient):
         size: t.Optional[int] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get all synonym sets. Get a summary of all defined synonym sets.
+        .. raw:: html
+
+          <p>Get all synonym sets.
+          Get a summary of all defined synonym sets.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-synonyms-set.html>`_
 
@@ -286,12 +302,14 @@ class SynonymsClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a synonym set. Synonyms sets are limited to a maximum of 10,000
-        synonym rules per set. If you need to manage more synonym rules, you can create
-        multiple synonym sets. When an existing synonyms set is updated, the search analyzers
-        that use the synonyms set are reloaded automatically for all indices. This is
-        equivalent to invoking the reload search analyzers API for all indices that use
-        the synonyms set.
+        .. raw:: html
+
+          <p>Create or update a synonym set.
+          Synonyms sets are limited to a maximum of 10,000 synonym rules per set.
+          If you need to manage more synonym rules, you can create multiple synonym sets.</p>
+          <p>When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices.
+          This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonyms-set.html>`_
 
@@ -344,10 +362,13 @@ class SynonymsClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a synonym rule. Create or update a synonym rule in a synonym
-        set. If any of the synonym rules included is invalid, the API returns an error.
-        When you update a synonym rule, all analyzers using the synonyms set will be
-        reloaded automatically to reflect the new rule.
+        .. raw:: html
+
+          <p>Create or update a synonym rule.
+          Create or update a synonym rule in a synonym set.</p>
+          <p>If any of the synonym rules included is invalid, the API returns an error.</p>
+          <p>When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-synonym-rule.html>`_
 

elasticsearch/_async/client/tasks.py

@@ -47,19 +47,18 @@ class TasksClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Cancel a task. WARNING: The task management API is new and should still be considered
-        a beta feature. The API may change in ways that are not backwards compatible.
-        A task may continue to run for some time after it has been cancelled because
-        it may not be able to safely stop its current activity straight away. It is also
-        possible that Elasticsearch must complete its work on other tasks before it can
-        process the cancellation. The get task information API will continue to list
-        these cancelled tasks until they complete. The cancelled flag in the response
-        indicates that the cancellation command has been processed and the task will
-        stop as soon as possible. To troubleshoot why a cancelled task does not complete
-        promptly, use the get task information API with the `?detailed` parameter to
-        identify the other tasks the system is running. 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.
+        .. raw:: html
+
+          <p>Cancel a task.</p>
+          <p>WARNING: The task management API is new and should still be considered a beta feature.
+          The API may change in ways that are not backwards compatible.</p>
+          <p>A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away.
+          It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.
+          The get task information API will continue to list these cancelled tasks until they complete.
+          The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.</p>
+          <p>To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the <code>?detailed</code> parameter to identify the other tasks the system is running.
+          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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
 
@@ -120,11 +119,14 @@ class TasksClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get task information. Get information about a task currently running in the cluster.
-        WARNING: The task management API is new and should still be considered a beta
-        feature. The API may change in ways that are not backwards compatible. If the
-        task identifier is not found, a 404 response code indicates that there are no
-        resources that match the request.
+        .. raw:: html
+
+          <p>Get task information.
+          Get information about a task currently running in the cluster.</p>
+          <p>WARNING: The task management API is new and should still be considered a beta feature.
+          The API may change in ways that are not backwards compatible.</p>
+          <p>If the task identifier is not found, a 404 response code indicates that there are no resources that match the request.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
 
@@ -182,27 +184,60 @@ class TasksClient(NamespacedClient):
         wait_for_completion: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get all tasks. Get information about the tasks currently running on one or more
-        nodes in the cluster. WARNING: The task management API is new and should still
-        be considered a beta feature. The API may change in ways that are not backwards
-        compatible. **Identifying running tasks** The `X-Opaque-Id header`, when provided
-        on the HTTP request header, is going to be returned as a header in the response
-        as well as in the headers field for in the task information. This enables you
-        to track certain calls or associate certain tasks with the client that started
-        them. For example: ``` curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"
-        ``` The API returns the following result: ``` HTTP/1.1 200 OK X-Opaque-Id: 123456
-        content-type: application/json; charset=UTF-8 content-length: 831 { "tasks" :
-        { "u5lcZHqcQhu-rUoFaqDphA:45" : { "node" : "u5lcZHqcQhu-rUoFaqDphA", "id" : 45,
-        "type" : "transport", "action" : "cluster:monitor/tasks/lists", "start_time_in_millis"
-        : 1513823752749, "running_time_in_nanos" : 293139, "cancellable" : false, "headers"
-        : { "X-Opaque-Id" : "123456" }, "children" : [ { "node" : "u5lcZHqcQhu-rUoFaqDphA",
-        "id" : 46, "type" : "direct", "action" : "cluster:monitor/tasks/lists[n]", "start_time_in_millis"
-        : 1513823752750, "running_time_in_nanos" : 92133, "cancellable" : false, "parent_task_id"
-        : "u5lcZHqcQhu-rUoFaqDphA:45", "headers" : { "X-Opaque-Id" : "123456" } } ] }
-        } } ``` In this example, `X-Opaque-Id: 123456` is the ID as a part of the response
-        header. The `X-Opaque-Id` in the task `headers` is the ID for the task that was
-        initiated by the REST request. The `X-Opaque-Id` in the children `headers` is
-        the child task of the task that was initiated by the REST request.
+        .. raw:: html
+
+          <p>Get all tasks.
+          Get information about the tasks currently running on one or more nodes in the cluster.</p>
+          <p>WARNING: The task management API is new and should still be considered a beta feature.
+          The API may change in ways that are not backwards compatible.</p>
+          <p><strong>Identifying running tasks</strong></p>
+          <p>The <code>X-Opaque-Id header</code>, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information.
+          This enables you to track certain calls or associate certain tasks with the client that started them.
+          For example:</p>
+          <pre><code>curl -i -H &quot;X-Opaque-Id: 123456&quot; &quot;http://localhost:9200/_tasks?group_by=parents&quot;
+          </code></pre>
+          <p>The API returns the following result:</p>
+          <pre><code>HTTP/1.1 200 OK
+          X-Opaque-Id: 123456
+          content-type: application/json; charset=UTF-8
+          content-length: 831
+
+          {
+            &quot;tasks&quot; : {
+              &quot;u5lcZHqcQhu-rUoFaqDphA:45&quot; : {
+                &quot;node&quot; : &quot;u5lcZHqcQhu-rUoFaqDphA&quot;,
+                &quot;id&quot; : 45,
+                &quot;type&quot; : &quot;transport&quot;,
+                &quot;action&quot; : &quot;cluster:monitor/tasks/lists&quot;,
+                &quot;start_time_in_millis&quot; : 1513823752749,
+                &quot;running_time_in_nanos&quot; : 293139,
+                &quot;cancellable&quot; : false,
+                &quot;headers&quot; : {
+                  &quot;X-Opaque-Id&quot; : &quot;123456&quot;
+                },
+                &quot;children&quot; : [
+                  {
+                    &quot;node&quot; : &quot;u5lcZHqcQhu-rUoFaqDphA&quot;,
+                    &quot;id&quot; : 46,
+                    &quot;type&quot; : &quot;direct&quot;,
+                    &quot;action&quot; : &quot;cluster:monitor/tasks/lists[n]&quot;,
+                    &quot;start_time_in_millis&quot; : 1513823752750,
+                    &quot;running_time_in_nanos&quot; : 92133,
+                    &quot;cancellable&quot; : false,
+                    &quot;parent_task_id&quot; : &quot;u5lcZHqcQhu-rUoFaqDphA:45&quot;,
+                    &quot;headers&quot; : {
+                      &quot;X-Opaque-Id&quot; : &quot;123456&quot;
+                    }
+                  }
+                ]
+              }
+            }
+           }
+          </code></pre>
+          <p>In this example, <code>X-Opaque-Id: 123456</code> is the ID as a part of the response header.
+          The <code>X-Opaque-Id</code> in the task <code>headers</code> is the ID for the task that was initiated by the REST request.
+          The <code>X-Opaque-Id</code> in the children <code>headers</code> is the child task of the task that was initiated by the REST request.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/tasks.html>`_
 

elasticsearch/_async/client/text_structure.py

@@ -53,22 +53,24 @@ class TextStructureClient(NamespacedClient):
         timestamp_format: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find the structure of a text field. Find the structure of a text field in an
-        Elasticsearch index. This API provides a starting point for extracting further
-        information from log messages already ingested into Elasticsearch. For example,
-        if you have ingested data into a very simple index that has just `@timestamp`
-        and message fields, you can use this API to see what common structure exists
-        in the message field. The response from the API contains: * Sample messages.
-        * Statistics that reveal the most common values for all fields detected within
-        the text and basic numeric statistics for numeric fields. * Information about
-        the structure of the text, which is useful when you write ingest configurations
-        to index it or similarly formatted text. * Appropriate mappings for an Elasticsearch
-        index, which you could use to ingest the text. All this information can be calculated
-        by the structure finder with no guidance. However, you can optionally override
-        some of the decisions about the text structure by specifying one or more query
-        parameters. If the structure finder produces unexpected results, specify the
-        `explain` query parameter and an explanation will appear in the response. It
-        helps determine why the returned structure was chosen.
+        .. raw:: html
+
+          <p>Find the structure of a text field.
+          Find the structure of a text field in an Elasticsearch index.</p>
+          <p>This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.
+          For example, if you have ingested data into a very simple index that has just <code>@timestamp</code> and message fields, you can use this API to see what common structure exists in the message field.</p>
+          <p>The response from the API contains:</p>
+          <ul>
+          <li>Sample messages.</li>
+          <li>Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.</li>
+          <li>Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.</li>
+          <li>Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.</li>
+          </ul>
+          <p>All this information can be calculated by the structure finder with no guidance.
+          However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.</p>
+          <p>If the structure finder produces unexpected results, specify the <code>explain</code> query parameter and an explanation will appear in the response.
+          It helps determine why the returned structure was chosen.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-field-structure.html>`_
 
@@ -237,23 +239,25 @@ class TextStructureClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find the structure of text messages. Find the structure of a list of text messages.
-        The messages must contain data that is suitable to be ingested into Elasticsearch.
-        This API provides a starting point for ingesting data into Elasticsearch in a
-        format that is suitable for subsequent use with other Elastic Stack functionality.
-        Use this API rather than the find text structure API if your input text has already
-        been split up into separate messages by some other process. The response from
-        the API contains: * Sample messages. * Statistics that reveal the most common
-        values for all fields detected within the text and basic numeric statistics for
-        numeric fields. * Information about the structure of the text, which is useful
-        when you write ingest configurations to index it or similarly formatted text.
-        Appropriate mappings for an Elasticsearch index, which you could use to ingest
-        the text. All this information can be calculated by the structure finder with
-        no guidance. However, you can optionally override some of the decisions about
-        the text structure by specifying one or more query parameters. If the structure
-        finder produces unexpected results, specify the `explain` query parameter and
-        an explanation will appear in the response. It helps determine why the returned
-        structure was chosen.
+        .. raw:: html
+
+          <p>Find the structure of text messages.
+          Find the structure of a list of text messages.
+          The messages must contain data that is suitable to be ingested into Elasticsearch.</p>
+          <p>This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
+          Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process.</p>
+          <p>The response from the API contains:</p>
+          <ul>
+          <li>Sample messages.</li>
+          <li>Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.</li>
+          <li>Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.
+          Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.</li>
+          </ul>
+          <p>All this information can be calculated by the structure finder with no guidance.
+          However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.</p>
+          <p>If the structure finder produces unexpected results, specify the <code>explain</code> query parameter and an explanation will appear in the response.
+          It helps determine why the returned structure was chosen.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-message-structure.html>`_
 
@@ -410,22 +414,24 @@ class TextStructureClient(NamespacedClient):
         timestamp_format: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Find the structure of a text file. The text file must contain data that is suitable
-        to be ingested into Elasticsearch. This API provides a starting point for ingesting
-        data into Elasticsearch in a format that is suitable for subsequent use with
-        other Elastic Stack functionality. Unlike other Elasticsearch endpoints, the
-        data that is posted to this endpoint does not need to be UTF-8 encoded and in
-        JSON format. It must, however, be text; binary text formats are not currently
-        supported. The size is limited to the Elasticsearch HTTP receive buffer size,
-        which defaults to 100 Mb. The response from the API contains: * A couple of messages
-        from the beginning of the text. * Statistics that reveal the most common values
-        for all fields detected within the text and basic numeric statistics for numeric
-        fields. * Information about the structure of the text, which is useful when you
-        write ingest configurations to index it or similarly formatted text. * Appropriate
-        mappings for an Elasticsearch index, which you could use to ingest the text.
-        All this information can be calculated by the structure finder with no guidance.
-        However, you can optionally override some of the decisions about the text structure
-        by specifying one or more query parameters.
+        .. raw:: html
+
+          <p>Find the structure of a text file.
+          The text file must contain data that is suitable to be ingested into Elasticsearch.</p>
+          <p>This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
+          Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
+          It must, however, be text; binary text formats are not currently supported.
+          The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.</p>
+          <p>The response from the API contains:</p>
+          <ul>
+          <li>A couple of messages from the beginning of the text.</li>
+          <li>Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.</li>
+          <li>Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.</li>
+          <li>Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.</li>
+          </ul>
+          <p>All this information can be calculated by the structure finder with no guidance.
+          However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/find-structure.html>`_
 
@@ -607,9 +613,12 @@ class TextStructureClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Test a Grok pattern. Test a Grok pattern on one or more lines of text. The API
-        indicates whether the lines match the pattern together with the offsets and lengths
-        of the matched substrings.
+        .. raw:: html
+
+          <p>Test a Grok pattern.
+          Test a Grok pattern on one or more lines of text.
+          The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/test-grok-pattern.html>`_