Search Relevance Stats API

Introduced 2.7

The Search Relevance Stats API provides information about Search Relevance plugin operations. The Search Relevance plugin processes operations sent by the Compare Search Results Dashboards tool.

The Search Relevance Stats API captures statistics for a one-minute interval during which it receives a request. For example, if a request is received at 23:59:59.004, statistics are collected for the 23:58:00.000–23:58:59.999 time interval.

To change the default time interval for which statistics are collected, update the searchRelevanceDashboards.metrics.metricInterval setting in the opensearch_dashboards.yml file with the new time interval in milliseconds. The opensearch_dashboards.yml file is located in the config folder of your OpenSearch Dashboards installation. For example, the following sets the interval to one second:

searchRelevanceDashboards.metrics.metricInterval: 1000 

Example request

You can access the Search Relevance Stats API by providing its URL address in the following format:

<opensearch-dashboards-endpoint-address>/api/relevancy/stats

The OpenSearch Dashboards endpoint address may contain a port number if it is specified in the OpenSearch configuration file. The specific URL format depends on the type of OpenSearch deployment and the network environment in which it is hosted.

You can query the endpoint in two ways:

• By accessing the endpoint address (for example, http://localhost:5601/api/relevancy/stats) in a browser

• By using the curl command in the terminal:

  curl -X GET http://localhost:5601/api/relevancy/stats
  

Example response

The following is the response for the preceding request:

{
  "data": {
    "search_relevance": {
      "fetch_index": {
        "200": {
          "response_time_total": 28.79286289215088,
          "count": 1
        }
      },
      "single_search": {
        "200": {
          "response_time_total": 29.817723274230957,
          "count": 1
        }
      },
      "comparison_search": {
        "200": {
          "response_time_total": 13.265346050262451,
          "count": 2
        }
      }
    }
  },
  "overall": {
    "response_time_avg": 17.968983054161072,
    "requests_per_second": 0.06666666666666667
  },
  "counts_by_component": {
    "search_relevance": 4
  },
  "counts_by_status_code": {
    "200": 4
  }
}

Response fields

The following table lists all response fields.

The data.search_relevance object

The data.search_relevance object contains the fields described in the following table.

Each of the comparison_search, single_search, and fetch_index objects contains a list of HTTP response codes. The following table lists the fields for each response code.