搜索相关性统计 API

2.7 版引入

搜索相关性统计 API 提供有关 搜索相关性插件 操作的信息。搜索相关性插件处理由 比较搜索结果 Dashboards 工具发送的操作。

搜索相关性统计 API 捕获其接收请求的一分钟间隔内的统计信息。例如，如果请求在 23:59:59.004 收到，则会收集 23:58:00.000–23:58:59.999 时间间隔的统计信息。

要更改收集统计信息的默认时间间隔，请在 opensearch_dashboards.yml 文件中将 searchRelevanceDashboards.metrics.metricInterval 设置更新为新的毫秒时间间隔。opensearch_dashboards.yml 文件位于 OpenSearch Dashboards 安装的 config 文件夹中。例如，以下设置将间隔设为一秒

searchRelevanceDashboards.metrics.metricInterval: 1000 

请求示例

您可以通过以下格式提供其 URL 地址来访问搜索相关性统计 API

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

OpenSearch Dashboards 端点地址可能包含端口号（如果在 OpenSearch 配置文件中指定）。具体的 URL 格式取决于 OpenSearch 部署类型及其托管的网络环境。

您可以通过两种方式查询端点

• 通过在浏览器中访问端点地址（例如，https://:5601/api/relevancy/stats）

• 通过在终端中使用 curl 命令

  curl -X GET https://:5601/api/relevancy/stats
  

示例响应

以下是上述请求的响应

{
  "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
  }
}

响应正文字段

下表列出了所有响应字段。

data.search_relevance 对象

data.search_relevance 对象包含下表描述的字段。

comparison_search、single_search 和 fetch_index 对象都包含 HTTP 响应代码列表。下表列出了每个响应代码的字段。