Atributos compatíveis Pré-requisitos Instruções de conexão Saiba mais

Slack

O Slack é um aplicativo de comunicação empresarial que permite aos usuários enviar mensagens e anexos por meio de vários canais públicos e privados. Você pode usar Amazon Kendra para indexar seus canais públicos e privados do Slack, enviar bots e arquivar mensagens, arquivos e anexos, mensagens diretas e em grupo. Também é possível selecionar conteúdo específico para filtrar.

nota

Amazon Kendra agora suporta um conector Slack atualizado.

O console foi atualizado automaticamente para você. Todos os novos conectores que você criar no console usarão a arquitetura atualizada. Se você usa a API, agora deve usar o TemplateConfigurationobjeto em vez do SlackConfiguration objeto para configurar seu conector.

Os conectores configurados usando o console antigo e a arquitetura de API continuarão funcionando conforme configurados. No entanto, você não poderá editá-los ou atualizá-los. Se você quiser editar ou atualizar a configuração do conector, deverá criar um novo conector.

Recomendamos migrar o fluxo de trabalho do conector para a versão atualizada. O suporte para conectores configurados usando a arquitetura mais antiga está programado para terminar em junho de 2024.

Você pode se conectar Amazon Kendra à sua fonte de dados do Slack usando o Amazon Kendra console ou a TemplateConfigurationAPI.

Para solucionar problemas do conector da fonte Amazon Kendra de dados do Slack, consulteSolucionar problemas de origens de dados.

Atributos compatíveis

Amazon Kendra O conector de fonte de dados do Slack é compatível com os seguintes recursos:

Mapeamentos de campos
Controle de acesso do usuário
Filtros de inclusão/exclusão
Sincronizações de conteúdo completas e incrementais
Nuvem privada virtual (VPC)

Pré-requisitos

Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Slack, faça essas alterações no Slack e AWS nas contas.

No Slack, verifique se você:

Configurei um token OAuth do usuário do Slack Bot ou um token OAuth do usuário do Slack. Você pode escolher qualquer um dos tokens para se conectar Amazon Kendra à sua fonte de dados do Slack. É necessário um token para ser usado como suas credenciais de autenticação. Consulte a documentação do Slack sobre tokens de acesso para obter mais informações.

nota
Se você usar o token do bot como parte das credenciais do Slack, não poderá indexar mensagens diretas, mensagens de grupo e deverá adicionar o token do bot ao canal que deseja indexar.

nota
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).
Anotou o ID da equipe do Slack Workspace a partir do URL da página principal do Slack Workspace. Por exemplo, https://app.slack.com/client/T0123456789/... e que T0123456789 é o ID da equipe.

Foram adicionados os seguintes escopos/permissões do Oauth:

Escopo do token do usuário	Escopo do token de bot
channels:history channels:read emoji:read files:read groups:history groups:read im:history im:read mpim:history mpim:read team:read users.profile:read users:read usuários:read.email	channels:history canais:gerenciar channels:read conversations.connect:manage conversations.connect:read files:read groups:history groups:read im:history im:read mpim:history mpim:read reações:ler team:read usergroups:read users.profile:read users:read usuários:read.email

Verifique se cada documento é exclusivo no Slack e outras fontes de dados que você planeja usar para o mesmo índice. Cada fonte de dados que você deseja usar para um índice não deve conter o mesmo documento em todas as fontes de dados. Os IDs de documentos são globais para um índice e devem ser exclusivos por índice.

No seu Conta da AWS, verifique se você tem:

Criou um Amazon Kendra índice e, se estiver usando a API, anotei o ID do índice.
Criou uma IAM função para sua fonte de dados e, se estiver usando a API, anotei o ARN da IAM função.

nota
Se você alterar o tipo de autenticação e as credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
Armazenou suas credenciais de autenticação do Slack em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.

nota
Recomendamos que você atualize ou alterne regularmente as credenciais e as senhas. Forneça somente o nível de acesso necessário para sua própria segurança. Não recomendamos que você reutilize credenciais e senhas nas fontes de dados e nas versões 1.0 e 2.0 do conector (quando for aplicável).

Se você não tiver uma IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e um novo Secrets Manager segredo ao conectar sua fonte de dados do Slack a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e Secrets Manager segredo existentes e um ID de índice.

Instruções de conexão

Para se conectar Amazon Kendra à sua fonte de dados do Slack, você deve fornecer os detalhes necessários da sua fonte de dados do Slack para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Slack para Amazon Kendra, consultePré-requisitos.

Console

Para se conectar Amazon Kendra ao Slack

Faça login no AWS Management Console e abra o Amazon Kendra console.
No painel de navegação esquerdo, escolha Índices e, em seguida, escolha o índice que deseja usar na lista de índices.

