Source: api/api/explain.js

  1. /*
  2.  * Copyright OpenSearch Contributors
  3.  * SPDX-License-Identifier: Apache-2.0
  4.  *
  5.  * The OpenSearch Contributors require contributions made to
  6.  * this file be licensed under the Apache-2.0 license or a
  7.  * compatible open source license.
  8.  *
  9.  */
  11. /*
  12.  * Licensed to Elasticsearch B.V. under one or more contributor
  13.  * license agreements. See the NOTICE file distributed with
  14.  * this work for additional information regarding copyright
  15.  * ownership. Elasticsearch B.V. licenses this file to you under
  16.  * the Apache License, Version 2.0 (the "License"); you may
  17.  * not use this file except in compliance with the License.
  18.  * You may obtain a copy of the License at
  19.  *
  20.  *    http://www.apache.org/licenses/LICENSE-2.0
  21.  *
  22.  * Unless required by applicable law or agreed to in writing,
  23.  * software distributed under the License is distributed on an
  24.  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  25.  * KIND, either express or implied.  See the License for the
  26.  * specific language governing permissions and limitations
  27.  * under the License.
  28.  */
  30. 'use strict';
  32. /* eslint camelcase: 0 */
  33. /* eslint no-unused-vars: 0 */
  35. const { handleError, snakeCaseKeys, normalizeArguments, kConfigurationError } = require('../utils');
  36. const acceptedQuerystring = [
  37.   'analyze_wildcard',
  38.   'analyzer',
  39.   'default_operator',
  40.   'df',
  41.   'stored_fields',
  42.   'lenient',
  43.   'preference',
  44.   'q',
  45.   'routing',
  46.   '_source',
  47.   '_source_excludes',
  48.   '_source_exclude',
  49.   '_source_includes',
  50.   '_source_include',
  51.   'pretty',
  52.   'human',
  53.   'error_trace',
  54.   'source',
  55.   'filter_path',
  56. ];
  57. const snakeCase = {
  58.   analyzeWildcard: 'analyze_wildcard',
  59.   defaultOperator: 'default_operator',
  60.   storedFields: 'stored_fields',
  61.   _sourceExcludes: '_source_excludes',
  62.   _sourceExclude: '_source_exclude',
  63.   _sourceIncludes: '_source_includes',
  64.   _sourceInclude: '_source_include',
  65.   errorTrace: 'error_trace',
  66.   filterPath: 'filter_path',
  67. };
  69. /**
  70.  * Returns information about why a specific matches (or doesn't match) a query.
  71.  * <br/> See also: {@link https://opensearch.org/docs/latest/api-reference/explain/ OpenSearch - Explain}
  72.  * @memberOf API-Search
  73.  *
  74.  * @param {Object} params
  75.  * @param {string} [params.id] - The document ID
  76.  * @param {string} [params.index] - The name of the index
  77.  * @param {Object} [params.body] - The query definition using the Query DSL
  78.  * @param {string} [params.analyzer] - The analyzer to use for the query string
  79.  * @param {boolean} [params.analyze_wildcard=false] - Specify whether wildcard and prefix queries should be analyzed
  80.  * @param {string} [params.default_operator=OR] - The default operator for query string query (options: AND, OR)
  81.  * @param {string} [params.df] - The default field for query string query (default: _all)
  82.  * @param {string} [params.stored_fields] - A comma-separated list of stored fields to return in the response
  83.  * @param {boolean} [params.lenient] - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
  84.  * @param {string} [params.preference] - Specify the node or shard the operation should be performed on (default: random)
  85.  * @param {string} [params.q] - Query in the Lucene query string syntax
  86.  * @param {string} [params.routing] - Specific routing value
  87.  * @param {string} [params._source=true] - Whether to include the '_source' field in the response body.
  88.  * @param {string} [params._source_excludes] - A comma-separated list of source fields to exclude in the query response.
  89.  * @param {string} [params._source_includes] - A comma-separated list of source fields to include in the query response.
  90.  *
  91.  * @param {Object} [options] - Options for {@link Transport#request}
  92.  * @param {function} [callback] - Callback that handles errors and response
  93.  *
  94.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  95.  */
  96. function explainApi(params, options, callback) {
  97.   [params, options, callback] = normalizeArguments(params, options, callback);
  99.   // check required parameters
  100.   if (params.id == null) {
  101.     const err = new this[kConfigurationError]('Missing required parameter: id');
  102.     return handleError(err, callback);
  103.   }
  104.   if (params.index == null) {
  105.     const err = new this[kConfigurationError]('Missing required parameter: index');
  106.     return handleError(err, callback);
  107.   }
  109.   let { method, body, id, index, type, ...querystring } = params;
  110.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  112.   let path = '';
  113.   if (index != null && type != null && id != null) {
  114.     if (method == null) method = body == null ? 'GET' : 'POST';
  115.     path =
  116.       '/' +
  117.       encodeURIComponent(index) +
  118.       '/' +
  119.       encodeURIComponent(type) +
  120.       '/' +
  121.       encodeURIComponent(id) +
  122.       '/' +
  123.       '_explain';
  124.   } else {
  125.     if (method == null) method = body == null ? 'GET' : 'POST';
  126.     path = '/' + encodeURIComponent(index) + '/' + '_explain' + '/' + encodeURIComponent(id);
  127.   }
  129.   // build request object
  130.   const request = {
  131.     method,
  132.     path,
  133.     body: body || '',
  134.     querystring,
  135.   };
  137.   return this.transport.request(request, options, callback);
  138. }
  140. module.exports = explainApi;