Configurar um repositório de dados do Confluence Cloud

Nesta página, descrevemos como criar um repositório de dados e conectar o Confluence Cloud ao Gemini Enterprise.

Antes de começar

Antes de configurar sua conexão federada do Confluence Cloud, verifique o seguinte:

Conceda o papel de editor do Discovery Engine (roles/discoveryengine.editor). Esse papel é necessário para que o usuário crie o repositório de dados. Para conceder esse papel:
1. No console Google Cloud , acesse a página IAM.
  Acessar IAM
2. Localize a conta de usuário e clique no ícone de editar Editar.
3. Conceda a função Discovery Engine Editor ao usuário. Para mais informações, consulte Papéis e permissões do IAM.
Para aplicar o controle de acesso à fonte de dados e proteger os dados no Google Gemini Enterprise, configure seu provedor de identidade.
Para configurar o repositório de dados do Confluence Cloud, use o novo modelo centralizado de gerenciamento de usuários da Atlassian. Se você estiver usando o modelo original, migre o gerenciamento de usuários antes de continuar. Para mais informações, consulte Função de administrador do site.
Crie um app OAuth 2.0, recebao ID do cliente e a chave secreta e configure as permissões mínimas do aplicativo com o consentimento de um administrador do Confluence Cloud.
Opcional: para recuperar endereços de e-mail de usuários do Confluence Cloud, mesmo quando as configurações restringem a visibilidade do e-mail, instale o app na nuvem User Identity Accessor para Confluence Cloud com privilégios de administrador do site do Confluence e configure para recuperar os endereços de e-mail dos usuários com segurança. Talvez não seja necessário instalar esse app se os endereços de e-mail já estiverem acessíveis publicamente.

Observação: a Atlassian está atualizando elementos da interface do usuário, e alguns elementos mencionados nesta documentação estão sendo renomeados. Por exemplo, Produtos está sendo renomeado como Apps. Para mais informações, consulte Mudança na terminologia da administração da Atlassian de "produtos" para "apps".

Criar repositório de dados do Confluence Cloud

Para criar um repositório de dados do Confluence Cloud, siga estas etapas:

No console Google Cloud , acesse a página Gemini Enterprise.

