Seth Michael Larson
48 lines
2.0 KiB
Python
48 lines
2.0 KiB
Python
# 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.
|
|
|
|
from .utils import NamespacedClient, query_params, _make_path, SKIP_IN_PATH
|
|
|
|
|
|
class GraphClient(NamespacedClient):
|
|
@query_params("routing", "timeout")
|
|
def explore(self, index, body=None, doc_type=None, params=None, headers=None):
|
|
"""
|
|
Explore extracted and summarized information about the documents and terms in
|
|
an index.
|
|
|
|
`<https://www.elastic.co/guide/en/elasticsearch/reference/7.x/graph-explore-api.html>`_
|
|
|
|
:arg index: A comma-separated list of index names to search; use
|
|
`_all` or empty string to perform the operation on all indices
|
|
:arg body: Graph Query DSL
|
|
:arg doc_type: A comma-separated list of document types to
|
|
search; leave empty to perform the operation on all types
|
|
:arg routing: Specific routing value
|
|
:arg timeout: Explicit operation timeout
|
|
"""
|
|
if index in SKIP_IN_PATH:
|
|
raise ValueError("Empty value passed for a required argument 'index'.")
|
|
|
|
return self.transport.perform_request(
|
|
"POST",
|
|
_make_path(index, doc_type, "_graph", "explore"),
|
|
params=params,
|
|
headers=headers,
|
|
body=body,
|
|
)
|