Questo tutorial illustra l'utilizzo di Cloud Functions per implementare un comando Slash Slash che cerca l'API Google Knowledge Graph.
Obiettivi
- Crea un comando Slash in Slack.
- Scrivere ed eseguire il deployment di una funzione Cloud Functions HTTP.
- Cerca l'API Google Knowledge Graph utilizzando il comando Slash.
Costi
Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:
- Cloud Functions
- Cloud Build
- Artifact Registry
- Cloud Logging
Per i dettagli, consulta i prezzi di Cloud Functions.
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.
-
Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.
-
Abilita le API Cloud Functions, Cloud Build, Artifact Registry, and Logging.
- Installa Google Cloud CLI.
-
Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:
gcloud init
-
Nella pagina del selettore dei progetti in Google Cloud Console, seleziona o crea un progetto Google Cloud.
-
Assicurati che la fatturazione sia attivata per il tuo progetto Cloud. Scopri come verificare se la fatturazione è abilitata su un progetto.
-
Abilita le API Cloud Functions, Cloud Build, Artifact Registry, and Logging.
- Installa Google Cloud CLI.
-
Per inizializzare l'interfaccia a riga di comando gcloud, esegui il comando seguente:
gcloud init
-
Prepara l'ambiente di sviluppo.
Node.js
Python
Go
Java
C#
Ruby
PHP
Se hai già installato l'interfaccia a riga di comando gcloud, aggiornalo eseguendo questo comando:
gcloud components update
Visualizzazione del flusso di dati
Il flusso dei dati nell'applicazione Slash Command di Slash prevede diversi passaggi:
- L'utente esegue il comando slash di
/kg <search_query>
in un canale Slack. - Slack invia il payload dei comandi all'endpoint di attivazione della funzione Cloud Functions.
- La funzione Cloud Functions invia una richiesta con la query di ricerca dell'utente all'API Knowledge Graph.
- L'API Knowledge Graph risponde con qualsiasi risultato corrispondente.
- La funzione Cloud Functions formatta la risposta in un messaggio di Slack.
- La funzione Cloud Functions restituisce il messaggio a Slack.
- L'utente vede la risposta formattata nel canale Slack.
Potrebbe essere utile visualizzare i passaggi:
Recupero delle credenziali
Per eseguire il deployment della funzione, devi disporre di una chiave API fornita da 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, poiché la includerai nel comando deploy
. Questa chiave è ciò che consente alla funzione di accedere all'API Knowledge Graph.
Recupero del secret di firma Slack
Ti serve anche il secret di firma Slack per eseguire il deployment della funzione. Per ottenere il secret di firma Slack, crea l'app Slack che ospita il comando Slack. Questa app deve essere associata a un team Slack in cui disponi delle autorizzazioni per installare le integrazioni.
Vai alla pagina Slack Le tue app e fai clic su Crea nuova app.
Scegli Da zero.
Specifica un nome per l'app e seleziona un'area di lavoro di 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 sottoposta a deployment, come descritto in Configurare l'applicazione.
Preparazione della funzione in corso...
Clona il repository dell'app di esempio nella 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 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/
Deployment della funzione
Per il deployment della funzione che viene eseguita quando (o Slack) effettui una richiesta HTTP POST all'endpoint della funzione, esegui il comando seguente nella directory che contiene il codice di esempio (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 creata in precedenza.
Node.js
gcloud functions deploy nodejs-slack-function \ --gen2 \ --runtime=nodejs18 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --source=. \ --entry-point=kgSearch \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
per specificare la versione di Node.js che preferisci:
nodejs18
(consigliato)nodejs16
nodejs14
nodejs12
nodejs10
Python
gcloud functions deploy python-slack-function \ --gen2 \ --runtime=python310 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --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
--runtime
per specificare la versione di Python che preferisci:
python310
(consigliato)python311
(anteprima)python39
python38
python37
Go
gcloud functions deploy go-slack-function \ --gen2 \ --runtime=go119 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --source=. \ --entry-point=KGSearch \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
per specificare la tua versione di Go preferita:go119
(consigliato)go118
go116
go113
Java
gcloud functions deploy java-slack-function \ --gen2 \ --runtime=java17 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --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
--runtime
per specificare la versione di Java che preferisci:
java17
(consigliato)java11
C#
gcloud functions deploy csharp-slack-function \ --gen2 \ --runtime=dotnet6 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --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
--runtime
per specificare la versione di .NET che preferisci:
dotnet6
(consigliato)dotnet3
Ruby
gcloud functions deploy ruby-slack-function \ --gen2 \ --runtime=ruby30 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --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
--runtime
per specificare la versione di Ruby che preferisci:
ruby30
(consigliato)ruby27
ruby26
PHP
gcloud functions deploy php-slack-function \ --gen2 \ --runtime=php81 \ --region=Puoi utilizzare i seguenti valori per il flagREGION
\ --source=. \ --entry-point=receiveRequest \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
per specificare la versione di PHP che preferisci:
php81
(consigliato)php74
Configurazione dell'applicazione
Dopo aver eseguito il deployment della funzione, devi creare un comando Slash Slack che invii la query alla funzione Cloud ogni volta che viene attivato il comando:
Seleziona l'app, vai a Comandi slash 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 di
deploy
o 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 l'area di lavoro.
Il tuo comando Slash dovrebbe essere online a breve.
Nozioni di base sul codice
Importazione delle dipendenze
L'applicazione deve importare diverse dipendenze per comunicare con i servizi di Google Cloud Platform:
Node.js
Python
Go
Java
C#
Ruby
PHP
Ricezione del webhook
La funzione seguente viene eseguita quando tu (o Slack) effettui una richiesta HTTP POST all'endpoint della funzione:
Node.js
Python
Go
Java
C#
Ruby
PHP
La seguente funzione autentica la richiesta in arrivo 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 di Slack
Infine, la seguente funzione formatta il risultato del Knowledge Graph in un messaggio Slack rich media che verrà visualizzato per l'utente:
Node.js
Python
Go
Java
C#
Ruby
PHP
Timeout dell'API Slack
L'API Slack prevede che la tua funzione risponda entro 3 secondi dalla ricezione di una richiesta di webhook.
Generalmente, per rispondere ai comandi di questo tutorial sono necessari meno di 3 secondi. Per i comandi più lunghi, ti consigliamo di configurare una funzione per inviare richieste push (incluso il 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 tali attività e restituisce i risultati all'response_url
di Slack.
Utilizzo del comando Slash
Al termine del deployment della funzione, digita questo comando nel 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 è eliminare il progetto che hai creato per il tutorial.
Per eliminare il progetto:
- In Google Cloud Console, 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 funzione Cloud Functions
Per eliminare la funzione Cloud Functions 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 anche eliminare Cloud Functions dalla console Google Cloud.