nota
Você pode escolher definir ou editar as configurações de Controle de acesso do usuário em Configurações do índice.
Na página Introdução, escolha Adicionar fonte de dados.
Na página Adicionar fonte de dados, escolha Conector Slack e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Slack com a tag “V2.0".
Na página Especar detalhes da fonte de dados, insira as seguintes informações:
1. Em Nome e descrição, em Nome da fonte de dados: insira um nome para a fonte de dados. Você pode incluir hífens, mas não espaços.
2. (Opcional) Descrição: insira uma descrição opcional para a fonte de dados.
3. Em Idioma padrão — Escolha um idioma para filtrar seus documentos para o índice. A menos que você especifique o contrário, o idioma padrão é o inglês. O idioma especificado nos metadados do documento substitui o idioma selecionado.
4. Em Tags, em Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
5. Escolha Próximo.
Na página Definir seção e segurança, insira as informações a seguir:
1. Para o ID da equipe do espaço de trabalho do Slack — o ID da equipe do seu espaço de trabalho do Slack. Você pode encontrar o ID da sua equipe no URL da página principal do seu espaço de trabalho do Slack. Por exemplo, https://app.slack.com/client/T0123456789/... e que T0123456789 é o ID da equipe.
2. Autorização — Ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, se você tiver uma ACL e quiser usá-la para controle de acesso. A ACL especifica quais documentos os usuários e grupos podem acessar. As informações da ACL são usadas para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Para obter mais informações, consulte Filtrar o contexto do usuário.
3. AWS Secrets Manager segredo — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas credenciais de autenticação do Slack. Se optar por criar uma nova senha, uma janela secreta do AWS Secrets Manager será aberta.
  1. Insira as seguintes informações em Criar uma janela de senha do AWS Secrets Manager :
    1. Senha: um nome para sua senha. O prefixo 'AmazonKendra-Slack-' é adicionado automaticamente ao seu nome secreto.
    2. Para o token do Slack — insira os valores da credencial de autenticação que você configurou no Slack.
  2. Salve e adicione seu segredo.
4. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.
5. Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
6. IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar as credenciais do repositório e indexar o conteúdo.
  
  nota
  IAM as funções usadas para índices não podem ser usadas para fontes de dados. Se você não tiver certeza se uma função existente é usada para um índice ou perguntas frequentes, escolha Criar uma nova função para evitar erros.
7. Escolha Próximo.
Na página Configurar configurações de sincronização, insira as seguintes informações:
1. Selecione o tipo de conteúdo — Selecione as entidades ou os tipos de conteúdo do Slack que você deseja rastrear. Você pode escolher entre todos os canais, canais públicos, canais privados, mensagens em grupo e mensagens privadas.
2. Selecione a data de início do rastreamento — insira a data em que você deseja começar a rastrear seu conteúdo.
3. Para configuração adicional — escolha incluir mensagens de bots e arquivadas e use padrões de expressão regular para incluir ou excluir determinado conteúdo.
  
  nota
  Se você optar por incluir tanto os IDs quanto os nomes dos canais, o conector do Amazon Kendra Slack priorizará os IDs dos canais em vez dos nomes dos canais.
  Se você optar por incluir determinadas mensagens privadas e em grupo, o conector do Amazon Kendra Slack ignorará todas as mensagens privadas e em grupo e rastreará somente as mensagens privadas e de grupo que você especificar.
4. Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização.
  - Sincronização completa: indexe todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados for sincronizada com seu índice.
  - Sincronização nova, modificada e excluída: indexe somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
5. Em Cronograma de execução de sincronização, em Frequência — Escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar seu índice.
6. Escolha Próximo.
Na página Definir mapeamentos de campo, insira as seguintes informações:
1. Campos de fonte de dados padrão — Selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para o seu índice.
2. Adicionar campo: para adicionar campos de fonte de dados personalizados, crie um nome de campo de índice para mapear e o tipo de dados do campo.
3. Escolha Próximo.
Na página Revisar e criar, verifique se as informações inseridas estão corretas e selecione Adicionar fonte de dados. Você também pode optar por editar as informações a partir desta página. Sua fonte de dados aparecerá na página Fontes de dados depois que a fonte de dados for adicionada com sucesso.

API

Para se conectar Amazon Kendra ao Slack

Você deve especificar um JSON do esquema da fonte de dados usando a API TemplateConfiguration. Você deve fornecer as seguintes informações:

