elasticsearch 8.14.0__py3-none-any.whl → 8.15.0__py3-none-any.whl

elasticsearch/_async/client/query_ruleset.py

@@ -1,205 +0,0 @@
-#  Licensed to Elasticsearch B.V. under one or more contributor
-#  license agreements. See the NOTICE file distributed with
-#  this work for additional information regarding copyright
-#  ownership. Elasticsearch B.V. licenses this file to you under
-#  the Apache License, Version 2.0 (the "License"); you may
-#  not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-# 	http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing,
-#  software distributed under the License is distributed on an
-#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-#  KIND, either express or implied.  See the License for the
-#  specific language governing permissions and limitations
-#  under the License.
-
-import typing as t
-
-from elastic_transport import ObjectApiResponse
-
-from ._base import NamespacedClient
-from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
-
-
-class QueryRulesetClient(NamespacedClient):
-
-    @_rewrite_parameters()
-    async def delete(
-        self,
-        *,
-        ruleset_id: str,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Deletes a query ruleset.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-query-ruleset.html>`_
-
-        :param ruleset_id: The unique identifier of the query ruleset to delete
-        """
-        if ruleset_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'ruleset_id'")
-        __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
-        __path = f'/_query_rules/{__path_parts["ruleset_id"]}'
-        __query: t.Dict[str, t.Any] = {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        __headers = {"accept": "application/json"}
-        return await self.perform_request(  # type: ignore[return-value]
-            "DELETE",
-            __path,
-            params=__query,
-            headers=__headers,
-            endpoint_id="query_ruleset.delete",
-            path_parts=__path_parts,
-        )
-
-    @_rewrite_parameters()
-    async def get(
-        self,
-        *,
-        ruleset_id: str,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Returns the details about a query ruleset.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-query-ruleset.html>`_
-
-        :param ruleset_id: The unique identifier of the query ruleset
-        """
-        if ruleset_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'ruleset_id'")
-        __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
-        __path = f'/_query_rules/{__path_parts["ruleset_id"]}'
-        __query: t.Dict[str, t.Any] = {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        __headers = {"accept": "application/json"}
-        return await self.perform_request(  # type: ignore[return-value]
-            "GET",
-            __path,
-            params=__query,
-            headers=__headers,
-            endpoint_id="query_ruleset.get",
-            path_parts=__path_parts,
-        )
-
-    @_rewrite_parameters(
-        parameter_aliases={"from": "from_"},
-    )
-    async def list(
-        self,
-        *,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        from_: t.Optional[int] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-        size: t.Optional[int] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Lists query rulesets.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-query-rulesets.html>`_
-
-        :param from_: Starting offset (default: 0)
-        :param size: specifies a max number of results to get
-        """
-        __path_parts: t.Dict[str, str] = {}
-        __path = "/_query_rules"
-        __query: t.Dict[str, t.Any] = {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if from_ is not None:
-            __query["from"] = from_
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        if size is not None:
-            __query["size"] = size
-        __headers = {"accept": "application/json"}
-        return await self.perform_request(  # type: ignore[return-value]
-            "GET",
-            __path,
-            params=__query,
-            headers=__headers,
-            endpoint_id="query_ruleset.list",
-            path_parts=__path_parts,
-        )
-
-    @_rewrite_parameters(
-        body_fields=("rules",),
-    )
-    async def put(
-        self,
-        *,
-        ruleset_id: str,
-        rules: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-        body: t.Optional[t.Dict[str, t.Any]] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Creates or updates a query ruleset.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-query-ruleset.html>`_
-
-        :param ruleset_id: The unique identifier of the query ruleset to be created or
-            updated
-        :param rules:
-        """
-        if ruleset_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'ruleset_id'")
-        if rules is None and body is None:
-            raise ValueError("Empty value passed for parameter 'rules'")
-        __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
-        __path = f'/_query_rules/{__path_parts["ruleset_id"]}'
-        __query: t.Dict[str, t.Any] = {}
-        __body: t.Dict[str, t.Any] = body if body is not None else {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        if not __body:
-            if rules is not None:
-                __body["rules"] = rules
-        __headers = {"accept": "application/json", "content-type": "application/json"}
-        return await self.perform_request(  # type: ignore[return-value]
-            "PUT",
-            __path,
-            params=__query,
-            headers=__headers,
-            body=__body,
-            endpoint_id="query_ruleset.put",
-            path_parts=__path_parts,
-        )

elasticsearch/_sync/client/query_ruleset.py

@@ -1,205 +0,0 @@
-#  Licensed to Elasticsearch B.V. under one or more contributor
-#  license agreements. See the NOTICE file distributed with
-#  this work for additional information regarding copyright
-#  ownership. Elasticsearch B.V. licenses this file to you under
-#  the Apache License, Version 2.0 (the "License"); you may
-#  not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-# 	http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing,
-#  software distributed under the License is distributed on an
-#  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-#  KIND, either express or implied.  See the License for the
-#  specific language governing permissions and limitations
-#  under the License.
-
-import typing as t
-
-from elastic_transport import ObjectApiResponse
-
-from ._base import NamespacedClient
-from .utils import SKIP_IN_PATH, _quote, _rewrite_parameters
-
-
-class QueryRulesetClient(NamespacedClient):
-
-    @_rewrite_parameters()
-    def delete(
-        self,
-        *,
-        ruleset_id: str,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Deletes a query ruleset.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/delete-query-ruleset.html>`_
-
-        :param ruleset_id: The unique identifier of the query ruleset to delete
-        """
-        if ruleset_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'ruleset_id'")
-        __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
-        __path = f'/_query_rules/{__path_parts["ruleset_id"]}'
-        __query: t.Dict[str, t.Any] = {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        __headers = {"accept": "application/json"}
-        return self.perform_request(  # type: ignore[return-value]
-            "DELETE",
-            __path,
-            params=__query,
-            headers=__headers,
-            endpoint_id="query_ruleset.delete",
-            path_parts=__path_parts,
-        )
-
-    @_rewrite_parameters()
-    def get(
-        self,
-        *,
-        ruleset_id: str,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Returns the details about a query ruleset.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/get-query-ruleset.html>`_
-
-        :param ruleset_id: The unique identifier of the query ruleset
-        """
-        if ruleset_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'ruleset_id'")
-        __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
-        __path = f'/_query_rules/{__path_parts["ruleset_id"]}'
-        __query: t.Dict[str, t.Any] = {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        __headers = {"accept": "application/json"}
-        return self.perform_request(  # type: ignore[return-value]
-            "GET",
-            __path,
-            params=__query,
-            headers=__headers,
-            endpoint_id="query_ruleset.get",
-            path_parts=__path_parts,
-        )
-
-    @_rewrite_parameters(
-        parameter_aliases={"from": "from_"},
-    )
-    def list(
-        self,
-        *,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        from_: t.Optional[int] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-        size: t.Optional[int] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Lists query rulesets.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/list-query-rulesets.html>`_
-
-        :param from_: Starting offset (default: 0)
-        :param size: specifies a max number of results to get
-        """
-        __path_parts: t.Dict[str, str] = {}
-        __path = "/_query_rules"
-        __query: t.Dict[str, t.Any] = {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if from_ is not None:
-            __query["from"] = from_
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        if size is not None:
-            __query["size"] = size
-        __headers = {"accept": "application/json"}
-        return self.perform_request(  # type: ignore[return-value]
-            "GET",
-            __path,
-            params=__query,
-            headers=__headers,
-            endpoint_id="query_ruleset.list",
-            path_parts=__path_parts,
-        )
-
-    @_rewrite_parameters(
-        body_fields=("rules",),
-    )
-    def put(
-        self,
-        *,
-        ruleset_id: str,
-        rules: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
-        error_trace: t.Optional[bool] = None,
-        filter_path: t.Optional[t.Union[str, t.Sequence[str]]] = None,
-        human: t.Optional[bool] = None,
-        pretty: t.Optional[bool] = None,
-        body: t.Optional[t.Dict[str, t.Any]] = None,
-    ) -> ObjectApiResponse[t.Any]:
-        """
-        Creates or updates a query ruleset.
-
-        `<https://www.elastic.co/guide/en/elasticsearch/reference/8.14/put-query-ruleset.html>`_
-
-        :param ruleset_id: The unique identifier of the query ruleset to be created or
-            updated
-        :param rules:
-        """
-        if ruleset_id in SKIP_IN_PATH:
-            raise ValueError("Empty value passed for parameter 'ruleset_id'")
-        if rules is None and body is None:
-            raise ValueError("Empty value passed for parameter 'rules'")
-        __path_parts: t.Dict[str, str] = {"ruleset_id": _quote(ruleset_id)}
-        __path = f'/_query_rules/{__path_parts["ruleset_id"]}'
-        __query: t.Dict[str, t.Any] = {}
-        __body: t.Dict[str, t.Any] = body if body is not None else {}
-        if error_trace is not None:
-            __query["error_trace"] = error_trace
-        if filter_path is not None:
-            __query["filter_path"] = filter_path
-        if human is not None:
-            __query["human"] = human
-        if pretty is not None:
-            __query["pretty"] = pretty
-        if not __body:
-            if rules is not None:
-                __body["rules"] = rules
-        __headers = {"accept": "application/json", "content-type": "application/json"}
-        return self.perform_request(  # type: ignore[return-value]
-            "PUT",
-            __path,
-            params=__query,
-            headers=__headers,
-            body=__body,
-            endpoint_id="query_ruleset.put",
-            path_parts=__path_parts,
-        )

elasticsearch-8.14.0.dist-info/METADATA

@@ -1,161 +0,0 @@
-Metadata-Version: 2.1
-Name: elasticsearch
-Version: 8.14.0
-Summary: Python client for Elasticsearch
-Home-page: https://github.com/elastic/elasticsearch-py
-Author: Elastic Client Library Maintainers
-Author-email: client-libs@elastic.co
-License: Apache-2.0
-Project-URL: Documentation, https://elasticsearch-py.readthedocs.io
-Project-URL: Source Code, https://github.com/elastic/elasticsearch-py
-Project-URL: Issue Tracker, https://github.com/elastic/elasticsearch-py/issues
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.7
-Description-Content-Type: text/x-rst
-License-File: LICENSE
-License-File: NOTICE
-Requires-Dist: elastic-transport <9,>=8.13
-Provides-Extra: async
-Requires-Dist: aiohttp <4,>=3 ; extra == 'async'
-Provides-Extra: orjson
-Requires-Dist: orjson >=3 ; extra == 'orjson'
-Provides-Extra: requests
-Requires-Dist: requests !=2.32.2,<3.0.0,>=2.4.0 ; extra == 'requests'
-Provides-Extra: vectorstore_mmr
-Requires-Dist: numpy >=1 ; extra == 'vectorstore_mmr'
-Requires-Dist: simsimd >=3 ; extra == 'vectorstore_mmr'
-
-
-Elasticsearch Python Client
-===========================
-
-.. image:: https://img.shields.io/pypi/v/elasticsearch
-   :target: https://pypi.org/project/elasticsearch
-
-.. image:: https://img.shields.io/conda/vn/conda-forge/elasticsearch?color=blue
-   :target: https://anaconda.org/conda-forge/elasticsearch
-
-.. image:: https://static.pepy.tech/badge/elasticsearch
-   :target: https://pepy.tech/project/elasticsearch?versions=*
-
-.. image:: https://badge.buildkite.com/68e22afcb2ea8f6dcc20834e3a5b5ab4431beee33d3bd751f3.svg
-   :target: https://buildkite.com/elastic/elasticsearch-py-integration-tests
-
-.. image:: https://readthedocs.org/projects/elasticsearch-py/badge/?version=latest&style=flat
-   :target: https://elasticsearch-py.readthedocs.io
-
-*The official Python client for Elasticsearch.*
-
-
-Features
---------
-
-* Translating basic Python data types to and from JSON
-* Configurable automatic discovery of cluster nodes
-* Persistent connections
-* Load balancing (with pluggable selection strategy) across available nodes
-* Failed connection penalization (time based - failed connections won't be
-  retried until a timeout is reached)
-* Support for TLS and HTTP authentication
-* Thread safety across requests
-* Pluggable architecture
-* Helper functions for idiomatically using APIs together
-
-
-Installation
-------------
-
-`Download the latest version of Elasticsearch <https://www.elastic.co/downloads/elasticsearch>`_
-or
-`sign-up <https://cloud.elastic.co/registration?elektra=en-ess-sign-up-page>`_
-for a free trial of Elastic Cloud.
-
-Refer to the `Installation section <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_installation>`_ 
-of the getting started documentation.
-
-
-Connecting
-----------
-
-Refer to the `Connecting section <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_connecting>`_ 
-of the getting started documentation.
-
-
-Usage
------
-
-* `Creating an index <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_creating_an_index>`_ 
-* `Indexing a document <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_indexing_documents>`_
-* `Getting documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_getting_documents>`_
-* `Searching documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_searching_documents>`_
-* `Updating documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_updating_documents>`_ 
-* `Deleting documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_deleting_documents>`_
-* `Deleting an index <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_deleting_an_index>`_
-
-
-Compatibility
--------------
-
-Language clients are forward compatible; meaning that the clients support
-communicating with greater or equal minor versions of Elasticsearch without
-breaking. It does not mean that the clients automatically support new features
-of newer Elasticsearch versions; it is only possible after a release of a new
-client version. For example, a 8.12 client version won't automatically support
-the new features of the 8.13 version of Elasticsearch, the 8.13 client version
-is required for that. Elasticsearch language clients are only backwards
-compatible with default distributions and without guarantees made.
-
-+-----------------------+-------------------------+-----------+
-| Elasticsearch version | elasticsearch-py branch | Supported |
-+=======================+=========================+===========+
-| main                  | main                    |           |
-+-----------------------+-------------------------+-----------+
-| 8.x                   | 8.x                     | 8.x       |
-+-----------------------+-------------------------+-----------+
-| 7.x                   | 7.x                     | 7.17      |
-+-----------------------+-------------------------+-----------+
-
-If you have a need to have multiple versions installed at the same time older
-versions are also released as ``elasticsearch7`` and ``elasticsearch8``.
-
-
-Documentation
--------------
-
-Documentation for the client is `available on elastic.co`_ and `Read the Docs`_.
-
-.. _available on elastic.co: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html
-.. _Read the Docs: https://elasticsearch-py.readthedocs.io
-
-
-Feedback 🗣️
------------
-
-The engineering team here at Elastic is looking for developers to participate in
-research and feedback sessions to learn more about how you use our Python client and
-what improvements we can make to their design and your workflow. If you're interested in
-sharing your insights into developer experience and language client design, please fill
-out this `short form`_. Depending on the number of responses we get, we may either
-contact you for a 1:1 conversation or a focus group with other developers who use the
-same client. Thank you in advance - your feedback is crucial to improving the user
-experience for all Elasticsearch developers!
-
-.. _short form: https://forms.gle/bYZwDQXijfhfwshn9
-
-License
--------
-
-Copyright 2023 Elasticsearch B.V. Licensed under the Apache License, Version 2.0.