Questo tutorial dimostra l'utilizzo di Cloud Functions per implementare un comando Slack Slash che esegue ricerche nell'API Google Knowledge Graph.
Obiettivi
- Creare un comando slash in Slack.
- Scrivi una funzione Cloud Functions HTTP ed eseguine il deployment.
- Cercare nell'API Google Knowledge Graph utilizzando il comando slash.
Costi
In questo documento vengono utilizzati i seguenti componenti fatturabili di Google Cloud:
- Cloud Functions
- Cloud Build
- Artifact Registry
- Cloud Logging
For details, see Cloud Functions pricing.
Per generare una stima dei costi in base all'utilizzo previsto,
utilizza il Calcolatore prezzi.
Prima di iniziare
- Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
-
Abilita le API Cloud Functions, Cloud Build, Artifact Registry, and Logging.
- Installa Google Cloud CLI.
-
Per initialize gcloud CLI, esegui questo comando:
gcloud init
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.
-
Abilita le API Cloud Functions, Cloud Build, Artifact Registry, and Logging.
- Installa Google Cloud CLI.
-
Per initialize gcloud CLI, esegui questo comando:
gcloud init
-
Prepara l'ambiente di sviluppo.
Node.js
Python
Go
Java
C#
Ruby
PHP
Se hai già installato gcloud CLI, aggiornalo eseguendo questo comando:
gcloud components update
Visualizzare il flusso di dati
Il flusso di dati nell'applicazione del tutorial sul comando Slash di Slack prevede diversi passaggi:
- L'utente esegue il comando slash
/kg <search_query>
in un canale Slack. - Slack invia il payload del comando all'endpoint trigger della Cloud Function.
- La funzione Cloud Functions invia una richiesta con la query di ricerca dell'utente all'API Knowledge Graph.
- L'API Knowledge Graph risponde con risultati corrispondenti.
- La funzione Cloud Functions formatta la risposta in un messaggio Slack.
- La funzione Cloud Functions invia il messaggio a Slack.
- L'utente vede la risposta formattata nel canale Slack.
Può essere utile visualizzare i passaggi:
Recupero delle credenziali in corso...
Per eseguire il deployment della funzione, devi disporre di una chiave API fornita nella console Google Cloud e di un secret di firma Slack.
Ottenere la chiave API Knowledge Graph
Nella pagina Credenziali della console Google Cloud,
fai clic sul pulsante Crea credenziali e seleziona Chiave API. Ricorda questa chiave, perché la includerai nel comando deploy
. Questa chiave è ciò che consente alla tua funzione di accedere all'API Knowledge Graph.
Recupero del secret di firma di Slack
È necessario anche il secret di firma di Slack per eseguire il deployment della funzione. Per ottenere il secret di firma di Slack, crea l'app Slack che ospiterà il comando Slash di Slack. Questa app deve essere associata a un team Slack in cui disponi delle autorizzazioni per installare le integrazioni.
Vai alla pagina Le tue app di Slack e fai clic su Crea nuova app.
Scegli Da Scratch.
Fornisci un nome per la tua app e seleziona un'area di lavoro Slack in cui disponi delle autorizzazioni per installare le integrazioni.
Fai clic su Create App (Crea app).
L'app viene creata e la visualizzazione passa alla pagina Informazioni di base.
Nella pagina Informazioni di base, copia il secret di firma di Slack e salvalo.
Salva le modifiche.
Successivamente devi ottenere il codice sorgente ed eseguire il deployment della funzione. Dopo aver eseguito il deployment della funzione, configurerai l'app Slack per integrarla con la funzione di cui è stato eseguito il deployment, come descritto in Configurazione dell'applicazione.
Preparazione della funzione
Clona il repository dell'app di esempio nella tua macchina locale:
Node.js
git clone https://github.com/GoogleCloudPlatform/nodejs-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Python
git clone https://github.com/GoogleCloudPlatform/python-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Go
git clone https://github.com/GoogleCloudPlatform/golang-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Java
git clone https://github.com/GoogleCloudPlatform/java-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
C#
git clone https://github.com/GoogleCloudPlatform/dotnet-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Ruby
git clone https://github.com/GoogleCloudPlatform/ruby-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
PHP
git clone https://github.com/GoogleCloudPlatform/php-docs-samples.git
In alternativa, puoi scaricare l'esempio come file ZIP ed estrarlo.
Passa alla directory che contiene il codice campione di Cloud Functions:
Node.js
cd nodejs-docs-samples/functions/slack/
Python
cd python-docs-samples/functions/slack/
Go
cd golang-samples/functions/functionsv2/slack/
Java
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/
esegui il deployment della funzione
Per eseguire il deployment della funzione eseguita quando tu (o Slack) effettui una richiesta POST HTTP all'endpoint della funzione, esegui questo comando nella directory contenente il codice campione (o il file pom.xml
per Java).
Sostituisci YOUR_SLACK_SIGNING_SECRET
con il secret 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 nodejs-slack-function \ --gen2 \ --runtime=nodejs20 \ --region=REGION
\ --source=. \ --entry-point=kgSearch \
--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 Node.js supportata per eseguire la funzione.
Python
gcloud functions deploy python-slack-function \ --gen2 \ --runtime=python312 \ --region=REGION
\ --source=. \ --entry-point=kg_search \
--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 Python supportata per eseguire la funzione.
Go
gcloud functions deploy go-slack-function \ --gen2 \ --runtime=go121 \ --region=REGION
\ --source=. \ --entry-point=KGSearch \
--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 Go supportata per eseguire la funzione.
Java
gcloud functions deploy java-slack-function \ --gen2 \ --runtime=java17 \ --region=REGION
\ --source=. \ --entry-point=functions.SlackSlashCommand \ --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.
C#
gcloud functions deploy csharp-slack-function \ --gen2 \ --runtime=dotnet6 \ --region=REGION
\ --source=. \ --entry-point=SlackKnowledgeGraphSearch.Function \
--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 .NET supportata per eseguire la funzione.
Ruby
gcloud functions deploy ruby-slack-function \ --gen2 \ --runtime=ruby32 \ --region=REGION
\ --source=. \ --entry-point=kg_search \
--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 Ruby supportata per eseguire la funzione.
PHP
gcloud functions deploy php-slack-function \ --gen2 \ --runtime=php82 \ --region=REGION
\ --source=. \ --entry-point=receiveRequest \
--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 PHP supportata per eseguire
la funzione.
Configurazione dell'applicazione
Dopo il deployment della funzione, devi creare un comando Slack Slash che invia la query alla Cloud Function ogni volta che viene attivato il comando:
Seleziona l'app, vai a Comandi SSH e fai clic sul pulsante Crea nuovo comando.
Inserisci
/kg
come nome del comando.Nel campo URL di richiesta, inserisci l'URL della funzione.
Puoi copiare l'URL dall'output comando
deploy
oppure andare alla pagina Panoramica di Cloud Functions nella console Google Cloud, fare clic sulla funzione per aprire la relativa pagina Dettagli funzione e copiare l'URL da lì.Inserisci una breve descrizione e fai clic su Salva.
Vai a Informazioni di base.
Fai clic su Installa in Workspace e segui le istruzioni sullo schermo per attivare l'applicazione per la tua area di lavoro.
Il tuo comando slash di Slack dovrebbe essere online a breve.
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
C#
Ruby
PHP
Ricezione del webhook in corso...
La seguente funzione viene eseguita quando tu (o Slack) effettui una richiesta POST HTTP all'endpoint della funzione:
Node.js
Python
Go
Java
C#
Ruby
PHP
La seguente funzione autentica la richiesta in entrata verificando l'intestazione X-Slack-Signature
fornita da Slack:
Node.js
Python
Go
Java
C#
Ruby
PHP
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
C#
Ruby
PHP
Formattazione del messaggio Slack
Infine, la seguente funzione formatta il risultato del Knowledge Graph in un messaggio Slack in formato RTF che verrà visualizzato all'utente:
Node.js
Python
Go
Java
C#
Ruby
PHP
Timeout API Slack
L'API Slack prevede che la funzione risponda entro 3 secondi dalla ricezione di una richiesta webhook.
Generalmente, la risposta ai comandi in questo tutorial richiede meno di tre secondi. Per i comandi a lunga esecuzione, consigliamo di configurare una funzione per eseguire il push delle richieste (incluso il relativo campo response_url
) a un argomento Pub/Sub che funga da coda di attività.
Quindi, 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 Barra
Una volta completato il deployment della funzione, digita questo comando nel tuo canale Slack:
/kg giraffe
Dovresti vedere la voce Knowledge Graph per "giraffe".
Controlla i log per visualizzare l'output dell'esecuzione della funzione:
gcloud functions logs read --limit 100
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 è quello di eliminare il progetto che hai creato per il tutorial.
Per eliminare il progetto:
- Nella console Google Cloud, vai alla pagina Gestisci risorse.
- Nell'elenco dei progetti, seleziona il progetto che vuoi eliminare, quindi fai clic su Elimina.
- Nella finestra di dialogo, digita l'ID del progetto e fai clic su Chiudi per eliminare il progetto.
Eliminazione della Cloud Function
Per eliminare la Cloud Function di cui hai eseguito il deployment in questo tutorial, esegui questo comando:
Node.js
gcloud functions delete nodejs-slack-function --gen2 --region REGION
Python
gcloud functions delete python-slack-function --gen2 --region REGION
Go
gcloud functions delete go-slack-function --gen2 --region REGION
Java
gcloud functions delete java-slack-function --gen2 --region REGION
C#
gcloud functions delete csharp-slack-function --gen2 --region REGION
Ruby
gcloud functions delete ruby-slack-function --gen2 --region REGION
PHP
gcloud functions delete php-slack-function --gen2 --region REGION
Puoi eliminare Cloud Functions anche dalla console Google Cloud.