Search > Cloud Search > API v2.0 가이드

NHN Cloud Search에서 제공하는 Cloud Search API v2.0을 설명합니다.

공통

[요청]

URI 정보

환경 URI
REAL https://kr1-search.api.nhncloudservice.com

Path 파라미터 정보

이름 설명
appKey 콘솔에서 발급 받은 앱키
serviceId 사용자의 임의의 이름

전체 색인

전체 색인을 실행하면 기존에 색인했던 파일은 사라집니다.

반드시 시작-색인-끝의 순서로 진행해야 합니다.

1. 시작

[요청]

URI 정보

메서드 URI
POST /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/indexing/full/begin

[응답]

응답 본문

{}

2. 색인

[요청]

URI 정보

메서드 URI
POST /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/indexing/full

BODY 정보(예시)

[
    {
        "action": "add",
        "id": "id-1",
        "fields": {
            "title": "대박!! 1등이다!!"
        }
    }
]

[응답]

응답 본문(예시)

{
    "id": 1
}

3. 끝

[요청]

URI 정보

메서드 URI
POST /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/indexing/full/end

[응답]

응답 본문

{}

4. 취소

[요청]

URI 정보

메서드 URI
POST /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/indexing/full/cancel

[응답]

응답 본문

{}

추가 색인

색인은 기존 ID가 있을 경우 업데이트되며, ID가 없는 경우에 추가됩니다.

1. 추가 색인

[요청]

URI 정보

메서드 URI
POST /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/indexing

BODY 정보(예시)

[
    {
        "action": "add",
        "id": "id-2",
        "fields": {
            "title": "대박!! 2등이다!!"
        }
    }
]

[응답]

응답 본문(예시)

{
    "id": 2
}

색인 로그

색인 결과를 표시합니다.

1. 색인 로그 조회

[요청]

URI 정보

메서드 URI
GET /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/indexing_log?id=1

파라미터 정보

이름 설명
id 색인 ID

[응답]

응답 본문(예시)

{
    "total_doc_count" : 3,
    "request_time" : "2024-01-30T14:12:01",
    "file_name" : "payload-1.json",
    "total_index_file_size" : 355,
    "file_size" : 355,
    "status" : 4
}

검색

색인을 이용해 필드를 검색할 수 있습니다.

1. 검색

[요청]

URI 정보(예시)

메서드 URI
GET /indexing/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/search?q=&q_option=and,title*1.0&start=1&size=10&passage.title=180

파라미터 정보

이름 설명
start 시작 번호(필수)
size 크기(필수)
q_option and, or, boolean, 필드 * 가중치(필수)
return 결과 출력
q 쿼리
sort 정렬
passage.* 결과 길이
summary.* 요약
filter_and 필터 And
filter_or 필터 Or
highlight 하이라이트
doc_weight_ratio 가중치

[응답]

응답 본문(예시)

{
    "message": {
        "result": {
            "total": 2,
            "query": "",
            "start": 1,
            "itemList": {
                "item": [
                    {
                        "_ID": "id-1",
                        "_RANK": "0",
                        "_RELEVANCE": 100,
                        "title": "대박!! 1등이다!!"
                    },
                    {
                        "_ID": "id-2",
                        "_RANK": "0",
                        "_RELEVANCE": 100,
                        "title": "대박!! 2등이다!!"
                    }
                ]
            },
            "status": {
                "code": 200,
                "message": "OK"
            },
            "itemCount": 2
        },
        "meta": {
            "timezone": "+09:00"
        }
    }
}

통계

통계는 전체 쿼리와 결과 없는 쿼리의 수를 날짜(일)별로 표시합니다.

1. stat 조회

[요청]

URI 정보(예시)

메서드 URI
GET /stats/v2.0/appkeys/{{appKey}}/serviceids/{{serviceId}}/stats?kind=total_query_count&date=2024-01-29

파라미터 정보

이름 설명
kind total_query_count - 전체 쿼리 수
no_result_query_count - 결과 없는 쿼리 수
date 날짜

[응답]

응답 본문(예시)

[["", 13]]
목차
TOP