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

elasticsearch/_async/client/inference.py

@@ -44,7 +44,10 @@ class InferenceClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete an inference endpoint
+        .. raw:: html
+
+          <p>Delete an inference endpoint</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-inference-api.html>`_
 
@@ -109,7 +112,10 @@ class InferenceClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get an inference endpoint
+        .. raw:: html
+
+          <p>Get an inference endpoint</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-inference-api.html>`_
 
@@ -172,7 +178,10 @@ class InferenceClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Perform inference on the service
+        .. raw:: html
+
+          <p>Perform inference on the service</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/post-inference-api.html>`_
 
@@ -255,21 +264,18 @@ class InferenceClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        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. 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.
+        .. raw:: html
+
+          <p>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 <code>&quot;state&quot;: &quot;fully_allocated&quot;</code> in the response and ensure that the <code>&quot;allocation_count&quot;</code> matches the <code>&quot;target_allocation_count&quot;</code>.
+          Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources.</p>
+          <p>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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-inference-api.html>`_
 
@@ -339,16 +345,14 @@ class InferenceClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update an inference endpoint. Modify `task_settings`, secrets (within `service_settings`),
-        or `num_allocations` for an inference endpoint, depending on the specific endpoint
-        service and `task_type`. 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, Azure, 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.
+        .. raw:: html
+
+          <p>Update an inference endpoint.</p>
+          <p>Modify <code>task_settings</code>, secrets (within <code>service_settings</code>), or <code>num_allocations</code> for an inference endpoint, depending on the specific endpoint service and <code>task_type</code>.</p>
+          <p>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, Azure, 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.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-inference-api.html>`_
 

elasticsearch/_async/client/ingest.py

@@ -38,8 +38,11 @@ class IngestClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete GeoIP database configurations. Delete one or more IP geolocation database
-        configurations.
+        .. raw:: html
+
+          <p>Delete GeoIP database configurations.
+          Delete one or more IP geolocation database configurations.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-geoip-database-api.html>`_
 
@@ -90,7 +93,10 @@ class IngestClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete IP geolocation database configurations.
+        .. raw:: html
+
+          <p>Delete IP geolocation database configurations.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-ip-location-database-api.html>`_
 
@@ -143,7 +149,11 @@ class IngestClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete pipelines. Delete one or more ingest pipelines.
+        .. raw:: html
+
+          <p>Delete pipelines.
+          Delete one or more ingest pipelines.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-pipeline-api.html>`_
 
@@ -192,8 +202,11 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get GeoIP statistics. Get download statistics for GeoIP2 databases that are used
-        with the GeoIP processor.
+        .. raw:: html
+
+          <p>Get GeoIP statistics.
+          Get download statistics for GeoIP2 databases that are used with the GeoIP processor.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/geoip-processor.html>`_
         """
@@ -230,8 +243,11 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get GeoIP database configurations. Get information about one or more IP geolocation
-        database configurations.
+        .. raw:: html
+
+          <p>Get GeoIP database configurations.
+          Get information about one or more IP geolocation database configurations.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-geoip-database-api.html>`_
 
@@ -282,7 +298,10 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get IP geolocation database configurations.
+        .. raw:: html
+
+          <p>Get IP geolocation database configurations.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-ip-location-database-api.html>`_
 
@@ -335,8 +354,12 @@ class IngestClient(NamespacedClient):
         summary: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get pipelines. Get information about one or more ingest pipelines. This API returns
-        a local reference of the pipeline.
+        .. raw:: html
+
+          <p>Get pipelines.
+          Get information about one or more ingest pipelines.
+          This API returns a local reference of the pipeline.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-pipeline-api.html>`_
 
@@ -387,10 +410,13 @@ class IngestClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Run a grok processor. Extract structured fields out of a single text field within
-        a document. You must choose which field to extract matched fields from, as well
-        as the grok pattern you expect will match. A grok pattern is like a regular expression
-        that supports aliased expressions that can be reused.
+        .. raw:: html
+
+          <p>Run a grok processor.
+          Extract structured fields out of a single text field within a document.
+          You must choose which field to extract matched fields from, as well as the grok pattern you expect will match.
+          A grok pattern is like a regular expression that supports aliased expressions that can be reused.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/grok-processor.html>`_
         """
@@ -433,8 +459,11 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a GeoIP database configuration. Refer to the create or update
-        IP geolocation database configuration API.
+        .. raw:: html
+
+          <p>Create or update a GeoIP database configuration.
+          Refer to the create or update IP geolocation database configuration API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-geoip-database-api.html>`_
 
