elasticsearch9 9.0.0__py3-none-any.whl

elasticsearch9/_sync/client/graph.py

@@ -0,0 +1,113 @@
+#  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 GraphClient(NamespacedClient):
+
+    @_rewrite_parameters(
+        body_fields=("connections", "controls", "query", "vertices"),
+    )
+    def explore(
+        self,
+        *,
+        index: t.Union[str, t.Sequence[str]],
+        connections: t.Optional[t.Mapping[str, t.Any]] = None,
+        controls: t.Optional[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,
+        query: t.Optional[t.Mapping[str, t.Any]] = None,
+        routing: t.Optional[str] = None,
+        timeout: t.Optional[t.Union[str, t.Literal[-1], t.Literal[0]]] = None,
+        vertices: t.Optional[t.Sequence[t.Mapping[str, t.Any]]] = None,
+        body: t.Optional[t.Dict[str, t.Any]] = None,
+    ) -> ObjectApiResponse[t.Any]:
+        """
+        .. raw:: html
+
+          <p>Explore graph analytics.
+          Extract and summarize information about the documents and terms in an Elasticsearch data stream or index.
+          The easiest way to understand the behavior of this API is to use the Graph UI to explore connections.
+          An initial request to the <code>_explore</code> API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.
+          Subsequent requests enable you to spider out from one more vertices of interest.
+          You can exclude vertices that have already been returned.</p>
+
+
+        `<https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph>`_
+
+        :param index: Name of the index.
+        :param connections: Specifies or more fields from which you want to extract terms
+            that are associated with the specified vertices.
+        :param controls: Direct the Graph API how to build the graph.
+        :param query: A seed query that identifies the documents of interest. Can be
+            any valid Elasticsearch query.
+        :param routing: Custom value used to route operations to a specific shard.
+        :param timeout: Specifies the period of time to wait for a response from each
+            shard. If no response is received before the timeout expires, the request
+            fails and returns an error. Defaults to no timeout.
+        :param vertices: Specifies one or more fields that contain the terms you want
+            to include in the graph as vertices.
+        """
+        if index in SKIP_IN_PATH:
+            raise ValueError("Empty value passed for parameter 'index'")
+        __path_parts: t.Dict[str, str] = {"index": _quote(index)}
+        __path = f'/{__path_parts["index"]}/_graph/explore'
+        __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 routing is not None:
+            __query["routing"] = routing
+        if timeout is not None:
+            __query["timeout"] = timeout
+        if not __body:
+            if connections is not None:
+                __body["connections"] = connections
+            if controls is not None:
+                __body["controls"] = controls
+            if query is not None:
+                __body["query"] = query
+            if vertices is not None:
+                __body["vertices"] = vertices
+        if not __body:
+            __body = None  # type: ignore[assignment]
+        __headers = {"accept": "application/json"}
+        if __body is not None:
+            __headers["content-type"] = "application/json"
+        return self.perform_request(  # type: ignore[return-value]
+            "POST",
+            __path,
+            params=__query,
+            headers=__headers,
+            body=__body,
+            endpoint_id="graph.explore",
+            path_parts=__path_parts,
+        )