Link Search Menu Expand Document Documentation Menu
文档

搜索异常检测器工具

2.13 版本引入

该 SearchAnomalyDetectorsTool 工具用于检索集群上设置的异常检测器的信息。有关异常检测器的更多信息，请参阅异常检测。

步骤 1：注册一个将运行 SearchAnomalyDetectorsTool 的流代理

流代理按顺序运行一系列工具，并返回最后一个工具的输出。要创建流代理，请发送以下注册代理请求：

POST /_plugins/_ml/agents/_register
{
  "name": "Test_Agent_For_Search_Anomaly_Detectors_Tool",
  "type": "flow",
  "description": "this is a test agent for the SearchAnomalyDetectorsTool",
  "memory": {
    "type": "demo"
  },
  "tools": [
      {
      "type": "SearchAnomalyDetectorsTool",
      "name": "DemoSearchAnomalyDetectorsTool",
      "parameters": {}
    }
  ]
}

有关参数描述，请参阅注册参数。

OpenSearch 返回一个代理 ID

{
  "agent_id": "EuJYYo0B9RaBCvhuy1q8"
}

步骤 2：运行代理

通过发送以下请求来运行代理

POST /_plugins/_ml/agents/EuJYYo0B9RaBCvhuy1q8/_execute
{
  "parameters": {
    "question": "Do I have any anomaly detectors?"
  }
}

OpenSearch 返回集群上设置的异常检测器列表以及异常检测器的总数

{
  "inference_results": [
    {
      "output": [
        {
          "name": "response",
          "result": "AnomalyDetectors=[{id=y2M-Yo0B-yCFzT-N_XXU,name=sample-http-responses-detector,type=SINGLE_ENTITY,description=A sample detector to detect anomalies with HTTP response code logs.,index=[sample-http-responses],lastUpdateTime=1706750311891}]TotalAnomalyDetectors=1"
        }
      ]
    }
  ]
}

注册参数

下表列出了注册代理时可用的所有工具参数。所有参数都是可选的。

参数 类型 描述
detectorName 字符串 要搜索的检测器名称。
detectorNamePattern 字符串 用于匹配要搜索的检测器名称的通配符查询。
索引 字符串 返回的检测器用作数据源的索引名称或索引模式。
highCardinality 布尔型 是否返回高基数检测器的信息。将此参数留空（或将其设置为 null）以返回高基数（多实体）和非高基数（单实体）检测器的信息。将此参数设置为 true 以仅返回高基数检测器的信息。将此参数设置为 false 以仅返回非高基数检测器的信息。
lastUpdateTime 长整型 指定要返回的检测器最早的上次更新时间，以 epoch 毫秒为单位。默认值为 null。
sortOrder 字符串 结果的排序顺序。有效值为 asc（升序）和 desc（降序）。默认值为 desc。
sortString 字符串 指定用于对结果进行排序的检测器字段。默认值为 name.keyword。
size 整数 要返回的结果数量。默认值为 20。
startIndex 整数 要开始的检测器的分页索引。默认值为 0。
running 布尔型 是否返回当前正在运行的检测器的信息。将此参数留空（或将其设置为 null）以返回正在运行和未运行的检测器信息。将此参数设置为 true 以仅返回正在运行的检测器的信息。将此参数设置为 false 以仅返回当前未运行的检测器的信息。默认值为 null。
disabled 布尔型 是否返回当前已禁用检测器的信息。将此参数留空（或将其设置为 null）以返回已启用和已禁用检测器的信息。将此参数设置为 true 以仅返回已禁用检测器的信息。将此参数设置为 false 以仅返回已启用检测器的信息。默认值为 null。
failed 布尔型 是否返回当前失败的检测器的信息。将此参数留空（或将其设置为 null）以返回失败和未失败检测器的信息。将此参数设置为 true 以仅返回失败检测器的信息。将此参数设置为 false 以仅返回未失败检测器的信息。默认值为 null。

执行参数

下表列出了运行代理时可用的所有工具参数。

参数 类型 必需/可选 描述
问题 字符串 必需 要发送到 LLM 的自然语言问题。
剩余 350 字符

有问题？。

想要贡献？ 或 。