멀티 검색 템플릿 API

멀티 검색 템플릿 API (Multi-search Template API)

Multi-search Template API는 단일 API 요청에서 여러 검색 템플릿 요청을 실행해요.

도입 버전 1.0

엔드포인트

Multi-search Template API는 다음 경로를 사용해요:

GET /_msearch/template
POST /_msearch/template
GET /{index}/_msearch/template
POST /{index}/_msearch/template

쿼리 파라미터와 메타데이터 옵션

모든 파라미터는 선택 사항이에요. 일부는 각 검색의 메타데이터 줄의 일부로 개별 검색에 적용할 수도 있어요.

메타데이터 전용 옵션

일부 옵션은 전체 요청의 파라미터로 적용할 수 없어요. 대신 각 검색의 메타데이터 줄의 일부로 적용할 수 있어요. 모두 선택 사항이에요.

요청 본문

멀티 검색 템플릿 요청 본문은 Multi-search API 패턴과 유사한 다음 형식을 따릅니다:

Metadata

Query

Metadata

Query

• 메타데이터 줄은 검색할 인덱스, 검색 유형 같은 옵션을 포함해요.
• 쿼리 줄은 query DSL을 사용해요.

bulk 작업과 마찬가지로 JSON을 최소화할 필요는 없어요. 공백은 괜찮지만 한 줄에 있어야 해요. OpenSearch는 새 줄 문자를 사용해 멀티 검색 요청을 파싱하며, 요청 본문이 새 줄 문자로 끝나야 해요.

예제 요청

다음 msearch/template API 요청 예제는 line_search_template과 play_search_template이라는 여러 템플릿을 사용해 단일 인덱스에 대해 쿼리를 실행해요:

GET /_msearch/template
{"index":"shakespeare"}
{"id":"line_search_template","params":{"text_entry":"All the world's a stage","limit":false,"size":2}}
{"index":"shakespeare"}
{"id":"play_search_template","params":{"play_name":"Henry IV"}}

예제 응답

OpenSearch는 멀티 검색 템플릿 요청의 순서와 같은 순서로 각 검색 결과를 담은 배열을 반환해요:

{
  "took": 5,
  "responses": [
    {
      "took": 5,
      "timed_out": false,
      "_shards": {
        "total": 1,
        "successful": 1,
        "skipped": 0,
        "failed": 0
      },
      "hits": {
        "total": {
          "value": 0,
          "relation": "eq"
        },
        "max_score": null,
        "hits": []
      },
      "status": 200
    },
    {
      "took": 3,
      "timed_out": false,
      "_shards": {
        "total": 1,
        "successful": 1,
        "skipped": 0,
        "failed": 0
      },
      "hits": {
        "total": {
          "value": 0,
          "relation": "eq"
        },
        "max_score": null,
        "hits": []
      },
      "status": 200
    }
  ]
}

출처: 문서