이 튜토리얼에서는 Cloud Run Functions를 사용하여 Google Knowledge Graph API를 검색하는 Slack 슬래시 명령어의 구현 방법을 설명합니다.
목표
- Slack에서 슬래시 명령어를 만듭니다.
- HTTP Cloud Run 함수를 작성하고 배포합니다.
- 슬래시 명령어를 사용하여 Google Knowledge Graph API를 검색합니다.
비용
이 문서에서는 비용이 청구될 수 있는 다음과 같은 Google Cloud 구성요소를 사용합니다.
- Cloud Run functions
프로젝트 사용량을 기준으로 예상 비용을 산출하려면 가격 계산기를 사용하세요.
시작하기 전에
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Functions, Cloud Build, and Google Knowledge Graph Search APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Make sure that billing is enabled for your Google Cloud project.
-
Enable the Cloud Functions, Cloud Build, and Google Knowledge Graph Search APIs.
- Install the Google Cloud CLI.
-
To initialize the gcloud CLI, run the following command:
gcloud init
-
개발 환경을 준비합니다.
Node.js
Python
Go
Java
C#
Ruby
PHP
gcloud CLI가 이미 설치되어 있으면 다음 명령어를 실행하여 업데이트합니다.
gcloud components update
데이터 흐름 시각화
Slack 슬래시 명령어 가이드 애플리케이션의 데이터 흐름 단계는 다음과 같습니다.
- 사용자가 Slack 채널에서
/kg <search_query>
슬래시 명령어를 실행합니다. - Slack은 명령어 페이로드를 함수의 트리거 엔드포인트로 보냅니다.
- 함수는 사용자의 검색어와 함께 Knowledge Graph API에 요청을 보냅니다.
- Knowledge Graph API는 이와 일치하는 결과로 응답합니다.
- 함수는 응답의 형식을 Slack 메시지로 지정합니다.
- 함수는 메시지를 다시 Slack으로 보냅니다.
- 사용자는 Slack 채널에서 형식 지정된 응답을 봅니다.
해당 단계를 시각화하면 다음과 같습니다.
Knowledge Graph API 키 만들기
Google Cloud 콘솔 사용자 인증 정보 페이지에서 사용자 인증 정보 만들기 버튼을 클릭하고 API 키를 선택합니다. 이 키를 사용하여 다음 섹션에서 Knowledge Graph API에 액세스합니다.
함수 준비
샘플 앱 저장소를 로컬 머신에 클론합니다.
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
PHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
또는 zip 파일로 샘플을 다운로드하고 압축을 풀 수 있습니다.
Cloud Run Functions 샘플 코드가 포함된 디렉터리로 변경합니다.
Node.js
cd nodejs-docs-samples/functions/slack/
Python
cd python-docs-samples/functions/slack/
Go
cd golang-samples/functions/slack/
자바
cd java-docs-samples/functions/slack/
C#
cd dotnet-docs-samples/functions/slack/SlackKnowledgeGraphSearch/
Ruby
cd ruby-docs-samples/functions/slack/
PHP
cd php-docs-samples/functions/slack_slash_command/
함수 배포
사용자 또는 Slack이 함수의 엔드포인트에 HTTP POST 요청을 실행할 때 실행되는 함수를 배포하려면 샘플 코드(또는 자바용 pom.xml
파일)를 포함하는 디렉터리에서 다음 명령어를 실행합니다.
YOUR_SLACK_SIGNING_SECRET
을 앱 구성의 기본 정보 페이지에서 Slack이 제공한 서명 보안 비밀로, YOUR_KG_API_KEY
를 앞에서 만든 Knowledge Graph API 키로 바꿉니다.
Node.js
gcloud functions deploy kgSearch \ --runtime nodejs22 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 Node.js 버전의 런타임 ID를 지정합니다.
Python
gcloud functions deploy kg_search \ --runtime python312 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 Python 버전의 런타임 ID를 지정합니다.
Go
gcloud functions deploy KGSearch \ --runtime go122 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 Go 버전의 런타임 ID를 지정합니다.
자바
gcloud functions deploy java-slack-function \ --entry-point functions.SlackSlashCommand \ --runtime java21 \ --memory 512MB \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 Java 버전의 런타임 ID를 지정합니다.
C#
gcloud functions deploy csharp-slack-function \ --entry-point SlackKnowledgeGraphSearch.Function \ --runtime dotnet8 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 .NET 버전의 런타임 ID를 지정합니다.
Ruby
gcloud functions deploy kg_search --runtime ruby33 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 Ruby 버전의 런타임 ID를 지정합니다.
PHP
gcloud functions deploy searchKnowledgeGraph --runtime php83 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
플래그를 사용하여 함수를 실행할 지원되는 PHP 버전의 런타임 ID를 지정합니다.
애플리케이션 구성
함수가 배포되면 명령어가 트리거될 때마다 함수에 쿼리를 보내는 Slack 슬래시 명령어를 생성해야 합니다.
Slack 슬래시 명령어를 호스트할 Slack 앱을 만듭니다. 이를 통합 설치 권한이 있는 Slack팀과 연결합니다.
슬래시 명령어로 이동하여 새로운 명령어 만들기 버튼을 클릭합니다.
/kg
를 명령어 이름으로 입력합니다.명령어의 URL을 입력합니다.
Node.js
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/kgSearch
Python
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/kg_search
Go
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/KGSearch
자바
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/java-slack-function
C#
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/csharp-slack-function
Ruby
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/kg_search
PHP
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/searchKnowledgeGraph
여기서
YOUR_REGION
은 함수가 배포된 리전이고YOUR_PROJECT_ID
는 Cloud 프로젝트 ID입니다.함수 배포가 끝나면 두 값 모두 터미널에 표시됩니다.
저장을 클릭합니다.
기본 정보로 이동합니다.
작업공간에 앱 설치를 클릭하고 화면의 안내에 따라 작업공간에 애플리케이션을 사용 설정합니다.
Slack 슬래시 명령어가 곧 작동됩니다.
코드 이해하기
종속 항목 가져오기
애플리케이션은 Google Cloud Platform 서비스와 통신하기 위해 몇 가지 종속성을 가져와야 합니다.
Node.js
Python
Go
자바
C#
Ruby
PHP
웹훅 수신
다음 함수는 사용자(또는 Slack)가 함수의 엔드포인트로 HTTP POST 요청을 보낼 때 실행됩니다.
Node.js
Python
Go
자바
C#
Ruby
PHP
다음 함수는 Slack이 제공한 X-Slack-Signature
헤더를 확인하여 들어오는 요청을 인증합니다.
Node.js
Python
Go
자바
C#
Ruby
PHP
Knowledge Graph API 쿼리
다음 함수는 사용자의 검색어와 함께 Knowledge Graph API에 요청을 보냅니다.
Node.js
Python
Go
자바
C#
Ruby
PHP
Slack 메시지 형식 지정
마지막으로 다음 함수는 지식 정보 결과를 서식 있는 Slack 메시지로 형식 지정하여 사용자에게 표시합니다.
Node.js
Python
Go
자바
C#
Ruby
PHP
Slack API 제한 시간
Slack API는 함수가 웹훅 요청 수신 후 3초 이내에 응답할 것으로 예상합니다.
이 가이드의 명령어는 일반적으로 3초 이내에 응답합니다. 실행 시간이 더 긴 명령어의 경우 태스크 큐 역할을 하는 Pub/Sub 주제에 요청을 푸시(response_url
포함)하도록 함수를 구성하는 것이 좋습니다.
그런 다음 Pub/Sub로 트리거되는 두 번째 함수를 만들어 작업을 처리하고 결과를 Slack의 response_url
로 다시 보낼 수 있습니다.
슬래시 명령어 사용
Slack 채널에 다음 명령어를 입력합니다.
/kg giraffe
로그를 확인하여 실행이 완료되었는지 확인합니다.
gcloud functions logs read --limit 100
삭제
이 튜토리얼에서 사용된 리소스 비용이 Google Cloud 계정에 청구되지 않도록 하려면 리소스가 포함된 프로젝트를 삭제하거나 프로젝트를 유지하고 개별 리소스를 삭제하세요.
프로젝트 삭제
비용이 청구되지 않도록 하는 가장 쉬운 방법은 튜토리얼에서 만든 프로젝트를 삭제하는 것입니다.
프로젝트를 삭제하는 방법은 다음과 같습니다.
- In the Google Cloud console, go to the Manage resources page.
- In the project list, select the project that you want to delete, and then click Delete.
- In the dialog, type the project ID, and then click Shut down to delete the project.
함수 삭제
이 튜토리얼에서 배포한 함수를 삭제하려면 다음 명령어를 실행합니다.
Node.js
gcloud functions delete kgSearch
Python
gcloud functions delete kg_search
Go
gcloud functions delete KGSearch
자바
gcloud functions delete java-slack-function
C#
gcloud functions delete csharp-slack-function
Ruby
gcloud functions delete kg_search
PHP
gcloud functions delete searchKnowledgeGraph
Google Cloud 콘솔에서 Cloud Run Functions를 삭제할 수도 있습니다.