Quip - Amazon Kendra
Recursos compatíveisPré-requisitosInstruções de conexãoSaiba mais

Quip

nota

O conector do Quip permanece totalmente compatível para os clientes existentes até 31 de maio de 2026. Embora esse conector não esteja mais disponível para novos usuários, os atuais podem continuar a usá-lo sem interrupção. Estamos continuamente expandindo nosso portfólio de conectores para oferecer soluções mais escaláveis e personalizáveis. Para futuras integrações, recomendamos explorar o Amazon Kendra Custom Connector Framework[1], projetado para atender a uma ampla variedade de casos de uso empresariais com maior flexibilidade.

O Quip é um software colaborativo de produtividade que oferece recursos de criação de documentos em tempo real. Você pode usar o Amazon Kendra para indexar pastas, arquivos, comentários de arquivos, salas de bate-papo e anexos do Quip.

Você pode conectar Amazon Kendra à fonte de dados do Quip usando o console doAmazon Kendra ou a API ou a QuipConfiguration.

Para solucionar problemas do conector da fonte de dados do Quip do Amazon Kendra, consulte Solucionar problemas de origens de dados.

Recursos compatíveis

o conector de fonte de dados do Quip e do Amazon Kendra oferece suporte aos seguintes recursos:

  • Mapeamentos de campos

  • Controle de acesso do usuário

  • Filtros de inclusão/exclusão

  • Nuvem privada virtual (VPC)

Pré-requisitos

Antes que você possa usar o Amazon Kendra para indexar a fonte de dados do Quip, faça essas alterações no Quip e nas contas da AWS.

No Quip, verifique se você:

  • Tem uma conta do Quip com permissões administrativas.

  • Criou credenciais de autenticação do Quip que incluem um token de acesso pessoal. O token é usado como sua credencial de autenticação armazenada em um segredo do AWS Secrets Manager. Consulte a documentação do Quip sobre autenticação para obter mais informações.

    nota

    É 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 domínio do site do Quip. Por exemplo, https://quip-company.quipdomain.com/browse em que quipdomain é o domínio.

  • Verifique se cada documento é exclusivo no Quip e em 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 Conta da AWS, verifique se você:

  • Criou um índice do Amazon Kendra e, se estiver usando a API, anotou o ID do índice.

  • Criou uma função do IAM para a fonte de dados e, se estiver usando a API, anotou o ARN da função do IAM.

    nota

    Se você alterar o tipo de autenticação e as credenciais, deverá atualizar a função do IAM para acessar o ID secreto correto do AWS Secrets Manager.

  • Armazenou suas credenciais de autenticação do Quip 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 função ou senha existente do IAM, poderá usar o console para criar uma nova função do IAM e um nova senha do Secrets Manager ao conectar a fonte de dados do Quip ao Amazon Kendra. Se você estiver usando a API, deverá fornecer o ARN de uma função da IAM e a senha Secrets Manager existentes e um ID de índice.

Instruções de conexão

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

Console

Para conectar o Amazon Kendra ao Quip

  1. Faça login no Console de gerenciamento da AWS e abra o console do Amazon Kendra.

  2. 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.

  3. Na página Introdução, escolha Adicionar fonte de dados.

  4. Na página Adicionar fonte de dados, escolha o Conector do Quip e selecione Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o Conector do Quip com a tag “V2.0”.

  5. 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 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.

    4. Em Tags, em Adicionar nova tag: inclua tags opcionais para pesquisar e filtrar os recursos ou monitorar os custos da AWS.

    5. Escolha Próximo.

  6. Na página Definir seção e segurança, insira as informações a seguir:

    1. Nome de domínio do Quip: insira o Quip que você copiou da conta do Quip.

    2. Segredo do AWS Secrets Manager: escolha um segredo existente ou crie um segredo do Secrets Manager para armazenar as credenciais de autenticação do Quip. 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-Quip-” é adicionado automaticamente à senha.

        2. Token do Quip: insira o acesso pessoal do Quip configurado no Quip.

      2. Adicione e salve o segredo.

    3. Nuvem privada virtual (VPC): você pode escolher usar uma VPC. Nesse caso, você deve adicionar sub-redes e grupos de segurança da VPC.

    4. Função do IAM: escolha uma função do IAM existente ou crie uma nova função do IAM para acessar as credenciais do repositório e indexar o conteúdo.

      nota

      Funções do IAM usadas para índices não podem ser usados 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.

    5. Escolha Próximo.

  7. Na página Configurar configurações de sincronização, insira as seguintes informações:

    1. Adicionar IDs de pasta do Quip para rastrear: os IDs da pasta do Quip que você deseja rastrear.

      nota

      Para fazer crawling de uma pasta raiz, incluindo todas as subpastas e documentos dentro dela, adicione o ID da pasta raiz. Para realizar crawling em subpastas específicas, adicione os IDs de subpastas específicas.

    2. Configuração adicional (tipos de conteúdo): insira os tipos de conteúdo que você deseja rastrear.

    3. Padrões Regex: os padrões de expressão regular para incluir ou excluir determinados arquivos. Você pode adicionar até 100 padrões.

    4. Em Programação de execução de sincronização, em Frequência: escolha com que frequência sincronizar o conteúdo da fonte de dados e atualizar o índice

    5. Escolha Próximo.

  8. Na página Definir mapeamentos de campo, insira as seguintes informações:

    1. Selecione entre os campos da fonte de dados padrão gerados do Amazon Kendra que você deseja mapear para o índice do .

    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.

  9. 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 conectar o Amazon Kendra ao Quip

Você deve especificar o seguinte usando a API QuipConfiguration:

  • Domínio do site do Quip: por exemplo, https://quip-company.quipdomain.com/browse em que quipdomain é o domínio.

  • Nome do recurso da Amazon (ARN) do segredo: forneça o nome do recurso da Amazon (ARN) de um segredo do Secrets Manager que contenha as credenciais de autenticação criadas na conta do Quip. A senha deve conter uma estrutura JSON com as seguintes chaves:

    {
    "accessToken": "token"
}

  • Função do IAM: especifique o RoleArn ao chamar o CreateDataSource para fornecer uma função do IAM com permissões para acessar a senha do Secrets Manager e chamar as APIs públicas necessárias para o conector do Quip e o Amazon Kendra. Para obter mais informações, consulte Funções do IAM para as fontes de dados do Quip.

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

  • Nuvem privada virtual (VPC): especifique VpcConfiguration como parte da configuração da fonte de dados. Consulte Configuração do Amazon Kendra para usar uma VPC.

  • Filtros de inclusão e exclusão: especifique se deseja incluir ou excluir determinadas arquivos.

    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.

  • Pastas: especifique as pastas e subpastas do Quip que você deseja indexar

    nota

    Para realizar crawling em uma pasta raiz, inclusive todas as subpastas e documentos dentro dela, insira o ID da pasta raiz. Para realizar crawling em subpastas específicas, adicione os IDs de subpastas específicas.

  • Anexos, salas de chat, comentários de arquivos: escolha se deseja incluir crawling de anexos, conteúdo de salas de chat e comentários de arquivos.

  • Filtragem de contexto do usuário e controle de acesso: o Amazon Kendra faz crawling da lista de controle de acesso (ACL) para seus documentos, caso haja uma ACL para seus documentos. 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.

  • Mapeamentos de campo: escolha mapear os campos de fonte de dados do Quip para os campos de índice do Amazon Kendra. Para obter mais informações, consulte Mapeamento de campos de fonte de dados.

    nota

    É obrigatório definir o campo de corpo do documento ou equivalente para que o Amazon Kendra possa 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.

Saiba mais

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