Questo tutorial mostra l'utilizzo delle funzioni Cloud Run per implementare un comando slash di Slack che esegue ricerche nell'API Google Knowledge Graph.
Obiettivi
- Crea un comando slash in Slack.
- Scrivere ed eseguire il deployment di una funzione Cloud Run HTTP.
- Cercare nell'API Google Knowledge Graph utilizzando il comando Slash.
Costi
In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:
- Cloud Run functions
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il calcolatore prezzi.
Prima di iniziare
- 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.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator
), which contains theresourcemanager.projects.create
permission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the Cloud Functions, Cloud Build, and Google Knowledge Graph Search APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin
), which contains theserviceusage.services.enable
permission. Learn how to grant roles. -
Install the Google Cloud CLI.
-
Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.
-
Per inizializzare gcloud CLI, esegui questo comando:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator
), which contains theresourcemanager.projects.create
permission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the Cloud Functions, Cloud Build, and Google Knowledge Graph Search APIs.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin
), which contains theserviceusage.services.enable
permission. Learn how to grant roles. -
Install the Google Cloud CLI.
-
Se utilizzi un provider di identità (IdP) esterno, devi prima accedere a gcloud CLI con la tua identità federata.
-
Per inizializzare gcloud CLI, esegui questo comando:
gcloud init
- Prepara l'ambiente di sviluppo.
- L'utente esegue il comando slash
/kg <search_query>
in un canale Slack. - Slack invia il payload del comando all'endpoint del trigger della funzione.
- La funzione invia una richiesta con la query di ricerca dell'utente all'API Knowledge Graph.
- L'API Knowledge Graph risponde con tutti i risultati corrispondenti.
- La funzione formatta la risposta in un messaggio Slack.
- La funzione invia il messaggio di nuovo a Slack.
- L'utente vede la risposta formattata nel canale Slack.
Clona il repository dell'app di esempio sulla tua macchina locale:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Vai
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
In alternativa, puoi scaricare il campione come file ZIP ed estrarlo.
Passa alla directory che contiene il codice campione delle funzioni Cloud Run:
Node.js
cd nodejs-docs-samples/functions/slack/
Python
cd python-docs-samples/functions/slack/
Vai
cd golang-samples/functions/slack/
Java
cd java-docs-samples/functions/slack/
Ruby
cd ruby-docs-samples/functions/slack/
Crea un'app Slack per ospitare il comando slash di Slack. Associalo a un team Slack in cui hai le autorizzazioni per installare integrazioni.
Vai a Comandi slash e fai clic sul pulsante Crea nuovo comando.
Inserisci
/kg
come nome del comando.Inserisci l'URL del comando:
Node.js
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/kgSearch
Python
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/kg_search
Vai
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/KGSearch
Java
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/java-slack-function
Ruby
https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/kg_search
dove
YOUR_REGION
è la regione in cui è stato eseguito il deployment della funzione eYOUR_PROJECT_ID
è l'ID progetto Cloud.Entrambi i valori sono visibili nel terminale al termine del deployment della funzione.
Fai clic su Salva.
Vai a Informazioni di base.
Fai clic su Installa l'app nell'area di lavoro e segui le istruzioni sullo schermo per attivare l'applicazione per l'area di lavoro.
Il tuo comando slash di Slack dovrebbe essere disponibile a breve.
Digita il comando nel tuo canale Slack:
/kg giraffe
Guarda i log per assicurarti che le esecuzioni siano state completate:
gcloud functions logs read --limit 100
- 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.
Se hai già installato gcloud CLI, aggiornala eseguendo il seguente comando:
gcloud components update
Visualizzare il flusso di dati
Il flusso di dati nell'applicazione tutorial sui comandi slash di Slack prevede diversi passaggi:
Può essere utile visualizzare i passaggi:
Creazione della chiave API Knowledge Graph
Nella pagina Credenziali della consoleGoogle Cloud , fai clic sul pulsante Crea credenziali e seleziona Chiave API. Ricorda questa chiave, perché la utilizzerai per accedere all'API Knowledge Graph nella sezione successiva.
Preparazione della funzione
Deployment della funzione
Per eseguire il deployment della funzione eseguita quando tu (o Slack) effettui una richiesta HTTP POST all'endpoint della funzione, esegui questo comando nella directory che contiene il codice campione (o il file pom.xml
per Java):
Sostituisci YOUR_SLACK_SIGNING_SECRET
con il segreto di firma fornito da Slack nella pagina Informazioni di base della configurazione dell'app e YOUR_KG_API_KEY
con la chiave API Knowledge Graph che hai creato in precedenza.
Node.js
gcloud functions deploy kgSearch \ --runtime nodejs20 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
Utilizza il flag --runtime
per specificare l'ID runtime di una versione di Node.js supportata per eseguire la funzione.
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
Utilizza il flag --runtime
per specificare l'ID runtime di una
versione di Python supportata per eseguire
la funzione.
Vai
gcloud functions deploy KGSearch \ --runtime go121 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
Utilizza il flag --runtime
per specificare l'ID runtime di una versione di Go supportata per eseguire la funzione.
Java
gcloud functions deploy java-slack-function \ --entry-point functions.SlackSlashCommand \ --runtime java17 \ --memory 512MB \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
Utilizza il flag --runtime
per specificare l'ID runtime di una
versione Java supportata per eseguire
la funzione.
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
Utilizza il flag --runtime
per specificare l'ID runtime di una
versione di Ruby supportata per eseguire
la funzione.
Configurazione dell'applicazione
Dopo aver eseguito il deployment della funzione, devi creare un comando slash di Slack che invia la query alla funzione ogni volta che il comando viene attivato:
Nozioni di base sul codice
Importazione delle dipendenze
L'applicazione deve importare diverse dipendenze per comunicare con i servizi Google Cloud Platform:
Node.js
Python
Go
Java
Ruby
Ricezione del webhook
La seguente funzione viene eseguita quando tu (o Slack) effettui una richiesta HTTP POST all'endpoint della funzione:
Node.js
Python
Go
Java
Ruby
La seguente funzione autentica la richiesta in entrata verificando l'intestazione X-Slack-Signature
fornita da Slack:
Node.js
Python
Go
Java
Ruby
Esecuzione di query sull'API Knowledge Graph
La seguente funzione invia una richiesta con la query di ricerca dell'utente all'API Knowledge Graph:
Node.js
Python
Go
Java
Ruby
Formattazione del messaggio Slack
Infine, la seguente funzione formatta il risultato di Knowledge Graph in un messaggio Slack formattato in modo avanzato che verrà visualizzato dall'utente:
Node.js
Python
Go
Java
Ruby
Timeout dell'API Slack
L'API Slack prevede che la tua funzione risponda entro 3 secondi dalla ricezione di una richiesta webhook.
In genere, i comandi di questo tutorial richiedono meno di 3 secondi per rispondere. Per i comandi
di esecuzione più lunga, ti consigliamo di configurare una funzione per inviare le richieste
(incluso il relativo response_url
)
a un argomento Pub/Sub che funge da coda di attività.
Poi puoi creare una seconda funzione attivata da Pub/Sub
che elabora queste attività e invia i risultati al response_url
di Slack.
Utilizzo del comando slash
Esegui la pulizia
Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.
Elimina il progetto
Il modo più semplice per eliminare la fatturazione è eliminare il progetto creato per il tutorial.
Per eliminare il progetto:
Eliminazione della funzione
Per eliminare la funzione di cui hai eseguito il deployment in questo tutorial, esegui questo comando:
Node.js
gcloud functions delete kgSearch
Python
gcloud functions delete kg_search
Vai
gcloud functions delete KGSearch
Java
gcloud functions delete java-slack-function
Ruby
gcloud functions delete kg_search
Puoi anche eliminare le funzioni Cloud Run dalla consoleGoogle Cloud .