Configure o Openflow Connector para Slack¶

Pré-requisitos¶

1. Certifique-se de ter revisado Openflow Connector para Slack.

2. Certifique-se de ter configurado o Openflow.

Configure um aplicativo Slack¶

Configure um aplicativo Slack em seu espaço de trabalho do Slack. É necessário um administrador do Slack para configurar o acesso ao espaço de trabalho Slack. Isso é feito criando ou fornecendo credenciais para um aplicativo Slack e instalando o aplicativo no espaço de trabalho e nos canais do Slack. Você pode criar um aplicativo Slack usando a configuração JSON:

1. Atualize o manifesto JSON. Copie o texto do manifesto JSON abaixo. Altere as propriedades de nome e nome de exibição de EXAMPLE_NAME_CHANGE_THIS para o nome desejado de seu aplicativo Slack. Recomenda-se usar o mesmo nome e mesmo nome de exibição para seu aplicativo.

   {
       "display_information": {
           "name": "EXAMPLE_NAME_CHANGE_THIS"
       },
       "features": {
           "bot_user": {
               "display_name": "EXAMPLE_NAME_CHANGE_THIS",
               "always_online": false
           }
       },
       "oauth_config": {
           "scopes": {
               "bot": [
                   "channels:history",
                   "channels:read",
                   "groups:history",
                   "groups:read",
                   "im:history",
                   "im:read",
                   "mpim:history",
                   "mpim:read",
                   "users.profile:read",
                   "users:read",
                   "users:read.email",
                   "files:read",
                   "app_mentions:read",
                   "reactions:read"
               ]
           }
       },
       "settings": {
           "event_subscriptions": {
               "bot_events": [
                   "message.channels",
                   "message.groups",
                   "message.im",
                   "message.mpim",
                   "reaction_added",
                   "reaction_removed",
                   "file_created",
                   "file_deleted",
                   "file_change"
               ]
           },
           "interactivity": {
               "is_enabled": true
           },
           "org_deploy_enabled": false,
           "socket_mode_enabled": true,
           "token_rotation_enabled": false
       }
   }
   

   Copy