Gemini Enterprise
Selecionar ou criar um projeto Google Cloud
No menu de navegação, selecione Repositório de dados.
Clique em Criar repositório de dados.
Na seção Origem, pesquise Confluence Cloud e clique em Selecionar.
Na seção Dados:
1. Na seção Modo do conector, selecione Ingestão de dados ou Pesquisa federada como o modo de conexão.
2. Clique em Continuar.
3. Na seção Configurações de autenticação, configure a autenticação com base no modo de conexão escolhido.
  - Se você selecionou Ingestão de dados:
    1. Selecione Credenciais do cliente OAuth 2.0 ou Token de API como o método de autenticação.
    - Se você selecionar Credenciais do cliente OAuth 2.0, insira os seguintes detalhes:
      - ID do cliente: o identificador do seu app OAuth 2.0.
      - Chave secreta do cliente: a chave secreta associada ao seu app OAuth 2.0.
      - URI da instância: o URL de base da sua instância do Confluence Cloud ( por exemplo, https://your-domain.atlassian.net).
      - ID da instância: um identificador exclusivo da sua instância do Confluence Cloud.
    - Se você selecionar Token da API, insira os seguintes detalhes:
      - URI da instância: o URL de base da sua instância do Confluence Cloud ( por exemplo, https://your-domain.atlassian.net).
      - Conta de usuário: o nome de usuário da Atlassian associado ao token da API.
      - Token da API: o token de API gerado na sua conta da Atlassian.
  - Se você selecionou Pesquisa federada:
    1. Digite os seguintes detalhes:
      - ID do cliente: o identificador do seu app OAuth 2.0.
      - Chave secreta do cliente: a chave secreta associada ao seu app OAuth 2.0.
      - URI da instância: o URL de base da sua instância do Confluence Cloud ( por exemplo, https://your-domain.atlassian.net).
    2. Clique em Fazer login e conclua o processo de login da Atlassian.
  Para mais informações sobre credenciais, consulte Configuração do Confluence Cloud.
4. Clique em Continuar.
5. Na seção Destinos, insira o URL do endpoint do Confluence Cloud.
6. Clique em Continuar.
7. Na seção Entidades para sincronizar (se você selecionou Ingestão de dados) ou Entidades para pesquisar (se você selecionou Pesquisa federada):
  1. Selecione todas as entidades necessárias.
  - Se você selecionou Pesquisa federada, prossiga para a próxima etapa.
  - Se você selecionou Ingestão de dados, faça o seguinte:
    1. Opcional: para sincronizar projetos específicos, faça o seguinte:
      1. Clique em Filtrar.
      2. Para filtrar entidades do índice, selecione Excluir do índice ou, para garantir que elas sejam incluídas, selecione Incluir no índice.
      3. Insira as chaves de espaço. Pressione Enter depois de cada tecla de espaço. A chave do espaço é o código exclusivo em um URL do espaço do Confluence, encontrado após /spaces/. Por exemplo, em https://company.atlassian.net/wiki/spaces/ABC/overview, a tecla de espaço é ABC.
      4. Clique em Salvar.
    2. Para configurar a programação de sincronização, faça o seguinte:
      1. Na lista Frequência de sincronização, selecione a frequência.
        
        Para programar sincronizações completas separadas de dados de entidade e identidade, abra o menu na seção Sincronização completa e selecione Opções personalizadas.
      2. Na lista Frequência de sincronização incremental, selecione a opção desejada.
    Para mais informações, consulte Programações de sincronização.
Clique em Continuar.
Na seção Ações:
- Se você selecionou Pesquisa federada:
  1. Em Selecionar ações do Confluence Cloud para ativar, escolha as ações da categoria para ativar no repositório de dados.
- Se você selecionou Ingestão de dados:
  1. Na seção Configurações de autenticação, configure a autenticação com base no modo de conexão escolhido.
  2. Insira os seguintes detalhes de autenticação:
    - ID do cliente: o identificador do seu app OAuth 2.0.
    - Chave secreta do cliente: a chave secreta associada ao seu app OAuth 2.0.
    - URI da instância: o URL de base da sua instância do Confluence Cloud ( por exemplo, https://your-domain.atlassian.net).
    - ID da instância: um identificador exclusivo da sua instância do Confluence Cloud.
    Para mais informações sobre credenciais, consulte Configuração do Confluence Cloud.
  3. Clique em Login e faça login no Confluence Cloud para verificar sua conta.
  4. Clique em Continuar.
  5. Na seção Destinos, insira o URL do endpoint do Confluence Cloud.
  6. Em Selecionar ações do Confluence Cloud para ativar, escolha as ações da categoria para ativar no repositório de dados.
  Observação: se você não adicionar ações nesta etapa, será possível fazer isso depois. Para mais informações, consulte Adicionar ações.
  
  Para conferir e gerenciar a lista de ações, consulte Conferir e gerenciar ações.
Clique em Continuar.
Na seção Configuração:
1. Na lista Multirregional, selecione o local do conector de dados.
2. No campo Nome do conector de dados, insira um nome para o conector.
3. Se você selecionou US ou EU como o local, configure as Configurações de criptografia:
  - Opcional: se você não tiver configurado chaves de região única, clique em Acessar a página de configurações para fazer isso. Para mais informações, consulte Registrar uma chave de região única para conectores de terceiros.
  - Selecione Chave de criptografia gerenciada peloGoogle ou Chave do Cloud KMS.
  - Se você selecionou Chave do Cloud KMS:
    - Na lista Tipo de gerenciamento de chaves, selecione o tipo adequado.
    - Na lista Chave do Cloud KMS, selecione a chave.
  Para mais informações, consulte Chaves de criptografia gerenciadas pelo cliente.
Clique em Continuar.
Na seção Faturamento, selecione Preços gerais ou Preços configuráveis. Para mais informações, consulte Verificar o status de faturamento dos seus projetos e Licenças.
Clique em Criar. O Gemini Enterpriserise cria e exibe os repositórios de dados na página Repositórios de dados.

Na página Repositórios de dados, clique no nome da loja para conferir o status. Depois que o estado do repositório de dados mudar de Criação para Ativo, o repositório de dados do Confluence Cloud estará pronto para uso.

Para um repositório de dados de ingestão criado com o Confluence Cloud, o estado do repositório de dados muda de Criação para Em execução após o início da sincronização. Em seguida, ele muda para Ativo quando a ingestão é concluída, indicando que o repositório de dados está totalmente configurado. Dependendo do volume de dados, a ingestão pode levar várias horas.

Depois de criar o repositório de dados, crie um app, conecte-o ao repositório de dados do Confluence Cloud e autorize o Gemini Enterprise a acessar o Confluence Cloud antes de executar qualquer consulta.

Ativar a sincronização em tempo real para ingestão de dados

A sincronização em tempo real só sincroniza entidades de documento e não sincroniza dados relacionados a entidades de identidade. A tabela a seguir mostra quais eventos de documento são compatíveis com a sincronização em tempo real.

Entidades do Confluence	Criar	Atualizar	Excluir	Alterações de permissão
Espaços
Páginas
Blogs
Anexos
Comentários
Quadros brancos

Ative a sincronização em tempo real 20 minutos após a criação do repositório de dados do Confluence Cloud.

Para ativar a sincronização em tempo real de um repositório de dados do Confluence, siga estas etapas:

Gerar um URL de webhook

Navegue até a página do Gemini Enterprise e, no menu de navegação, clique em Repositórios de dados.
Selecione um repositório de dados do Confluence.
Clique em Ver/editar na linha Sincronização em tempo real.
Na caixa de diálogo Ver e editar parâmetros de sincronização em tempo real, faça o seguinte:
1. Para ativar a sincronização em tempo real, clique no botão Ativar sincronização em tempo real.
2. No campo Chave secreta do cliente, insira um valor de marcador, como clientsecret.
3. Clique em Salvar.
Depois que o status da Sincronização em tempo real mudar para Running, clique em Ver/editar.
Na caixa de diálogo Ver e editar parâmetros de sincronização em tempo real, faça o seguinte:
1. Copie o endereço em Webhook URL.
2. Clique em Fechar.

Inscrever-se em eventos usando a API

Para receber atualizações em tempo real do Confluence, é necessário se inscrever em eventos específicos usando uma solicitação POST. Para fazer chamadas de API, use a mesma conta de administrador usada para configurar a autenticação e as permissões no Confluence ao criar o repositório de dados.

      curl -X POST \
        INSTANCE_URL/wiki/rest/webhooks/1.0/webhook \
        -H "Content-Type: application/json" \
        -u "USERNAME:API_TOKEN" \
        -d '{
          "name": "SUBSCRIPTION_NAME",
          "url": "LISTENER_URL",
          "events": [
            "EVENT_TYPE_1",
            "EVENT_TYPE_2"
          ],
          "active": true
        }'

INSTANCE_URL: o endereço da Web básico do seu site do Atlassian Cloud.
USERNAME: o nome de usuário do Atlassian Cloud.
API_TOKEN: o token de API gerado na sua conta da Atlassian. Para mais informações, consulte Configurar um token de API no Confluence.
SUBSCRIPTION_NAME: um nome exclusivo para sua assinatura de evento.
LISTENER_URL: o URL do webhook copiado do console Google Cloud depois que a sincronização em tempo real (RTS) é ativada no seu repositório de dados.

EVENT_TYPE: os tipos de eventos que você quer assinar. Você pode se inscrever para criar, atualizar e excluir eventos de anexos, postagens do blog, páginas, espaços e comentários.

O usuário pode se inscrever nos seguintes eventos:

space_created
space_updated
page_created
page_updated
attachment_created
attachment_updated
comment_created
comment_updated
blog_created
blog_updated

Exemplo de comando e resultado

curl -X POST \
    https://cymbalgroup.atlassian.net/wiki/rest/webhooks/1.0/webhook \
    -H "Content-Type: application/json" \
    -u "admin1:######" \
    -d '{
      "name": "Cymbal_DCT",
      "events": [
        "attachment_created",
        "attachment_updated"
      ],
      "url": "https://rt-server-a-jx3m2-uw.a.run.app/webhook",
      "active": true
    }'

{
"name": "Cymbal_DCT",
"url": "https://cymbalgroup.atlassian.net/wiki/rest/webhooks/1.0/webhook",
"description": " Webhook for Cymbal DCT group to fetch attachments.",
"excludeBody": false,
"filters": {},
"events": [
    "attachment_created",
    "attachment_updated",
],
"enabled": true,
"self": https://rt-server-a-jx3m2-uw.a.run.app/webhook,
"lastUpdatedUser": "Cymb_389",
"lastUpdatedDisplayName": "Ariel",
"lastUpdated": 1752095647212
}

Códigos de erro da API

Esta tabela lista códigos de erro comuns da API que os usuários encontram ao criar webhooks.

Classe de erro	Código do erro	Mensagem de erro	Solução de problemas
`403`	`FORBIDDEN`	O usuário atual não tem permissão para usar o Confluence.	Verifique se há um token válido de uma conta de administrador e um endpoint de API correto.

Tratamento de dados e execução de consultas

Esta seção descreve como o Gemini Enterprise gerencia sua consulta e as implicações de privacidade do uso do repositório de dados federado.

Execução da consulta

Depois de autorizar o Confluence Cloud e enviar uma consulta de pesquisa para o Gemini Enterprise:

O Gemini Enterprise envia sua consulta de pesquisa diretamente para a API do Atlassian.
O Gemini Enterprise combina os resultados com os de outras fontes de dados conectadas e mostra um resultado da pesquisa abrangente.

Processamento de dados

Ao usar a pesquisa federada de terceiros, as seguintes regras de tratamento de dados são aplicadas:

Sua string de consulta é enviada para o back-end de pesquisa de terceiros (API Atlassian).
Esses terceiros podem associar consultas à sua identidade.
Se várias fontes de dados de pesquisa federada estiverem ativadas, a consulta poderá ser enviada a todas elas.
Depois que os dados chegam ao sistema de terceiros, eles são regidos pelos Termos de Serviço e pelas Políticas de Privacidade desse sistema.

A seguir

Para fornecer uma interface do usuário para consultar seus dados do Confluence Cloud, crie um app e conecte-o ao repositório de dados do Confluence Cloud.
Para conferir e gerenciar a lista de ações, consulte Conferir e gerenciar ações.
Para ver como os resultados da pesquisa aparecem depois que o app é configurado, consulte Receber resultados da pesquisa.
Para ativar alertas para o repositório de dados, consulte Configurar alertas para repositórios de dados de terceiros.