Questo tutorial illustra l'utilizzo di Cloud Functions per implementare un comando Slash Slash che cerca nell'API Google Knowledge Graph.
Obiettivi
- Crea un comando Slash in Slack.
- Scrivi e sottoponi a deployment una funzione Cloud HTTP.
- Cerca nell'API Google Knowledge Graph utilizzando il comando Slash.
Costi
Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:
- 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, and Google Knowledge Graph Search.
- Installa e inizializza l'interfaccia a riga di comando di Google Cloud.
-
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, and Google Knowledge Graph Search.
- Installa e inizializza l'interfaccia a riga di comando di Google Cloud.
-
Prepara l'ambiente di sviluppo.
Node.js
Python
Go
Java
C#
Ruby
PHP
Se hai già installato l'interfaccia a riga di comando gcloud, aggiornala eseguendo il comando seguente:
gcloud components update
Visualizzare il flusso dei dati
Il flusso di dati nell'applicazione tutorial Slash Command richiede 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 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 Slack.
- La funzione Cloud restituisce il messaggio a Slack.
- L'utente visualizza la risposta formattata nel canale Slack.
Potrebbe essere utile visualizzare i passaggi:
Creazione della chiave API Knowledge Graph
Nella pagina Credenziali di Google Cloud Console, fai clic sul pulsante Crea credenziali e seleziona Chiave API. Ricorda questa chiave, poiché la utilizzerai per accedere all'API Knowledge Graph nella sezione successiva.
Preparazione della funzione in corso...
Clona il repository delle app di esempio sul tuo computer 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/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 in corso...
Per il deployment della funzione che viene eseguita quando (o Slack) esegui una richiesta HTTP POST all'endpoint della funzione, esegui il comando seguente 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 da te creata in precedenza.
Node.js
gcloud functions deploy kgSearch \ --runtime nodejs16 \Per specificare la versione di Node.js preferita, puoi utilizzare i seguenti valori per il flag
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
:
nodejs16
(consigliato)nodejs14
nodejs12
nodejs10
Python
gcloud functions deploy kg_search \ --runtime python39 \Puoi utilizzare i seguenti valori per il flag
--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 Python preferita:
python310
(anteprima)python39
(consigliato)python38
python37
Go
gcloud functions deploy KGSearch \ --runtime go116 \Puoi utilizzare i seguenti valori per il flag
--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 Go preferita:
go116
(consigliato)go113
go111
Java
gcloud functions deploy java-slack-function \ --entry-point functions.SlackSlashCommand \ --runtime java11 \ --memory 512MB \Puoi utilizzare i seguenti valori per il flag
--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 Java preferita:
java17
(anteprima)java11
(consigliato)
C#
gcloud functions deploy csharp-slack-function \ --entry-point SlackKnowledgeGraphSearch.Function \ --runtime dotnet3 \
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
Ruby
gcloud functions deploy kg_search --runtime ruby30 \Per specificare la versione di Ruby preferita, puoi utilizzare i seguenti valori per il flag
--trigger-http \
--set-env-vars "SLACK_SECRET=YOUR_SLACK_SIGNING_SECRET
,KG_API_KEY=YOUR_KG_API_KEY
" \
--allow-unauthenticated
--runtime
:
ruby30
(consigliato)ruby27
ruby26
PHP
gcloud functions deploy searchKnowledgeGraph --runtime php74 \Puoi utilizzare i seguenti valori per il flag
--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 PHP preferita:
php81
(anteprima)php74
(consigliato)
Configurazione dell'applicazione
Dopo aver eseguito il deployment della funzione, devi creare un comando Slash Slash che invii la query alla Funzione Cloud ogni volta che viene attivato il comando:
Crea un'app Slack per ospitare il tuo comando Slash. Associalo a un team Slack in cui hai le autorizzazioni per installare le integrazioni.
Vai a Comandi slash e fai clic sul pulsante Crea nuovo comando.
Inserisci
/kg
come nome del comando.Inserisci l'URL per il comando:
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
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
è l'area geografica in cui viene eseguito il deployment della funzione Cloud 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 abilitare l'applicazione per l'area di lavoro.
Il comando Slash Slash dovrebbe essere disponibile 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 (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 entrata verificando l'intestazione
X-Slack-Signature
fornita da Slack:
Node.js
Python
Go
Java
C#
Ruby
PHP
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 rich formattato che verrà mostrato all'utente:
Node.js
Python
Go
Java
C#
Ruby
PHP
Timeout API Slack
L'API Slack prevede che la tua funzione risponda entro 3 secondi dalla ricezione di una richiesta webhook.
Generalmente i comandi di questo tutorial richiedono meno di tre secondi per rispondere. Per i comandi a lunga esecuzione, ti consigliamo di configurare una funzione per le richieste di push (incluse le 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 invia i risultati allo response_url
di Slack.
Utilizzo del comando Slash
Digita il comando nel tuo 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 Cloud Console, vai alla pagina Gestisci risorse.
- Nell'elenco dei progetti, seleziona il progetto da 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 kgSearch
Python
gcloud functions delete kg_search
Go
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 Cloud Functions da Google Cloud Console.