Source: api/api/rank_eval.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.   'ignore_unavailable',
  38.   'allow_no_indices',
  39.   'expand_wildcards',
  40.   'search_type',
  41.   'pretty',
  42.   'human',
  43.   'error_trace',
  44.   'source',
  45.   'filter_path',
  46. ];
  47. const snakeCase = {
  48.   ignoreUnavailable: 'ignore_unavailable',
  49.   allowNoIndices: 'allow_no_indices',
  50.   expandWildcards: 'expand_wildcards',
  51.   searchType: 'search_type',
  52.   errorTrace: 'error_trace',
  53.   filterPath: 'filter_path',
  54. };
  56. /**
  57.  * Allows to evaluate the quality of ranked search results over a set of typical search queries
  58.  * <br/> See Also: {@link https://opensearch.org/docs/latest/api-reference/rank-eval/ OpenSearch - Ranking evaluation}
  59.  *
  60.  * @memberOf API-Search
  61.  *
  62.  * @param {Object} params
  63.  * @param {string} [params.index] - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
  64.  * @param {Object} params.body - The ranking evaluation search definition, including search requests, document ratings and ranking metric definition
  65.  * @param {boolean} [params.ignore_unavailable] - Whether specified concrete indices should be ignored when unavailable (missing or closed)
  66.  * @param {boolean} [params.allow_no_indices] - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
  67.  * @param {string} [params.expand_wildcards] - Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
  68.  * @param {string} [params.search_type] - Search operation type (options: query_then_fetch, dfs_query_then_fetch)
  69.  *
  70.  * @param {Object} [options] - Options for {@link Transport#request}
  71.  * @param {function} [callback] - Callback that handles errors and response
  72.  *
  73.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*} {@link https://opensearch.org/docs/latest/api-reference/rank-eval/#sample-response Ranking Evaluation Response}
  74.  */
  75. function rankEvalApi(params, options, callback) {
  76.   [params, options, callback] = normalizeArguments(params, options, callback);
  78.   // check required parameters
  79.   if (params.body == null) {
  80.     const err = new this[kConfigurationError]('Missing required parameter: body');
  81.     return handleError(err, callback);
  82.   }
  84.   let { method, body, index, ...querystring } = params;
  85.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  87.   let path = '';
  88.   if (index != null) {
  89.     if (method == null) method = body == null ? 'GET' : 'POST';
  90.     path = '/' + encodeURIComponent(index) + '/' + '_rank_eval';
  91.   } else {
  92.     if (method == null) method = body == null ? 'GET' : 'POST';
  93.     path = '/' + '_rank_eval';
  94.   }
  96.   // build request object
  97.   const request = {
  98.     method,
  99.     path,
  100.     body: body || '',
  101.     querystring,
  102.   };
  104.   return this.transport.request(request, options, callback);
  105. }
  107. module.exports = rankEvalApi;