Index Mapping tool

원문 보기 위키 갱신 2026.10.14

출처: 문서

본문

인덱스 매핑 도구

Introduced 2.13 {: .label .label-purple }

IndexMappingTool는 클러스터의 인덱스에 대한 매핑 및 설정 정보를 검색해요.

1단계: IndexMappingTool를 실행할 플로우 에이전트 등록하기

플로우 에이전트는 도구들을 순서대로 실행하고 마지막 도구의 출력을 반환해요. 플로우 에이전트를 생성하려면 다음 등록 에이전트 요청을 보내세요.

POST /_plugins/_ml/agents/_register
{
  "name": "Test_Agent_For_IndexMapping_tool",
  "type": "flow",
  "description": "this is a test agent for the IndexMappingTool",
  "tools": [
      {
      "type": "IndexMappingTool",
      "name": "DemoIndexMappingTool",
      "parameters": {
        "index": "${parameters.index}",
        "input": "${parameters.question}"
      }
    }
  ]
}

{% include copy-curl.html %}

매개변수 설명은 등록 매개변수를 참조하세요.

OpenSearch는 에이전트 ID로 응답해요:

{
  "agent_id": "9X7xWI0Bpc3sThaJdY9i"
}

2단계: 에이전트 실행하기

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

그런 다음, 다음 요청을 보내고 인덱스 이름과 질문을 제공하여 에이전트를 실행하세요:

POST /_plugins/_ml/agents/9X7xWI0Bpc3sThaJdY9i/_execute
{
  "parameters": {
    "index": [ "sample-ecommerce" ],
    "question": "What fields are in the sample-ecommerce index?"
  }
}

{% include copy-curl.html %}

OpenSearch는 지정된 인덱스에 대한 매핑과 설정을 반환해요:

{
  "inference_results": [
    {
      "output": [
        {
          "name": "response",
          "result": """index: sample-ecommerce

mappings:
properties={items_purchased_failure={type=integer}, items_purchased_success={type=integer}, order_id={type=integer}, timestamp={type=date}, total_revenue_usd={type=integer}}


settings:
index.creation_date=1706752839713
index.number_of_replicas=1
index.number_of_shards=1
index.provided_name=sample-ecommerce
index.replication.type=DOCUMENT
index.uuid=UPYOQcAfRGqFAlSxcZlRjw
index.version.created=137217827


"""
        }
      ]
    }
  ]
}

등록 매개변수

다음 표는 에이전트를 등록할 때 사용할 수 있는 모든 도구 매개변수를 보여줘요.

매개변수	타입	필수/선택	설명
`input`	String	필수	인덱스 정보를 반환하는 데 사용되는 사용자 입력이에요.
`index`	Array	필수	매핑 및 설정 정보를 가져올 하나 이상의 인덱스를 쉼표로 구분한 목록이에요. 기본값은 빈 목록이며, 이는 모든 인덱스를 의미해요.
`local`	Boolean	선택	클러스터 관리자 노드 대신 로컬 노드에서만 정보를 반환할지 여부예요 (기본값은 `false`).

실행 매개변수

다음 표는 에이전트를 실행할 때 사용할 수 있는 모든 도구 매개변수를 보여줘요.

매개변수	타입	필수/선택	설명
`question`	String	필수	LLM에 보낼 자연어 질문이에요.
`index`	Array	선택	매핑 및 설정 정보를 가져올 하나 이상의 인덱스를 쉼표로 구분한 목록이에요. 기본값은 빈 목록이며, 이는 모든 인덱스를 의미해요.

도구 테스트하기

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

더 알아보기 (Learn more)

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