@@ -506,7 +535,10 @@ class IngestClient(NamespacedClient):
         timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update an IP geolocation database configuration.
+        .. raw:: html
+
+          <p>Create or update an IP geolocation database configuration.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/put-ip-location-database-api.html>`_
 
@@ -588,7 +620,11 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a pipeline. Changes made using this API take effect immediately.
+        .. raw:: html
+
+          <p>Create or update a pipeline.
+          Changes made using this API take effect immediately.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/ingest.html>`_
 
@@ -680,9 +716,12 @@ class IngestClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Simulate a pipeline. Run an ingest pipeline against a set of provided documents.
-        You can either specify an existing pipeline to use with the provided documents
-        or supply a pipeline definition in the body of the request.
+        .. raw:: html
+
+          <p>Simulate a pipeline.
+          Run an ingest pipeline against a set of provided documents.
+          You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/simulate-pipeline-api.html>`_
 

elasticsearch/_async/client/license.py

@@ -35,9 +35,12 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete the license. When the license expires, your subscription level reverts
-        to Basic. If the operator privileges feature is enabled, only operator users
-        can use this API.
+        .. raw:: html
+
+          <p>Delete the license.
+          When the license expires, your subscription level reverts to Basic.</p>
+          <p>If the operator privileges feature is enabled, only operator users can use this API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/delete-license.html>`_
         """
@@ -74,11 +77,13 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get license information. Get information about your Elastic license including
-        its type, its status, when it was issued, and when it expires. NOTE: If the master
-        node is generating a new cluster state, the get license API may return a `404
-        Not Found` response. If you receive an unexpected 404 response after cluster
-        startup, wait a short period and retry the request.
+        .. raw:: html
+
+          <p>Get license information.
+          Get information about your Elastic license including its type, its status, when it was issued, and when it expires.</p>
+          <p>NOTE: If the master node is generating a new cluster state, the get license API may return a <code>404 Not Found</code> response.
+          If you receive an unexpected 404 response after cluster startup, wait a short period and retry the request.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-license.html>`_
 
@@ -124,7 +129,10 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get the basic license status.
+        .. raw:: html
+
+          <p>Get the basic license status.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-basic-status.html>`_
         """
@@ -159,7 +167,10 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get the trial status.
+        .. raw:: html
+
+          <p>Get the trial status.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/get-trial-status.html>`_
         """
@@ -200,14 +211,16 @@ class LicenseClient(NamespacedClient):
         body: t.Optional[t.Dict[str, t.Any]] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Update the license. You can update your license at runtime without shutting down
-        your nodes. License updates take effect immediately. If the license you are installing
-        does not support all of the features that were available with your previous license,
-        however, you are notified in the response. You must then re-submit the API request
-        with the acknowledge parameter set to true. NOTE: If Elasticsearch security features
-        are enabled and you are installing a gold or higher license, you must enable
-        TLS on the transport networking layer before you install the license. If the
-        operator privileges feature is enabled, only operator users can use this API.
+        .. raw:: html
+
+          <p>Update the license.
+          You can update your license at runtime without shutting down your nodes.
+          License updates take effect immediately.
+          If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response.
+          You must then re-submit the API request with the acknowledge parameter set to true.</p>
+          <p>NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license.
+          If the operator privileges feature is enabled, only operator users can use this API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/update-license.html>`_
 
