키워드 매칭 How-to guides

페이지 이동경로

키워드 매칭 사용 가이드

사전 작업

카카오 i 클라우드의 키워드 매칭 API를 사용하기 위해서는 조직 소유자 또는 조직 관리자가 카카오 i 클라우드 콘솔에서 클라우드 조직 계정 및 프로젝트 생성, 사용자 초대, 조직 및 프로젝트 역할 추가 등의 작업을 완료해야 합니다. 따라서 카카오 i 클라우드 콘솔 또는 프로젝트에 접근 권한이 없는 경우, 조직 소유자/관리자 또는 프로젝트 관리자에게 사용자 등록 또는 프로젝트 역할 추가를 요청하시기 바랍니다.

사용자 초대 및 프로젝트 역할 추가 관련 프로세스는 Kakao i Cloud Console > 관리자 가이드 문서를 참고하세요.

키워드 매칭 API

키워드 매칭 API를 사용하기 위해서는 도메인 만들기, 인증정보 획득, API 한도 설정, API 호출 작업을 단계적으로 수행해야 합니다.

Step 1. 도메인 만들기

도메인이란 카카오 i 클라우드의 API를 호출하는 서비스의 단위로 카카오 i 클라우드 콘솔에서 발급받을 수 있습니다. 콘솔에서 서비스 별 도메인을 생성해야 API 호출 시 필요한 암호화된 API Key 정보를 발급받을 수 있으며, API Endpoint URL도 생성할 수 있습니다. 도메인 생성 방법은 다음과 같습니다.

  1. 카카오 i 클라우드 콘솔에서 이동할 프로젝트를 선택한 후, AI Service > NLP > 키워드 매칭을 선택합니다.

    명칭 링크
    카카오 i 클라우드 콘솔 https://console.kakaoi.io/
  2. 도메인 탭에서 [도메인 만들기] 버튼을 클릭하여 생성할 도메인 내용을 입력합니다.

    도메인 만들기

    이미지 도메인 정보 입력

    구분 필수 여부 설명
    서비스 필수 키워드 매칭 선택
    도메인 이름 필수 해당 도메인의 이름
    - 영어 소문자로 시작해야 함
    - 4-30자로 제한
    - 영문 소문자, 숫자, - 만 입력 가능
    도메인 설명 선택 해당 도메인에 대한 상세 설명을 입력
    - 60자로 제한
  3. 도메인 목록에 해당 도메인이 정상적으로 생성되었는지 확인합니다.

    도메인 확인

    이미지 도메인 생성 확인

생성한 도메인을 더 이상 사용하지 않을 경우에는, 도메인 목록 우측의 더보기 메뉴에서 [도메인 삭제] 버튼을 클릭하여 도메인을 삭제할 수 있습니다.

Step 2. 인증정보 획득하기

도메인을 생성하면, API 호출 시에 필요한 API KeyAPI Endpoint URL을 발급받을 수 있습니다.

  1. 카카오 i 클라우드 콘솔에서 이동할 프로젝트를 선택한 후, AI Service > NLP 메뉴를 클릭합니다.
  2. 도메인 탭에서, 생성한 해당 도메인의 [인증 정보] 버튼을 클릭합니다.
  3. API 인증정보 팝업창에서 API Key와 API Endpoint URL 정보를 확인합니다.

    인증 정보

    이미지 API 인증 정보

    구분 설명
    API Key API Endpoint URL 호출에 필요한 API의 고유한 키 정보로 암호화된 상태로 제공
    - API Key를 재발급 받을 경우에는 기존에 발급받은 정보는 폐기됨
    API Endpoint URL API 호출 시에 사용하는 API Endpoint URL 주소

Step 3. API 한도 설정하기

필요 시 API 사용 한도를 설정할 수 있습니다. 별도로 API 한도를 설정하지 않는다면 기본으로 지정된 최대 한도까지 호출할 수 있으며, 설정 한도를 초과할 경우에는 API가 호출되지 않습니다.

  1. 카카오 i 클라우드 콘솔에서 이동할 프로젝트를 선택한 후, AI Service > NLP 메뉴를 클릭합니다.
  2. 도메인 탭에서, 생성한 해당 도메인의 [한도 설정] 버튼을 클릭합니다.
  3. API 사용 한도 설정 팝업창에서 API 한도를 설정합니다.

    한도 설정

    이미지 API 사용 한도 설정

    구분 설명
    기준 기간 일별 한도로 고정
    한도 설정 일별 API 사용 최대 한도
    - 최대값: 8,200,000 글자수(기본값)
    기준 기간 월별 한도로 고정
    한도 설정 월별 API 사용 최대 한도
    - 최대값: 246,000,000 글자수(기본값)

Step 4. API 호출하기

위 작업을 모두 완료하면 API 레퍼런스를 참고하여 해당 키워드 매칭 API를 호출할 수 있습니다.

Step 5. 도메인 수정하기

도메인의 이름이나 설명을 수정할 수 있습니다.

  1. 카카오 i 클라우드 콘솔에서 이동할 프로젝트를 선택한 후, AI Service > NLP 메뉴를 클릭합니다.
  2. 도메인 탭으로 이동 후, 도메인 목록에서 [더보기] 아이콘을 클릭하고, 도메인 수정을 클릭합니다.

    스크린샷 2022-10-24 17.00.04.png

    이미지 도메인 수정 선택

  3. 모달에서 도메인 이름 및 설명을 수정하고 [수정] 버튼을 눌러 저장합니다.

    이미지

    이미지 도메인 수정 진행

Step 6. 도메인 삭제하기

더 이상 서비스를 이용하지 않으려면 생성한 도메인을 삭제합니다.

도메인 삭제 시, API Key와 API Endpoint URL이 모두 삭제되며 이는 복원할 수 없습니다.

  1. 카카오 i 클라우드 콘솔에서 이동할 프로젝트를 선택한 후, AI Service > NLP 메뉴를 클릭합니다.
  2. 도메인 탭으로 이동 후, 도메인 목록에서 삭제할 도메인의 [더보기] 버튼 > 도메인 삭제를 클릭합니다.

    그림. 도메인 삭제

    이미지 도메인 삭제 선택

  3. 도메인 삭제 팝업창에 삭제할 도메인 이름을 정확하게 입력하고 [삭제] 버튼을 클릭합니다.

    그림. 도메인 삭제 진행

    이미지 도메인 삭제 진행