Amazon Kendra não está mais aberto a novos clientes. Para obter recursos semelhantes a Amazon Kendra, explore as bases de conhecimento da Amazon Bedrock. Saiba mais.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
Conector Salesforce V2.0
O Salesforce é uma ferramenta de gerenciamento de relacionamento com o cliente (CRM) para gerenciar equipes de suporte, vendas e marketing. Você pode usar Amazon Kendra para indexar seus objetos padrão do Salesforce e até mesmo objetos personalizados.
O conector de fonte de dados do Amazon Kendra Salesforce é compatível com as seguintes edições do Salesforce: Developer Edition e Enterprise Edition.
O V1.0 SalesforceConfiguration conector/API do Salesforce terminou em 2023. Recomendamos migrar para ou usar o V2.0 TemplateConfiguration conector/API do Salesforce.
Para solucionar problemas com seu conector de fonte de dados do Amazon Kendra Salesforce, consulteSolucionar problemas de origens de dados.
Recursos compatíveis
Amazon Kendra O conector de fonte de dados do Salesforce oferece suporte aos seguintes recursos:
-
Mapeamentos de campos
-
Controle de acesso do usuário
-
Inclusion/exclusion filtros
-
Sincronizações completas e incrementais de conteúdo
-
Nuvem privada virtual (VPC)
Pré-requisitos
Antes de poder usar Amazon Kendra para indexar sua fonte de dados do Salesforce, faça essas alterações em seu Salesforce e AWS em suas contas.
No Salesforce, verifique se você:
Para fluxo de credenciais do cliente (recomendado):
-
Crie um aplicativo cliente externo no Salesforce com o OAuth ativado:
-
Em Configuração, escolha Aplicativos, Gerenciador de aplicativos e escolha Novo aplicativo cliente externo.
-
Habilite os escopos do OAuth: gerencie os dados do usuário por meio de APIs (api) e execute solicitações a qualquer momento (refresh_token, offline_access).
-
Na seção Fluxos de autenticação e aprimoramentos do aplicativo cliente externo, ative o fluxo de credenciais do cliente.
-
Configure um usuário Run As para o contexto de execução. Por exemplo: Executar como (nome de usuário).
-
Observe a chave do consumidor (client_id) e o segredo do consumidor (client_secret).
-
Copie a URL do Meu domínio da sua instância do Salesforce (por exemplo,https://<orgDomain>.my.salesforce.com). Para encontrar o URL do Meu domínio, em Configuração, na caixa Busca rápida, insira Meu domínio e selecione Meu domínio. Para Client Credentials Flow, https://login.salesforce.com e não https://test.salesforce.com são suportados.
Para Username-Password Flow (legado — descontinuado no inverno de 2027):
-
Criou uma conta administrativa do Salesforce e anotou o nome de usuário e a senha que você usa para se conectar ao Salesforce.
-
Copiou o token de segurança do Salesforce associado à conta usada para se conectar ao Salesforce.
-
Criou uma conta do Salesforce Connected App com o OAuth ativado e copiou a chave do consumidor (ID do cliente) e a senha do consumidor (senha do cliente) atribuídos ao Salesforce Connected App. O ID do cliente e o segredo do cliente são usados como suas credenciais de autenticação armazenadas em um AWS Secrets Manager segredo. Para obter mais informações, consulte a documentação do Salesforce sobre aplicativos conectados.
É recomendável atualizar ou alternar regularmente suas credenciais e 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).
-
Copiou o URL da instância do Salesforce que você deseja indexar. Normalmente, é https://<company>.salesforce.com/. O servidor deve estar executando um aplicativo conectado ao Salesforce.
-
Adicionou credenciais ao seu servidor Salesforce para um usuário com acesso somente para leitura ao Salesforce clonando o ReadOnly perfil e adicionando as permissões Exibir todos os dados e Gerenciar artigos. Essas credenciais identificam o usuário que está fazendo a conexão e o aplicativo conectado ao Salesforce que Amazon Kendra se conecta a.
Para ambos os fluxos:
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.
Se você alterar seu tipo de autenticação e suas credenciais, deverá atualizar sua IAM função para acessar a ID AWS Secrets Manager secreta correta.
-
Armazenou suas credenciais de autenticação do Salesforce em uma senha do AWS Secrets Manager e, se estiver usando a API, anotou o ARN da senha.
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 um 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 Salesforce a. Amazon Kendra Se você estiver usando a API, deverá fornecer o ARN de uma IAM função e um Secrets Manager segredo existentes e um ID de índice.
Instruções de conexão
Para se conectar Amazon Kendra à sua fonte de dados do Salesforce, você deve fornecer os detalhes necessários da sua fonte de dados do Salesforce para que ela Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Salesforce para Amazon Kendra verPré-requisitos.
- Console
-
Para se conectar Amazon Kendra ao Salesforce:
-
Faça login no Console de gerenciamento da AWS 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.
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 o Conector do Salesforce e Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector Salesforce com a tag V2.0 "”.
-
Na página Especar detalhes da fonte de dados, insira as seguintes informações:
-
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.
-
(Opcional) Descrição: insira uma descrição opcional para a fonte de dados.
-
Em Idioma padrão: escolha um idioma para filtrar os documentos do í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.
-
Em Tags, para Adicionar nova tag — Inclua tags opcionais para pesquisar e filtrar seus recursos ou monitorar seus AWS custos.
-
Escolha Próximo.
-
Na página Definir seção e segurança, insira as informações a seguir:
-
URL do Salesforce: insira o URL da instância do site do Salesforce que você deseja indexar.
-
Autorização: ative ou desative as informações da lista de controle de acesso (ACL) para seus documentos, caso tenha uma ACL e queira usá-la para controle de acesso. A ACL especifica quais documentos 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.
-
Insira uma senha existente ou, se você criar uma nova senha, uma janela secreta da AWS
Secrets Manager será aberta.
-
Autenticação — Escolha seu tipo de autenticação:
-
Fluxo de credenciais do cliente (recomendado) — usa somente client_id e client_secret para integrações de servidor a servidor.
-
Username-Password Flow (Legacy) — usa nome de usuário, senha, token de segurança, chave do consumidor e segredo do consumidor. Obsoleto pela Salesforce no inverno de 2027.
-
Nome do segredo: um nome para o segredo. O prefixo 'AmazonKendra-Salesforce-' é adicionado automaticamente ao seu nome secreto.
-
Para fluxo de credenciais do cliente:
-
Chave do consumidor — A ID do cliente do seu aplicativo Salesforce External Client
-
Segredo do consumidor — O segredo do cliente do seu aplicativo Salesforce External Client
-
URL de autenticação — Sua URL do Meu domínio (por exemplo,
https://<orgDomain>.my.salesforce.com/services/oauth2/token).
https://login.salesforce.come não https://test.salesforce.com são compatíveis com esse fluxo.
-
Para Username-Password Flow:
-
Nome de usuário — Seu nome de usuário de administrador do Salesforce
-
Senha — Sua senha de administrador do Salesforce
-
Token de segurança — O token de segurança da sua conta do Salesforce
-
Chave do consumidor — A ID do cliente do seu aplicativo Salesforce Connected
-
Segredo do consumidor — O segredo do cliente do seu aplicativo Salesforce Connected
-
URL de autenticação — Para o Salesforce Developer Edition, use https://login.salesforce.com/services/oauth2/token nossa URL de login do Meu domínio (por exemplo,
https://MyCompany.my.salesforce.com). Para o Salesforce Sandbox Edition, use https://test.salesforce.com/services/oauth2/token nossa URL de login do Meu domínio (por exemplo,
MyDomainName--SandboxName.sandbox.my.salesforce.com).
-
Escolha Salvar autenticação.
-
Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.
-
Crawler de identidade: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de 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 crawler 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 PutPrincipalMapping API para carregar informações de acesso de usuários e grupos para filtragem de contexto de usuário.
-
IAM função — Escolha uma IAM função existente ou crie uma nova IAM função para acessar suas credenciais do repositório e o conteúdo do índice.
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.
-
Escolha Próximo.
-
Na página Configurações de sincronização, insira as seguintes informações:
-
Para Rastrear anexos: selecione para rastrear todos os objetos do Salesforce.
-
Em Objetos padrão, Objetos padrão com anexos e Objeto padrão sem anexo e Artigos de conhecimento: selecione entidades do Salesforce ou tipos de conteúdo dos quais você deseja fazer crawling.
-
Você deve fornecer informações de configuração para indexar pelo menos um dos objetos padrão, artigos de conhecimento ou feeds do Chatter. Se você optar por rastrear Artigos de conhecimento, deverá especificar os tipos de artigos de conhecimento a serem indexados. Você pode escolher textos publicados, arquivados, rascunhos e anexos.
Filtro Regex: especifique um padrão regex para incluir itens específicos do catálogo.
-
Para Configuração adicional:
-
Informações sobre ACL: todas as listas de controle de acesso são incluídas por padrão. Desmarcar uma lista de controle de acesso tornará públicos todos os arquivos dessa categoria.
-
Padrões Regex: adicionar padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.
Modo de sincronização: escolha como você deseja atualizar o índice quando o conteúdo da fonte de dados for alterado. Ao sincronizar a fonte de dados com o Amazon Kendra
pela primeira vez, é feito crawling de e indexação de todo o conteúdo por padrão. Você deve executar uma sincronização completa dos seus dados se o processo inicial falhar, mesmo que não escolha essa opção de modo de sincronização.
-
Sincronização total: indexa novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o índice.
-
Sincronização nova e modificada: indexe 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 de conteúdo e indexar conteúdo que foi alterado desde a última sincronização.
-
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 de conteúdo e indexar conteúdo que foi alterado desde a última sincronização.
-
Escolha Próximo.
-
Na página Definir mapeamentos de campo, insira as seguintes informações:
-
Para artigos de conhecimento padrão, anexos de objetos padrão e mapeamentos de campo adicionais sugeridos, selecione entre os campos de fonte de dados padrão Amazon Kendra gerados que você deseja mapear para seu índice.
É necessário um mapeamento de _document_body. Você não pode alterar o mapeamento entre o campo Salesforce ID e o campo Amazon Kendra
_document_id . Você pode mapear qualquer campo do Salesforce para os campos de índice Amazon Kendra reserved/default do título ou corpo do documento.
Se você associar qualquer campo do Salesforce aos campos de título e corpo do documento do Amazon Kendra, este usará os dados desses campos nas respostas da pesquisa.
-
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.
-
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 Salesforce
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 SALESFORCEV2 ao usar o esquema JSON TemplateConfiguration. Também especifique a fonte de dados como TEMPLATE quando você chama a API CreateDataSource.
-
URL do host: especifique o URL do host da instância do Salesforce.
-
Modo de sincronização: especifique como o Amazon Kendra
deve atualizar o índice quando o conteúdo da fonte de dados é 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 dados se a sincronização inicial falhar, mesmo que não escolha essa opção de modo de sincronização. Escolha uma das seguintes opções:
-
FORCED_FULL_CRAWL para indexar novamente todo o conteúdo, substituindo o já existente sempre que a fonte de dado é sincronizada com o í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 de conteúdo e indexar 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 de conteúdo e indexar conteúdo que foi alterado desde a última sincronização.
-
Nome secreto de recurso da Amazon (ARN) — forneça o nome de recurso da Amazon (ARN) de um Secrets Manager segredo que contém as credenciais de autenticação da sua conta do Salesforce. A senha deve conter uma estrutura JSON com as seguintes chaves:
{
"authenticationUrl": "OAUTH endpoint that Amazon Kendra connects to get an OAUTH token",
"consumerKey": "Application public key generated when you created your Salesforce application",
"consumerSecret": "Application private key generated when you created your Salesforce application",
"password": "Password associated with the user logging in to the Salesforce instance",
"securityToken": "Token associated with the user account logging in to the Salesforce instance",
"username": "User name of the user logging in to the Salesforce instance"
}
-
IAM função — 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 Salesforce e. Amazon Kendra Para obter mais informações, consulte Funções do IAM para as fontes de dados do Salesforce.
Você também pode adicionar os seguintes recursos opcionais:
-
Nuvem privada virtual (VPC): especifique a VpcConfiguration quando ao chamar CreateDataSource. Para obter mais informações, consulte Configurando Amazon Kendra para usar um Amazon VPC.
-
Filtros de inclusão e exclusão — você pode especificar se deseja incluir ou excluir determinados documentos, contas, campanhas, casos, contatos, leads, oportunidades, soluções, tarefas, grupos, conversas e arquivos de entidades personalizadas.
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.
-
Crawler de identidade: especifique se deseja ativar o crawler de identidade do Amazon Kendra. O crawler de identidade usa as informações da lista de controle de acesso (ACL) de 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 crawler 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 PutPrincipalMapping API para carregar informações de acesso de usuários e grupos para filtragem de contexto de usuário.
-
Mapeamentos de campo: escolha mapear os campos de fonte de dados do Salesforce para os campos de índice do Amazon Kendra . Para obter mais informações, consulte Mapeamento de campos de fonte de dados.
O campo do corpo do documento ou o equivalente do corpo do documento para seus documentos é obrigatório Amazon Kendra para pesquisar seus documentos. Você deve mapear o nome do campo de corpo do documento na fonte de dados para o nome do campo de índice _document_body. Todos os demais campos são opcionais.
É necessário um mapeamento de _document_body. Você não pode alterar o mapeamento entre o campo Salesforce ID e o campo Amazon Kendra
_document_id . Você pode mapear qualquer campo do Salesforce para os campos de índice Amazon Kendra reserved/default do título ou corpo do documento.
Se você associar qualquer campo do Salesforce aos campos de título e corpo do documento do Amazon Kendra, este usará os dados desses campos nas respostas da pesquisa.
Consulte uma lista de outras chaves JSON importantes a serem configuradas, em Esquema do modelo do Salesforce.
Saiba mais
Para saber mais sobre a integração Amazon Kendra com sua fonte de dados do Salesforce, consulte:
Observações
-
Quando as listas de controle de acesso (ACLs) estão habilitadas, a opção “Sincronizar somente conteúdo novo ou modificado” não está disponível devido às limitações de API do Salesforce. Em vez disso, recomendamos usar os modos “Sincronização completa” ou “Sincronização de conteúdo novo, modificado ou excluído” ou desativar as ACLs se precisar usar esse modo de sincronização.