@@ -261,13 +274,15 @@ class LicenseClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start a basic license. Start an indefinite basic license, which gives access
-        to all the basic features. NOTE: In order to start a basic license, you must
-        not currently have a basic license. If the basic license does not support all
-        of the features that are available with your current license, however, you are
-        notified in the response. You must then re-submit the API request with the `acknowledge`
-        parameter set to `true`. To check the status of your basic license, use the get
-        basic license API.
+        .. raw:: html
+
+          <p>Start a basic license.
+          Start an indefinite basic license, which gives access to all the basic features.</p>
+          <p>NOTE: In order to start a basic license, you must not currently have a basic license.</p>
+          <p>If the basic license does not support all of the features that are available with your current license, however, you are notified in the response.
+          You must then re-submit the API request with the <code>acknowledge</code> parameter set to <code>true</code>.</p>
+          <p>To check the status of your basic license, use the get basic license API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-basic.html>`_
 
@@ -309,12 +324,14 @@ class LicenseClient(NamespacedClient):
         type_query_string: t.Optional[str] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start a trial. Start a 30-day trial, which gives access to all subscription features.
-        NOTE: You are allowed to start a trial only if your cluster has not already activated
-        a trial for the current major product version. For example, if you have already
-        activated a trial for v8.0, you cannot start a new trial until v9.0. You can,
-        however, request an extended trial at https://www.elastic.co/trialextension.
-        To check the status of your trial, use the get trial status API.
+        .. raw:: html
+
+          <p>Start a trial.
+          Start a 30-day trial, which gives access to all subscription features.</p>
+          <p>NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version.
+          For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at <a href="https://www.elastic.co/trialextension">https://www.elastic.co/trialextension</a>.</p>
+          <p>To check the status of your trial, use the get trial status API.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/start-trial.html>`_
 

elasticsearch/_async/client/logstash.py

@@ -36,9 +36,12 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Delete a Logstash pipeline. Delete a pipeline that is used for Logstash Central
-        Management. If the request succeeds, you receive an empty response with an appropriate
-        status code.
+        .. raw:: html
+
+          <p>Delete a Logstash pipeline.
+          Delete a pipeline that is used for Logstash Central Management.
+          If the request succeeds, you receive an empty response with an appropriate status code.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-delete-pipeline.html>`_
 
@@ -78,7 +81,11 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get Logstash pipelines. Get pipelines that are used for Logstash Central Management.
+        .. raw:: html
+
+          <p>Get Logstash pipelines.
+          Get pipelines that are used for Logstash Central Management.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-get-pipeline.html>`_
 
@@ -125,8 +132,12 @@ class LogstashClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Create or update a Logstash pipeline. Create a pipeline that is used for Logstash
-        Central Management. If the specified pipeline exists, it is replaced.
+        .. raw:: html
+
+          <p>Create or update a Logstash pipeline.</p>
+          <p>Create a pipeline that is used for Logstash Central Management.
+          If the specified pipeline exists, it is replaced.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/logstash-api-put-pipeline.html>`_
 

elasticsearch/_async/client/migration.py

@@ -36,10 +36,13 @@ class MigrationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get deprecation information. Get information about different cluster, node, and
-        index level settings that use deprecated features that will be removed or changed
-        in the next major version. TIP: This APIs is designed for indirect use by the
-        Upgrade Assistant. You are strongly recommended to use the Upgrade Assistant.
+        .. raw:: html
+
+          <p>Get deprecation information.
+          Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version.</p>
+          <p>TIP: This APIs is designed for indirect use by the Upgrade Assistant.
+          You are strongly recommended to use the Upgrade Assistant.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/migration-api-deprecation.html>`_
 
@@ -82,11 +85,14 @@ class MigrationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Get feature migration information. Version upgrades sometimes require changes
-        to how features store configuration information and data in system indices. Check
-        which features need to be migrated and the status of any migrations that are
-        in progress. TIP: This API is designed for indirect use by the Upgrade Assistant.
-        You are strongly recommended to use the Upgrade Assistant.
+        .. raw:: html
+
+          <p>Get feature migration information.
+          Version upgrades sometimes require changes to how features store configuration information and data in system indices.
+          Check which features need to be migrated and the status of any migrations that are in progress.</p>
+          <p>TIP: This API is designed for indirect use by the Upgrade Assistant.
+          You are strongly recommended to use the Upgrade Assistant.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/feature-migration-api.html>`_
         """
@@ -121,11 +127,14 @@ class MigrationClient(NamespacedClient):
         pretty: t.Optional[bool] = None,
     ) -> ObjectApiResponse[t.Any]:
         """
-        Start the feature migration. Version upgrades sometimes require changes to how
-        features store configuration information and data in system indices. This API
-        starts the automatic migration process. Some functionality might be temporarily
-        unavailable during the migration process. TIP: The API is designed for indirect
-        use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.
+        .. raw:: html
+
+          <p>Start the feature migration.
+          Version upgrades sometimes require changes to how features store configuration information and data in system indices.
+          This API starts the automatic migration process.</p>
+          <p>Some functionality might be temporarily unavailable during the migration process.</p>
+          <p>TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant.</p>
+
 
         `<https://www.elastic.co/guide/en/elasticsearch/reference/8.17/feature-migration-api.html>`_
         """