Fonte de dados — especifique o tipo de fonte de dados como SLACK quando você usa o esquema TemplateConfigurationJSON. Também especifique a fonte de dados como TEMPLATE quando você chama a CreateDataSourceAPI.
ID da equipe do espaço de trabalho do Slack: o ID da equipe do Slack que você copiou do URL da página principal do Slack.
Desde a data — a data para começar a rastrear os dados da sua equipe do Slack Workspace. A data deve seguir este formato: yyyy-mm-dd.
Modo de sincronização — especifique como Amazon Kendra você deve atualizar seu índice quando o conteúdo da fonte de dados for alterado. Quando você sincroniza sua fonte de dados Amazon Kendra pela primeira vez, todo o conteúdo é rastreado e indexado por padrão. Você deve executar uma sincronização completa dos seus dados se a sincronização inicial falhar, mesmo que você não escolha a sincronização completa como opção de modo de sincronização. Escolha uma das seguintes opções:
- FORCED_FULL_CRAWLpara indexar todo o conteúdo de forma atualizada, substituindo o conteúdo existente sempre que sua fonte de dados é sincronizada com seu índice.
- FULL_CRAWLpara indexar somente conteúdo novo, modificado e excluído sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
- CHANGE_LOGpara indexar somente conteúdo novo e modificado sempre que sua fonte de dados for sincronizada com seu índice. Amazon Kendra pode usar o mecanismo da sua fonte de dados para rastrear alterações no conteúdo e indexar o conteúdo que foi alterado desde a última sincronização.
Rastreador de identidade — especifique se deseja ativar o rastreador Amazon Kendra de identidade. O rastreador de identidade usa as informações da lista de controle de acesso (ACL) dos seus documentos para filtrar os resultados da pesquisa com base no acesso do usuário ou do grupo aos documentos. Se você tiver uma ACL para seus documentos e optar por usá-la, também poderá optar por ativar o rastreador de identidade para configurar a filtragem de contexto Amazon Kendra do usuário dos resultados da pesquisa. Caso contrário, se o rastreador de identidade estiver desativado, todos os documentos poderão ser pesquisados publicamente. Se você quiser usar o controle de acesso para seus documentos e o rastreador de identidade estiver desativado, você também pode usar a PutPrincipalMappingAPI para carregar informações de acesso de usuários e grupos para filtragem de contexto do usuário.
Nome de recurso secreto da Amazon (ARN) — Forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contenha as credenciais de autenticação da sua conta do Slack. A senha deve conter uma estrutura JSON com as seguintes chaves:
```
{
    "slackToken": "token"
}
```
IAM role — Especifique RoleArn quando você liga CreateDataSource para fornecer uma IAM função com permissões para acessar seu Secrets Manager segredo e chamar as APIs públicas necessárias para o conector Slack e. Amazon Kendra Para obter mais informações, consulte Funções para o IAM das fontes de dados do Slack.

Você também pode adicionar os seguintes recursos opcionais:

Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para ter mais informações, consulte Configurando Amazon Kendra para usar um Amazon VPC.
Canais específicos — filtre por canais públicos ou privados e especifique determinados canais pelo ID.
Tipos de canais e mensagens — Se você Amazon Kendra deve indexar seus canais públicos e privados, suas mensagens diretas e de grupo e suas mensagens de bot e arquivadas. Se você usar o token do bot como parte das credenciais do Slack, adicione o token do bot ao canal que deseja indexar. Você não pode indexar mensagens diretas e mensagens de grupo usando um token de bot.
Retrospectiva: você pode escolher configurar um lookBack parâmetro para que o conector do Slack rastreie o conteúdo atualizado ou excluído até um número específico de horas antes da última sincronização do conector.
Filtros de inclusão e exclusão — especifique se deseja incluir ou excluir determinado conteúdo do Slack. Se você usar o token do bot como parte das credenciais do Slack, adicione o token do bot ao canal que deseja indexar. Você não pode indexar mensagens diretas e mensagens de grupo usando um token de bot.

nota
A maioria das fontes de dados usa padrões de expressão regular, que são padrões de inclusão ou exclusão chamados de filtros. Se você especificar um filtro de inclusão, somente o conteúdo que corresponda ao filtro de inclusão será indexado. Qualquer documento que não corresponda ao filtro de inclusão não é indexado. Se especificar um filtro de inclusão e exclusão, os documentos que corresponderem ao filtro de exclusão não serão indexados, mesmo que correspondam ao filtro de inclusão.
Mapeamentos de campo: escolha mapear os campos de fonte de dados do Slack para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapear campos de fonte de dados.

nota
O campo do corpo do documento ou o corpo do documento equivalente para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo do corpo do documento na fonte de dados para o nome do campo de índice_document_body. Todos os demais campos são opcionais.

Para ver uma lista de outras chaves JSON importantes a serem configuradas, consulte o Esquema do modelo do Slack.

Saiba mais

Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Slack, consulte:

Descubra o conhecimento nos espaços de trabalho do Slack com a pesquisa inteligente usando o conector do Slack Amazon Kendra

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Especificando documentos com uma consulta

Zendesk