Link Search Menu Expand Document Documentation Menu
文档

可视化工具

2.13 版本引入

使用 VisualizationTool 查找与问题相关的可视化。

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

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

POST /_plugins/_ml/agents/_register
{
  "name": "Test_Agent_For_Visualization_tool",
  "type": "flow",
  "description": "this is a test agent for the VisuailizationTool",
  "tools": [
      {
      "type": "VisualizationTool",
      "name": "DemoVisualizationTool",
      "parameters": {
        "index": ".kibana",
        "input": "${parameters.question}",
        "size": 3
      }
    }
  ]
}

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

OpenSearch 返回一个代理 ID

{
  "agent_id": "9X7xWI0Bpc3sThaJdY9i"
}

步骤 2：运行代理

在运行代理之前，请确保添加 OpenSearch Dashboards 示例数据集 Sample eCommerce orders。要了解更多信息，请参阅添加示例数据。

然后，通过发送以下请求运行代理

POST /_plugins/_ml/agents/9X7xWI0Bpc3sThaJdY9i/_execute
{
  "parameters": {
    "question": "what's the revenue for today?"
  }
}

默认情况下，OpenSearch 返回前三个匹配的可视化。您可以使用 size 参数指定返回结果的数量。输出以 CSV 格式返回。输出包含两列：Title（在 OpenSearch Dashboards 中显示的可视化标题）和 Id（此可视化的唯一 ID）

{
  "inference_results": [
    {
      "output": [
        {
          "name": "response",
          "result": """Title,Id
[eCommerce] Total Revenue,10f1a240-b891-11e8-a6d9-e546fe2bba5f
"""
        }
      ]
    }
  ]
}

注册参数

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

参数 类型 必需/可选 描述
输入 字符串 必需 用于匹配可视化的用户输入。
索引 字符串 可选 要搜索的索引。默认为 .kibana（OpenSearch Dashboards 数据的系统索引）。
大小 整数 可选 要返回的可视化数量。默认为 3。

执行参数

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

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

有问题？。

想贡献？ 或 。