Questo tutorial mostra l'utilizzo di Cloud Run Functions per implementare un comando slash di Slack che esegue ricerche nell'API Google Knowledge Graph.
Obiettivi
- Crea un comando slash in Slack.
- Scrivi ed esegui il deployment di una funzione Cloud Run HTTP.
- Cerca nell'API Google Knowledge Graph utilizzando il comando slash.
Costi
In questo documento utilizzi 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.
-
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
-
Prepara l'ambiente di sviluppo.
Node.js
Python
Vai
Java
C#
Ruby
PHP
Se hai già installato gcloud CLI, aggiornalo eseguendo il seguente comando:
gcloud components update
Visualizzazione del flusso di dati
Il flusso di dati nell'applicazione del tutorial sui comandi con barra 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 di attivazione 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 di Slack.
- La funzione invia nuovamente il messaggio a Slack.
- L'utente vede la risposta formattata nel canale Slack.
Potrebbe essere utile visualizzare i passaggi:
Creazione della 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 userai per accedere all'API Knowledge Graph nella sezione successiva.
Preparazione della funzione
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 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.
Vai
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 di esempio 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/
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 eseguire il deployment della funzione che viene eseguita quando tu (o Slack) invii una richiesta HTTP POST all'endpoint della funzione, esegui il seguente comando nella directory contenente il codice di esempio (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 nodejs22 \
--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 go122 \
--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 \ --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
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 \ --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
Utilizza il flag --runtime
per specificare l'ID runtime di una versione .NET 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.
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
Utilizza il flag --runtime
per specificare l'ID runtime di una versione PHP supportata per eseguire la funzione.
Configurazione dell'applicazione
Dopo aver eseguito il deployment della funzione, devi creare un comando barra di Slack che invii la query alla funzione ogni volta che viene attivato il comando:
Crea un'app di Slack per ospitare il tuo comando slash di Slack. Associalo a un team di Slack in cui disponi delle autorizzazioni per installare le integrazioni.
Vai a Comandi con barra 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
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
dove
YOUR_REGION
è la regione in cui è eseguita 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 nella tua area di lavoro e segui le istruzioni sullo schermo per attivare l'applicazione per la tua area di lavoro.
Il 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 della piattaforma Google Cloud:
Node.js
Python
Vai
Java
C#
Ruby
PHP
Ricezione dell'webhook
La seguente funzione viene eseguita quando tu (o Slack) invii una richiesta HTTP POST all'endpoint della funzione:
Node.js
Python
Vai
Java
C#
Ruby
PHP
La seguente funzione autentica la richiesta in arrivo verificando l'X-Slack-Signature
header fornito da Slack:
Node.js
Python
Vai
Java
C#
Ruby
PHP
Eseguire 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
Vai
Java
C#
Ruby
PHP
Formattazione del messaggio di Slack
Infine, la seguente funzione formatta il risultato del Knowledge Graph in un messaggio di Slack con un formato avanzato che verrà mostrato all'utente:
Node.js
Python
Vai
Java
C#
Ruby
PHP
Tempo di attesa dell'API Slack
L'API Slack si aspetta che la tua funzione risponda entro 3 secondi dalla ricezione di una richiesta webhook.
I comandi in questo tutorial in genere richiedono meno di 3 secondi per rispondere. Per i comandi con tempi di esecuzione più lunghi, ti consigliamo di configurare una funzione per inviare richieste (inclusi i relativi 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 restituisce i risultati a response_url
di Slack.
Utilizzo del comando slash
Digita il comando nel canale Slack:
/kg giraffe
Controlla i log per assicurarti che le esecuzioni siano state completate:
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 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.
Eliminazione della funzione
Per eliminare la funzione di cui hai eseguito il deployment in questo tutorial, esegui il seguente 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
C#
gcloud functions delete csharp-slack-function
Ruby
gcloud functions delete kg_search
PHP
gcloud functions delete searchKnowledgeGraph
Puoi anche eliminare le funzioni Cloud Run dalla console Google Cloud.