Visualization tool

원문 보기 위키 갱신 2026.10.14

출처: 문서

본문

시각화 도구

2.13에 도입 {: .label .label-purple }

질문과 관련된 시각화를 찾으려면 VisualizationTool을 사용하세요.

1단계: VisualizationTool을 실행할 flow agent 등록하기

flow agent는 도구들을 순서대로 실행한 뒤 마지막 도구의 출력을 반환해요. flow agent를 만들려면 다음 agent 등록 요청을 보내세요:

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
      }
    }
  ]
}

{% include copy-curl.html %}

파라미터 설명은 등록 파라미터를 참조하세요.

OpenSearch는 agent ID를 응답으로 반환해요:

{
  "agent_id": "9X7xWI0Bpc3sThaJdY9i"
}

2단계: agent 실행하기

agent를 실행하기 전에 OpenSearch Dashboards의 Sample eCommerce orders 샘플 데이터셋을 추가했는지 확인하세요. 자세한 내용은 샘플 데이터 추가하기를 참조하세요.

그런 다음 아래 요청을 보내 agent를 실행하세요:

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

{% include copy-curl.html %}

기본적으로 OpenSearch는 일치하는 시각화 중 상위 세 개를 반환해요. size 파라미터를 사용하면 반환되는 결과 개수를 지정할 수 있어요. 출력은 CSV 형식으로 반환되며, 출력에는 Title(OpenSearch Dashboards에 표시되는 시각화 제목)과 Id(이 시각화의 고유 ID) 두 개의 컬럼이 들어 있어요:

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

등록 파라미터

다음 표는 agent를 등록할 때 사용할 수 있는 모든 도구 파라미터를 나열한 거예요.

파라미터	타입	필수/선택	설명
`input`	String	필수	시각화를 매칭할 때 사용하는 사용자 입력이에요.
`index`	String	선택	검색할 인덱스예요. 기본값은 `.kibana`(OpenSearch Dashboards 데이터의 시스템 인덱스)예요.
`size`	Integer	선택	반환할 시각화 개수예요. 기본값은 `3`이에요.

실행 파라미터

다음 표는 agent를 실행할 때 사용할 수 있는 모든 도구 파라미터를 나열한 거예요.

파라미터	타입	필수/선택	설명
`question`	String	필수	LLM에 보낼 자연어 질문이에요.

도구 테스트하기

이 도구는 agent 워크플로의 일부로 실행할 수도 있고, Execute Tool API를 사용해서 독립적으로 실행할 수도 있어요. Execute Tool API는 개별 도구를 테스트하거나 독립적인 작업을 수행할 때 유용해요.

더 알아보기 (Learn more)

원문 전체: https://docs.opensearch.org/latest/ml-commons-plugin/agents-tools/tools/visualization-tool/