Source: api/api/termvectors.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.   'term_statistics',
  38.   'field_statistics',
  39.   'fields',
  40.   'offsets',
  41.   'positions',
  42.   'payloads',
  43.   'preference',
  44.   'routing',
  45.   'realtime',
  46.   'version',
  47.   'version_type',
  48.   'pretty',
  49.   'human',
  50.   'error_trace',
  51.   'source',
  52.   'filter_path',
  53. ];
  54. const snakeCase = {
  55.   termStatistics: 'term_statistics',
  56.   fieldStatistics: 'field_statistics',
  57.   versionType: 'version_type',
  58.   errorTrace: 'error_trace',
  59.   filterPath: 'filter_path',
  60. };
  62. /**
  63.  * Returns information and statistics about terms in the fields of a particular document.
  64.  *
  65.  * @memberOf API-Document
  66.  *
  67.  * @param {Object} params
  68.  * @param {string} params.index - The index in which the document resides.
  69.  * @param {string} [params.id] - The id of the document, when not specified a doc param should be supplied.
  70.  * @param {boolean} [params.term_statistics] - Specifies if total term frequency and document frequency should be returned.
  71.  * @param {boolean} [params.field_statistics] - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
  72.  * @param {string} [params.fields] - A comma-separated list of fields to return.
  73.  * @param {boolean} [params.offsets] - Specifies if term offsets should be returned.
  74.  * @param {boolean} [params.positions] - Specifies if term positions should be returned.
  75.  * @param {boolean} [params.payloads] - Specifies if term payloads should be returned.
  76.  * @param {string} [params.preference] - Specify the node or shard the operation should be performed on (default: random).
  77.  * @param {string} [params.routing] - Specific routing value.
  78.  * @param {boolean} [params.realtime] - Specifies if request is real-time as opposed to near-real-time (default: true).
  79.  * @param {number} [params.version] - Explicit version number for concurrency control
  80.  * @param {string} [params.version_type] - Specific version type (options: internal, external, external_gte, force)
  81.  * @param {Object} [params.body] - Define parameters and or supply a document to get termvectors for. See documentation.
  82.  *
  83.  * @param {Object} options - Options for {@link Transport#request}
  84.  * @param {function} callback - Callback that handles errors and response
  85.  *
  86.  * @returns {{abort: function(), then: function(), catch: function()}|Promise<never>|*}
  87.  */
  88. function termvectorsApi(params, options, callback) {
  89.   [params, options, callback] = normalizeArguments(params, options, callback);
  91.   // check required parameters
  92.   if (params.index == null) {
  93.     const err = new this[kConfigurationError]('Missing required parameter: index');
  94.     return handleError(err, callback);
  95.   }
  97.   let { method, body, index, id, type, ...querystring } = params;
  98.   querystring = snakeCaseKeys(acceptedQuerystring, snakeCase, querystring);
  100.   let path = '';
  101.   if (index != null && type != null && id != null) {
  102.     if (method == null) method = body == null ? 'GET' : 'POST';
  103.     path =
  104.       '/' +
  105.       encodeURIComponent(index) +
  106.       '/' +
  107.       encodeURIComponent(type) +
  108.       '/' +
  109.       encodeURIComponent(id) +
  110.       '/' +
  111.       '_termvectors';
  112.   } else if (index != null && id != null) {
  113.     if (method == null) method = body == null ? 'GET' : 'POST';
  114.     path = '/' + encodeURIComponent(index) + '/' + '_termvectors' + '/' + encodeURIComponent(id);
  115.   } else if (index != null && type != null) {
  116.     if (method == null) method = body == null ? 'GET' : 'POST';
  117.     path = '/' + encodeURIComponent(index) + '/' + encodeURIComponent(type) + '/' + '_termvectors';
  118.   } else {
  119.     if (method == null) method = body == null ? 'GET' : 'POST';
  120.     path = '/' + encodeURIComponent(index) + '/' + '_termvectors';
  121.   }
  123.   // build request object
  124.   const request = {
  125.     method,
  126.     path,
  127.     body: body || '',
  128.     querystring,
  129.   };
  131.   return this.transport.request(request, options, callback);
  132. }
  134. module.exports = termvectorsApi;