AI 챗봇으로 슬랙에서 연말정산 Q&A 자동화 하기 (feat. OpenAI)

안녕하세요, 지난 OpenAI DevDay에서 PDF 등 문서를 업로드하여 이를 기반으로 질문을 하고 GPT 모델이 답을 해주는 Assistants API가 발표되었는데요, 단순히 브라우저에서 사용할 수 있는 것에서 그치지 않고 Python/JavaScript 라이브러리를 통해 개발 중인 어플리케이션과 손쉽게 연동할 수 있는 것이 큰 특징입니다. Assistants의 동작 방식은 여기에서 자세히 확인하실 수 있습니다.

이번 포스트에서는 어플리케이션을 손쉽게 배포할 수 있는 클라우드타입을 활용하여 OpenAI Assistants와 연동한 슬랙봇을 만들어 보겠습니다. AI에게 학습시킬 PDF는 최근 관심도가 높은 2023년 귀속 연말정산 안내 책자입니다.

준비사항

• OpenAI 계정
• 슬랙 계정 및 워크스페이스
• 클라우드타입 계정

따라하기

OpenAI의 기능을 외부에서 활용하기 위한 API 키 발급과 문서를 학습하고 답해주는 Assistant 생성이 필요합니다.

OpenAI API Key 발급

1. OpenAI 대시보드에서 API Keys 페이지로 이동한 후 Create new secret key 버튼을 누릅니다. API 키의 이름은 용도에 따라 식별할 수 있는 이름으로 입력합니다.
   

2. 생성된 API 키는 생성 당시 최초 1회만 조회할 수 있기 때문에 외부에 노출되지 않는 안전한 곳에 저장합니다.
   

OpenAI Assistant 생성 및 Assistant ID 확인

1. OpenAI 대시보드에서 Assistants 페이지로 이동한 후 Create 버튼을 누릅니다. 입력 필드 및 설정은 아래를 참고하여 입력합니다.

   • Name: 식별할 수 있는 assistant의 이름
   • Instructions: AI 모델의 답변 생성 지침
   • Model: 언어 모델(gpt-4-1106-preview, gpt-3.5-turbo-1106 사용 가능)
   • Retrieval: 업로드 한 파일 기준으로 답변할 수 있도록 활성화
   • Files: 학습 대상 문서 파일

   

2. Assistant 생성 후 Name 입력 필드 하단에 생성되는 Assistant ID를 안전한 곳에 별도로 보관합니다.
   

3. Test 버튼을 누르면 Assistant가 잘 작동하는지 질문하고 답변을 확인할 수 있습니다.
   

Slack App 생성 및 설정

1. 슬랙의 워크스페이스명을 클릭하고 설정 및 관리 > 앱 관리 로 진입합니다.
   

2. 우측 상단의 구축 버튼을 누르고 이어서 Create New App 버튼을 누릅니다. 이어서 From scratch 를 클릭합니다.
   

3. 앱의 이름을 적절히 작성하고 봇을 사용할 워크스페이스를 선택합니다.
   

4. 앱 생성 후 Basic Information 페이지의 App Credentials 항목에서 Signing Secret을 확인하고 안전한 곳에 저장합니다.

5. Basic Information 페이지의 App-Level Tokens 항목에서 Generate Token and Scopes 버튼을 클릭합니다. 이어서 Token Name에는 적절한 이름을 입력해주고 하단의 드롭다운에서 connections:write 를 선택한 후 Create 버튼을 눌러 앱 토큰을 생성합니다.
   

6. 생성된 앱 토큰은 외부에 노출되지 않는 안전한 곳에 저장합니다.
   

7. OAuth & Permissions 페이지로 이동하여 Scopes - Bot Token Scopes 에서 Add an OAuth Scope 버튼을 누른 후 다음의 항목을 추가합니다.

   • channels:history
   • chat:write
   • commands
   • groups:history

   

8. App Home 페이지로 이동하여 Your App's Presence in Slack 에서 Edit 버튼을 누르고 워크스페이스에서 노출되는 슬랙봇의 이름과 username을 설정합니다.
   

9. Install App 페이지로 이동하여 Install to Workspace 버튼을 누르고 권한 요청 페이지에서 허용 버튼을 누릅니다. 정상적으로 설치가 완료되면 생성된 봇 토큰을 확인할 수 있으며, 이를 안전한 곳에 보관합니다.
   

클라우드타입 슬랙봇 서버 배포 및 URL 확인

1. 클라우드타입 대시보드의 + 버튼을 누르고 AI ChatBot - Slack 템플릿을 검색한 후 선택합니다. 이어서 Slack Command Name에는 워크스페이스에서 사용할 슬래시 명령어, Slack Bot Title에는 메세지에 표시되는 제목을 입력하고 나머지 필드에는 미리 보관해두었던 값들을 모두 입력한 후 배포하기 버튼을 누릅니다.
   

2. 배포된 슬랙봇 서버의 상태가 실행 중으로 바뀌면 터미널 아이콘을 눌러 서버가 정상 구동되었는지 확인합니다.
   

3. 슬랙에서 이벤트를 수신하여 서버에서 처리할 수 있도록 하기 위해서는 서버의 URL을 슬랙의 앱 설정에 등록해야 합니다. 배포된 슬랙봇 서버의 연결 탭에서 표시된 URL을 보관해둡니다.
   

Slack 봇의 슬래시 명령어 및 이벤트 수신 등록

1. Slash Command 페이지에서 Create New Command 버튼을 누르고 다음을 참고하여 값을 입력합니다.

   • Command: 워크스페이스에서 사용할 슬래시 명령어. 클라우드타입에서 배포할 때 설정했던 Slash Command 값과 동일해야 하며, / + 명령어 형식으로 입력
   • Request URL: 클라우드타입에서 할당된 슬랙봇 서버의 URL에 이벤트 수신 전용 경로를 추가하여 <슬랙봇 서버 URL>/slack/events 형식으로 입력
   • Short Description: 슬래시 명령어의 간략한 설명 입력

   

2. Event Subscription 페이지에서 Enable Events 를 활성화 하고 Request URL 항목에 <슬랙봇 서버 URL>/slack/events 를 입력합니다. 정상적으로 인증이 되면 Verified 라는 메세지가 표시됩니다.
   

3. 이어서 하단의 Subscribe to bot events 에서 다음의 이벤트를 추가하고 Save Changes 버튼을 누릅니다.

   • message.channels
   • message.groups

   

Slack 채널 앱 추가 및 질문 테스트

1. 슬랙봇을 사용할 채널을 클릭하고 통합 탭에서 앱 추가 버튼을 누릅니다.
   

2. 생성한 AI슬랙봇 앱의 추가 버튼을 누릅니다.
   

3. 슬래시 명령어 /연말정산 을 메세지 창에 입력하고 원하는 질문을 이어서 입력한 후 메세지를 전송합니다.
   

4. OpenAI의 Assistant API를 통해 수신된 정보를 AI 슬랙봇의 답변으로 확인할 수 있습니다.
   

참고

Youtube 튜토리얼

기타 문서

• OpenAI Assistants API