2. Crie um aplicativo do Slack na página Aplicativos.

   1. Na página Seus aplicativos, selecione Criar novo aplicativo.

   2. Selecione De um manifesto.

   3. Selecione o Workspace onde você desenvolverá o aplicativo. Você poderá [distribuir seu aplicativo](https://api.slack.com/distribution) para outros espaços de trabalho posteriormente, se desejar.

   4. Copie o arquivo JSON do manifesto atualizado da etapa 1.

3. Gere um token no nível do aplicativo. Você precisa criar um token no nível do aplicativo mesmo após usar o JSON do manifesto. Em Informações básicas, role até a seção Tokens no nível do aplicativo e clique no botão para gerar um [token no nível do aplicativo](https://api.slack.com/concepts/token-types#app). Inclua o escopo connections:write no token.

4. Instale e autorize o aplicativo.

   1. Retorne à seção Informações básicas da página de gerenciamento de aplicativos.

   2. Instale seu aplicativo selecionando o botão Instalar no espaço de trabalho.

   3. Você será encaminhado ao fluxo OAuth do Slack. Selecione Permitir na tela seguinte.

   Se quiser adicionar seu aplicativo a um espaço de trabalho diferente do seu, essas etapas precisarão ser executadas por um usuário desse espaço de trabalho. Após a instalação, volte para a página OAuth e permissões. Você verá um token de acesso em Tokens OAuth. Os tokens de acesso representam as permissões delegadas ao seu aplicativo pelo usuário instalador. Mantenha-o seguro e protegido. Evite verificá-los no controle de versão público. Em vez disso, acesse-os por meio de uma variável de ambiente.

5. Adicione o aplicativo aos canais. Seu aplicativo ainda não é membro de nenhum canal, portanto, escolha um canal para adicionar algumas mensagens de teste e use o comando /invite para convidar seu aplicativo. Por exemplo, /invite @Grocery Reminders.

Configure as regras de entrada necessárias¶

Um administrador Snowflake deve seguir o guia de saída para aplicar regras de saída ao ponto de extremidade https://slack.com/api e ativar a saída de WebSocket em wss://wss.slack.com. Isso é feito com mais facilidade adicionando uma regra para habilitar a saída no domínio “slack.com”.

Configure a conta Snowflake¶

Como administrador de conta Snowflake, execute as seguintes tarefas:

1. Crie uma nova função ou use uma função existente e conceda a Privilégios de banco de dados.

2. Crie um novo usuário de serviço Snowflake com o tipo SERVICE.

3. Conceda ao usuário do serviço Snowflake a função que você criou nas etapas anteriores.

4. Configure com a autenticação de pares de chaves para o usuário do Snowflake SERVICE da etapa 2.

5. A Snowflake recomenda enfaticamente essa etapa. Configure um gerenciador de segredos compatível com o Openflow, por exemplo, AWS, Azure e Hashicorp, e armazene as chaves públicas e privadas no armazenamento de segredos.

   Nota

   Se, por algum motivo, você não quiser usar um gerenciador de segredos, será responsável por proteger os arquivos de chave pública e chave privada usados para autenticação de pares de chaves de acordo com as políticas de segurança de sua organização.

   1. Depois que o gerenciador de segredos estiver configurado, determine como você se autenticará nele. No AWS, é recomendável que você use a função de instância EC2 associada ao Openflow, pois dessa forma nenhum outro segredo precisa ser mantido.

   2. No Openflow, configure um provedor de parâmetros associado a esse gerenciador de segredos, no menu de três traços no canto superior direito. Navegue até Controller Settings » Parameter Provider e, em seguida, busque os valores dos parâmetros.

   3. Nesse momento, todas as credenciais podem ser referenciadas com os caminhos de parâmetros associados e nenhum valor sensível precisa ser mantido no Openflow.

6. Se qualquer outro usuário Snowflake precisar de acesso aos documentos e tabelas brutos ingeridos pelo conector (por exemplo, para processamento personalizado no Snowflake), conceda a esses usuários a função criada na etapa 1.

7. Designar um warehouse para o conector usar. Comece com o menor tamanho de warehouse e, em seguida, experimente o tamanho, dependendo do número de tabelas sendo replicadas e da quantidade de dados transferidos. Os números de tabelas grandes normalmente são mais bem dimensionados com warehouses multicluster, em vez de warehouses maiores.

Caso de uso 1: ingestão apenas do conteúdo do Slack¶

Use a definição do conector para:

• Realize análises personalizadas nos dados ingeridos do Slack (sem processamento do Cortex Search).

• Faça a ingestão de mensagens do Slack, reações, anexos de arquivos e listas de membros no Snowflake e mantenha-os atualizados.

Caso de uso 2: ingestão do conteúdo do Slack e ativação do Cortex¶

Use a definição do conector para:

• Prepare os dados do Slack para a pesquisa conversacional com o Snowflake Cortex.

• Garanta que os controles de acesso ao canal do Slack sejam respeitados nos resultados de pesquisa.

Ativação de ACLs de canal privado¶

Não são necessárias etapas adicionais além de convidar o aplicativo Slack para cada canal privado. O conector atualiza automaticamente a lista de membros e a armazena na tabela de membros a cada intervalo de Atualizar membros do Slack.

Consultar o Cortex Search Service¶

Depois que o caso de uso 2 estiver em execução e o serviço Cortex Search tiver sido criado, você poderá consultá-lo da seguinte forma:

SELECT PARSE_JSON(
  SNOWFLAKE.CORTEX.SEARCH_PREVIEW(
    '<openflow_db>.<openflow_schema>.<<SLACK_CORTEX_SEARCH>',
    '{
      "query": "What is my vacation carry over policy?",
      "columns": ["text","channel","ts","username"],
      "filter": {"@contains": {"memberemails": "alice@example.com"}},
      "limit": 10
    }'
  )
)['results'] AS results;

Colunas pesquisáveis comuns

text, type, subtype, channel, user, username, connectorId, workspaceId, ts, threadTs

Exemplo: consulte um assistente de AI para obter informações sobre recursos humanos (HR)

Você pode usar o Cortex Search para consultar um assistente de AI para que os funcionários conversem sobre as últimas postagens do Slack. As mensagens pesquisadas podem vir de canais informativos do Slack, como general ou it-help.

SELECT PARSE_JSON(
     SNOWFLAKE.CORTEX.SEARCH_PREVIEW(
          '<cortex_db>.<cortex_schema>.<cortex_search_service_name>',
          '{
             "query": "What is my vacation carry over policy?",
             "columns": ["text", "channel", “ts”,”username”],
             "filter": {"@contains": {"memberemails": "<user_emailID>"} },
             "limit": 1
          }'
     )
 )['results'] AS results

import snowflake.snowpark as snowpark
from snowflake.snowpark import Session
from snowflake.core import Root

def main(session: snowpark.Session):

   root = Root(session)

   # fetch service
   my_service = (root
     .databases["<cortex_db>"]
     .schemas["<cortex_schema>"]
     .cortex_search_services["<cortex_search_service_name>"]
   )

   # query service
   resp = my_service.search(
     query="What is my vacation carry over policy?",
     columns = ["text", "channel", "ts","username"],
     filter = {"@contains": {"memberemails": "<user_emailID>"} },
     limit=1
     )
   return (resp.to_json())

curl --location "https://<account_url>/api/v2/databases/<cortex_db>/schemas/<cortex_schema>/cortex-search-services/<cortex_search_service_name>" \
     --header 'Content-Type: application/json' \
     --header 'Accept: application/json' \
     --header "Authorization: Bearer <CORTEX_SEARCH_JWT>" \
     --data '{
         "query": "What is my vacation carry over policy?",
         "columns": ["text", "channel"],
         "limit": 1
     }'

{
  "results" : [ {
  "channel" : "dev notes",
  "text" : "Answer to the question asked."
  } ]
}