리랭커

Prev Next

Classic/VPC 환경에서 이용 가능합니다 .

검색한 문서와 사용자 쿼리 간 연관도를 평가하여 관련성 높은 문서들을 선택하고, 그 결과를 요약 및 압축하여 RAG 답변을 생성합니다. 전체 검색 문서가 아닌 사용자 쿼리와 연관도가 높은 문서만 선별하여 사용하기 때문에 토큰 소비를 효율적으로 절감하면서도 신뢰도 높은 결괏값을 얻을 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /v1/api-tools/reranker

요청 헤더

요청 헤더에 대한 설명은 다음과 같습니다.

필드 필수 여부 설명
Authorization Required 인증을 위한 API 키 <예시> Bearer nv-************
X-NCP-CLOVASTUDIO-REQUEST-ID Optional 요청에 대한 아이디
Content-Type Required 요청 데이터의 형식
  • application/json
  • 요청 바디

    요청 바디에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    documents List[Object] Required 검색한 문서 목록
    query String Required 사용자 쿼리
    maxTokens Integer Optional 최대 생성 토큰 수
    • maxTokens < 4096 (기본값: 1024)

    검색한 문서

    검색한 문서에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    id String Required 검색한 문서 아이디
    doc String Required 검색한 문서 원본
    참고

    리랭커 API의 최대 입력 토큰 수는 128,000이며, 최대 출력 토큰 수는 4,096입니다.

    요청 예시

    요청 예시는 다음과 같습니다.

    curl --location --request POST 'https://clovastudio.stream.ntruss.com/v1/api-tools/reranker' \
    --header 'Authorization: Bearer {API Key}' \
    --header 'X-NCP-CLOVASTUDIO-REQUEST-ID: {Request ID}' \
    --header 'Content-Type: application/json' \
    --data '{
        "documents": [
            {
                "id": "id1",
                "doc": "VPC 삭제 오류 VPC가 삭제되지 않습니다.VPC 삭제 시 \"Endpoint가 전부 반납되지 않아 삭제가 불가능합니다. \"라는 메시지가 나타납니다.원인VPC 하위에 리소스가 존재할 경우, VPC를 삭제할 수 없습니다.해결 방법삭제하려 VPC와 관련된 모든 리소스를 반납하거나 삭제해야 합니다.** 삭제하려는 VPC와 관련된 Server, Network Interface, Cloud functions, Load Balancer, Auto Scaling, NAT Gateway 내 모든 리소스를 삭제해 주십시오.** 해당 VPC와 관련된 Route Table을 삭제해 주십시오.** 해당 VPC와 관련된 Subnet을 삭제해 주십시오.** 서버 eth0에 할당된 Network Interface는 반납 및 삭제할 수 없습니다. 서버 eth0에 할당된 Network Interface를 삭제하려면 해당 서버를 먼저 반납해 주십시오."
            },
            {
                "id": "id2",
                "doc": "VPC 삭제 생성하여 운영 중인 VPC를 삭제할 수 있습니다. 삭제하는 방법은 다음과 같습니다.참고VPC 안에 리소스가 남아 있으면 삭제되지 않습니다.VPC 삭제 시 해당 VPC와 연관된 서비스도 함께 삭제되며, 삭제 후에는 복구가 불가능합니다.** 네이버 클라우드 플랫폼 콘솔의 VPC 환경에서 Services > Networking > VPC 메뉴를 차례대로 클릭해 주십시오.** VPC Management 메뉴를 클릭해 주십시오.** 삭제할 VPC를 클릭한 후 [삭제] 버튼을 클릭해 주십시오.** VPC 삭제 팝업 창이 나타나면 [예] 버튼을 클릭해 주십시오.** VPC Management 화면의 VPC 목록에서 VPC 상태를 확인해 주십시오. 종료중 : VPC를 삭제하고 있는 상태*** 종료중 : VPC를 삭제하고 있는 상태"
            },
            {
                "id": "id3",
                "doc": "Subnet 삭제 생성하여 운영 중인 Subnet을 삭제할 수 있습니다. 삭제하는 방법은 다음과 같습니다.참고Subnet 안에 서버가 있으면 삭제되지 않습니다.한 번 삭제된 Subnet은 복구가 불가능합니다.** 네이버 클라우드 플랫폼 콘솔의 VPC 환경에서 Services > Networking > VPC 메뉴를 차례대로 클릭해 주십시오.** Subnet Management 메뉴를 클릭해 주십시오.** 삭제할 Subnet을 클릭한 후 [Subnet 삭제] 버튼을 클릭해 주십시오.** Subnet 삭제 팝업 창이 나타나면 [예] 버튼을 클릭해 주십시오.** Subnet Management 화면의 Subnet 목록에서 Subnet 상태를 확인해 주십시오. 종료중 : Subnet을 삭제하고 있는 상태*** 종료중 : Subnet을 삭제하고 있는 상태"
            }
        ],
        "query": "VPC 삭제 방법 알려줘"
      } ]
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 헤더

    응답 헤더에 대한 설명은 다음과 같습니다.

    헤더 필수 여부 설명
    Content-Type - 응답 데이터의 형식
    • application/json

    응답 바디

    응답 바디에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    status Object - 응답 상태
    result Object - 응답 결과
    result.result String - 모델 출력 답변
    result.citedDocuments Array[Object] - 검색한 문서 중 인용한 문서 목록
    result.suggestedQueries Array[String] - 재검색 시 추천 검색어 목록
    • 리랭커 모델이 검색한 문서 중 답변을 찾지 못한 경우에 표시
    result.usage Object - 토큰 사용량
    result.usage.completionTokens Integer - 생성 토큰 수
    result.usage.promptTokens Integer - 입력(프롬프트) 토큰 수
    result.usage.totalTokens Integer - 전체 토큰 수
  • 생성 토큰 수+입력 토큰 수
  • 인용한 문서

    인용한 문서에 대한 설명은 다음과 같습니다.

    필드 타입 필수 여부 설명
    id String - 인용한 문서 아이디
    doc String - 인용한 문서 원본

    응답 예시

    응답 예시는 다음과 같습니다.

    성공

    호출이 성공한 경우의 응답 예시는 다음과 같습니다.

    • 검색한 문서에서 답변을 찾은 경우
      {
          "status": {
              "code": "20000",
              "message": "OK"
          },
          "result": {
              "result": "답변: VPC를 삭제하려면 먼저 <doc1>VPC와 관련된 모든 리소스를 반납하거나 삭제</doc1>해야 합니다. 여기에는 <doc1>Server, Network Interface, Cloud functions, Load Balancer, Auto Scaling, NAT Gateway 내 모든 리소스</doc1>와 <doc1>Route Table, Subnet</doc1>이 포함됩니다. 특히, <doc1>서버 eth0에 할당된 Network Interface는 반납 및 삭제할 수 없으므로 해당 서버를 먼저 반납해야 합니다.</doc1>\n\n삭제 절차는 다음과 같습니다:\n1. <doc2>네이버 클라우드 플랫폼 콘솔의 VPC 환경에서 Services > Networking > VPC 메뉴를 클릭합니다.</doc2>\n2. <doc2>VPC Management 메뉴를 클릭한 후, 삭제할 VPC를 선택하고 [삭제] 버튼을 클릭합니다.</doc2>\n3. <doc2>VPC 삭제 팝업 창에서 [예] 버튼을 클릭하여 삭제를 진행합니다.</doc2>\n4. <doc2>VPC Management 화면에서 VPC 상태를 확인하여 삭제가 완료되었는지 확인합니다.</doc2>\n\n이 과정을 통해 VPC를 안전하게 삭제할 수 있습니다. 단, <doc2>VPC 삭제 후에는 복구가 불가능하므로 신중하게 진행해야 합니다.</doc2>",
              "citedDocuments": [
                  {
                      "id": "id1",
                      "doc": "VPC 삭제 오류 VPC가 삭제되지 않습니다.VPC 삭제 시 \"Endpoint가 전부 반납되지 않아 삭제가 불가능합니다. \"라는 메시지가 나타납니다.원인VPC 하위에 리소스가 존재할 경우, VPC를 삭제할 수 없습니다.해결 방법삭제하려 VPC와 관련된 모든 리소스를 반납하거나 삭제해야 합니다.** 삭제하려는 VPC와 관련된 Server, Network Interface, Cloud functions, Load Balancer, Auto Scaling, NAT Gateway 내 모든 리소스를 삭제해 주십시오.** 해당 VPC와 관련된 Route Table을 삭제해 주십시오.** 해당 VPC와 관련된 Subnet을 삭제해 주십시오.** 서버 eth0에 할당된 Network Interface는 반납 및 삭제할 수 없습니다. 서버 eth0에 할당된 Network Interface를 삭제하려면 해당 서버를 먼저 반납해 주십시오."
                  },
                  {
                      "id": "id2",
                      "doc": "VPC 삭제 생성하여 운영 중인 VPC를 삭제할 수 있습니다. 삭제하는 방법은 다음과 같습니다.참고VPC 안에 리소스가 남아 있으면 삭제되지 않습니다.VPC 삭제 시 해당 VPC와 연관된 서비스도 함께 삭제되며, 삭제 후에는 복구가 불가능합니다.** 네이버 클라우드 플랫폼 콘솔의 VPC 환경에서 Services > Networking > VPC 메뉴를 차례대로 클릭해 주십시오.** VPC Management 메뉴를 클릭해 주십시오.** 삭제할 VPC를 클릭한 후 [삭제] 버튼을 클릭해 주십시오.** VPC 삭제 팝업 창이 나타나면 [예] 버튼을 클릭해 주십시오.** VPC Management 화면의 VPC 목록에서 VPC 상태를 확인해 주십시오. 종료중 : VPC를 삭제하고 있는 상태*** 종료중 : VPC를 삭제하고 있는 상태"
                  }
              ],
              "suggestedQueries": [],
              "usage": {
                  "promptTokens": 777,
                  "completionTokens": 281,
                  "totalTokens": 1058
              }
          }
      }
      
    • 검색한 문서에서 답변을 찾지 못한 경우
      {
          "status": {
              "code": "20000",
              "message": "OK"
          },
          "result": {
              "result": "답변: 검색 결과에는 날씨에 대한 정보가 제공되지 않아, 날씨에 대한 정보를 알려드릴 수 없습니다.",
              "citedDocuments": [],
              "suggestedQueries": [
                  "현재 날씨 상태",
                  "일기 예보"
              ],
              "usage": {
                  "promptTokens": 774,
                  "completionTokens": 57,
                  "totalTokens": 831
              }
          }
      

    실패

    호출이 실패한 경우의 응답 예시는 다음과 같습니다.