Quip

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

Você pode se conectar Amazon Kendra à sua fonte de dados do Quip usando o Amazon Kendra console e a QuipConfigurationAPI.

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

Atributos compatíveis

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

• Mapeamentos de campos

• Controle de acesso do usuário

• Filtros de inclusão/exclusão

• Nuvem privada virtual (VPC)

Pré-requisitos

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

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 AWS Secrets Manager segredo. Consulte a documentação do Quip sobre autenticação para obter mais informações.

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

• 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 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 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 IAM função ou segredo existente, poderá usar o console para criar uma nova IAM função e Secrets Manager segredo ao conectar sua fonte de dados do Quip 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 Quip, você deve fornecer os detalhes necessários da sua fonte de dados do Quip para que Amazon Kendra possa acessar seus dados. Se você ainda não configurou o Quip para Amazon Kendra, consultePré-requisitos.

Console

Para se conectar Amazon Kendra ao Quip

1. Faça login no AWS Management Console e abra o Amazon Kendra console.

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 Conector Quip e, em seguida, escolha Adicionar conector. Se estiver usando a versão 2 (se aplicável), escolha o conector 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 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.

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. AWS Secrets Manager segredo — Escolha um segredo existente ou crie um novo Secrets Manager segredo para armazenar suas 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 ao seu nome secreto.

         2. Token do Quip — Insira o acesso pessoal do Quip configurado no Quip.

      2. Adicione e salve seu 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. 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.

   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 rastrear uma pasta raiz, incluindo todas as subpastas e documentos dentro dela, adicione o ID da pasta raiz. Para rastrear subpastas específicas, adicione as 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 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.

   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 que você deseja mapear para Amazon Kendra indexar.

   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 se conectar Amazon Kendra ao Quip

Você deve especificar o seguinte usando a QuipConfiguration API:

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

• 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 Quip. A senha deve conter uma estrutura JSON com as seguintes chaves:

  {
      "accessToken": "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 Quip e. 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 rastrear uma pasta raiz, incluindo todas as subpastas e documentos dentro dela, insira o ID da pasta raiz. Para rastrear subpastas específicas, adicione as IDs de subpastas específicas.

• Anexos, salas de bate-papo, comentários de arquivos — Escolha se deseja incluir o rastreamento de anexos, conteúdo de salas de bate-papo e comentários de arquivos.

• Filtragem de contexto do usuário e controle de acesso —Amazon Kendra rastreia a lista de controle de acesso (ACL) de seus documentos, se você tiver 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 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.

Saiba mais

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

• Pesquise conhecimento em documentos do Quip com a pesquisa inteligente usando o conector do Quip para Amazon Kendra