Search API
Search API
1.0에서 도입
OpenSearch는 다양한 검색 작업을 수행하고, 검색을 테스트·검증하고, 검색 템플릿을 다룰 수 있는 포괄적인 검색 관련 API 모음을 제공해요. OpenSearch는 다음 Search API를 지원해요.
이 페이지에 나열된 엔드포인트 경로(예: GET /{index}/_search)는 OpenSearch 호스트와 포트를 기준으로 한 상대 경로예요. 전체 URL 형식은 https://<host>:<port>/{index}/_search이고 기본 포트는 9200이에요. OpenSearch에 연결하는 방법은 Communicating with OpenSearch 문서를 참고해요.
출처: 문서
본문
핵심 검색 API (Core search APIs)
이 API들은 OpenSearch 검색 기능의 기반이 돼요:
- Search: 하나 이상의 인덱스에서 검색 쿼리를 실행해요.
- Multi-search: 단일 API 호출에서 여러 검색 요청을 실행해요.
- Point in Time: 검색 작업을 위해 인덱스의 일관된 뷰를 만들어요.
- Scroll: 검색 쿼리에서 많은 수의 결과를 조회해요.
- Count: 쿼리와 일치하는 문서 수를 가져와요.
검색 테스트 API (Search testing APIs)
이 API들은 검색 작업을 테스트·디버그·최적화하는 데 도움을 줘요:
- Explain: 특정 문서가 쿼리와 일치(또는 불일치)하는 이유를 설명해요.
- Field capabilities: 여러 인덱스에서 필드의 기능을 가져와요.
- Profile: 검색 요청의 실행을 프로파일링해요.
- Ranking evaluation: 검색 결과의 품질을 평가해요.
- Search shards: 검색 요청이 실행될 샤드에 대한 정보를 가져와요.
- Validate: 비용이 클 수 있는 쿼리를 실행 전에 검증해요.
검색 템플릿 API (Search template APIs)
이 API들은 검색 템플릿을 다루게 해줘요:
- Search template: 검색 템플릿으로 매개변수화된 검색 쿼리를 실행해요.
- Multi-search template: 단일 API 호출에서 여러 검색 템플릿 요청을 실행해요.
- Render template: 검색을 실행하지 않고 매개변수를 치환해 검색 템플릿에서 생성된 최종 쿼리를 미리 봐요.