Conexión a Confluence para la base de conocimiento - Amazon Bedrock
Características admitidasRequisitos previosConfiguración de la conexión

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Conexión a Confluence para la base de conocimiento

Atlassian Confluence is es una herramienta colaborativa de administración del trabajo diseñada para compartir, almacenar y trabajar en la planificación de proyectos, el desarrollo de software y la administración de productos. Puede conectarse a la instancia de Confluence para su base de conocimientos de Amazon Bedrock mediante la Consola de administración de AWS de Amazon Bedrock o la API de CreateDataSource (consulte los SDK compatibles con Amazon Bedrock y AWS CLI).

nota

El conector del origen de datos de Confluence está en versión preliminar y sujeta a cambios.

Los orígenes de datos de Confluence no admiten datos multimodales, como tablas, gráficos, diagramas u otras imágenes.

Amazon Bedrock admite la conexión a instancias de Confluence Cloud. Actualmente, solo el almacén vectorial de Amazon OpenSearch sin servidor se puede usar con este origen de datos.

Existen límites en cuanto al número de archivos y MB por archivo que pueden rastrearse. Consulte Cuotas de las bases de conocimientos.

Características admitidas

  • Detección automática de los campos principales del documento

  • Filtros de inclusión o exclusión de contenido

  • El contenido incremental se sincroniza para añadir, actualizar o eliminar contenido

  • Autenticación OAuth 2.0, autenticación con token de la API de Confluence

Requisitos previos

En Confluence, asegúrese de:

  • Tomar nota de la dirección URL de la instancia de Confluence. Por ejemplo, para Confluence Cloud, https://example.atlassian.net. La URL de Confluence Cloud debe ser la URL básica y terminar en .atlassian.net.

  • Configure las credenciales de autenticación básicas que contengan un nombre de usuario (correo electrónico de la cuenta de administrador) y una contraseña (token de API de Confluence) para permitir que Amazon Bedrock se conecte a su instancia de Confluence Cloud. Para obtener más información sobre cómo crear un token de la API de Confluence, consulte Manage API tokens for your Atlassian account en el sitio web de Atlassian.

  • (Opcional) Configure una aplicación OAuth 2.0 con las credenciales de una clave de aplicación, un secreto de aplicación, un token de acceso y un token de actualización. Para obtener más información, consulte OAuth 2.0 apps en el sitio web de Atlassian.

  • Debe activar ciertos permisos de lectura o ámbitos para que la aplicación de OAuth 2.0 se conecte a Confluence.

    API de Confluence:

    • offline_access

    • read:content:confluence: muestra contenido detallado

    • read:content-details:confluence: muestra los detalles del contenido

    • read:space-details:confluence: muestra los detalles del espacio

    • read:audit-log:confluence: muestra los registros de auditoría

    • read:page:confluence: muestra las páginas

    • read:attachment:confluence: muestra y descarga los archivos adjuntos de contenido

    • read:blogpost:confluence: muestra las publicaciones de blog

    • read:custom-content:confluence: muestra el contenido personalizado

    • read:comment:confluence: muestra los comentarios

    • read:template:confluence: muestra las plantillas de contenido

    • read:label:confluence: muestra las etiquetas

    • read:watcher:confluence: muestra los observadores de contenido

    • read:relation:confluence: muestra las relaciones entre entidades

    • read:user:confluence: muestra los detalles del usuario

    • read:configuration:confluence: muestra la configuración de Confluence

    • read:space:confluence: muestra los detalles del espacio

    • read:space.property:confluence: muestra las propiedades del espacio

    • read:user.property:confluence: muestra las propiedades del usuario

    • read:space.setting:confluence: muestra la configuración del espacio

    • read:analytics.content:confluence: muestra el análisis de contenido

    • read:content.property:confluence: muestra las propiedades del contenido

    • read:content.metadata:confluence: muestra los resúmenes de contenido

    • read:inlinetask:confluence: muestra las tareas

    • read:task:confluence: muestra las tareas

    • read:whiteboard:confluence: muestra las pizarras

    • read:app-data:confluence: lee los datos de la aplicación

    • read:folder:confluence: muestra las carpetas

    • read:embed:confluence: muestra los datos de Smart Link

En la cuenta de AWS, asegúrese de:

  • Almacenar sus credenciales de autenticación en un secreto de AWS Secrets Manager y tomar nota del nombre de recurso de Amazon (ARN) del secreto. Siga las instrucciones de la sección Configuración de la conexión que aparecen en esta página para incluir los pares clave-valor que deben incluirse en el secreto.

  • Incluir los permisos necesarios para conectarse al origen de datos en la política de roles y permisos de AWS Identity and Access Management (IAM) de su base de conocimientos. Para obtener más información sobre los permisos necesarios para que este origen de datos se añada a su rol de IAM en la base de conocimientos, consulte Permisos para acceder a los orígenes de datos.

nota

Si utiliza la consola, puede ir a AWS Secrets Manager para agregar el secreto o usar un secreto existente como parte del paso de configuración del origen de datos. El rol de IAM con todos los permisos necesarios se puede crear automáticamente como parte de los pasos de la consola para crear una base de conocimientos. Una vez que haya configurado el origen de datos y otras configuraciones, el rol de IAM con todos los permisos necesarios se aplicará a su base de conocimientos específica.

Le recomendamos que actualice o modifique con regularidad las credenciales y el secreto. Por su propia seguridad, proporcione solo el nivel de acceso necesario. No recomendamos reutilizar las credenciales y los secretos en distintos orígenes de datos.

Configuración de la conexión

Para conectarse a la instancia de Confluence, debe proporcionar la información de configuración necesaria para que Amazon Bedrock pueda acceder a sus datos y rastrearlos. También debe seguir los Requisitos previos.

En esta sección se incluye un ejemplo de configuración para este origen de datos.

Para obtener más información sobre la detección de campos de documento, los filtros de inclusión o exclusión, la sincronización incremental, las credenciales de autenticación secretas y su funcionamiento, seleccione lo siguiente:

El conector del origen de datos detecta y rastrea automáticamente todos los campos de metadatos principales de sus documentos o del contenido. Por ejemplo, el conector del origen de datos puede rastrear el equivalente del cuerpo del documento de sus documentos, el título del documento, la fecha de creación o modificación del documento u otros campos principales que puedan aplicarse a los documentos.

importante

Si el contenido incluye información confidencial, Amazon Bedrock podría responder utilizando información confidencial.

Puede aplicar operadores de filtrado a los campos de metadatos para mejorar aún más la relevancia de las respuestas. Por ejemplo, documente “epoch_modification_time” o el número de segundos transcurridos desde el 1 de enero de 1970 hasta que se actualizó el documento por última vez. Puede filtrar por los datos más recientes, donde “epoch_modification_time” es mayor que un número determinado. Para obtener más información sobre los operadores de filtrado que puede aplicar a los campos de metadatos, consulte Metadatos y filtrado.

Puede incluir o excluir el rastreo de determinado contenido. Por ejemplo, puede especificar un patrón de exclusión de prefijo o expresión regular para evitar el rastreo de cualquier archivo que contenga la palabra “privado” en el nombre del archivo. También puede especificar un patrón de exclusión de prefijo o expresión regular para incluir determinadas entidades o tipos de contenido. Si especifica un filtro de inclusión y exclusión y ambos coinciden con un documento, el filtro de exclusión tiene prioridad y el documento no se rastrea.

Un ejemplo de patrón de expresiones regulares para excluir o filtrar archivos PDF que contienen la palabra “privado” en el nombre del archivo: ".*private.*\\.pdf".

Puede aplicar filtros de inclusión o exclusión a los siguientes tipos de contenido:

  • Space: tecla de espacio única

  • Page: título de la página principal

  • Blog: título principal del blog

  • Comment: comentarios que pertenecen a una determinada página o blog. Especifique Re: Page/Blog Title.

  • Attachment: nombre del archivo asociado con su extensión

El conector del origen de datos rastrea el contenido nuevo, modificado y eliminado cada vez que el origen de datos se sincroniza con la base de conocimientos. Amazon Bedrock puede utilizar el mecanismo del origen de datos para realizar un seguimiento de los cambios en el contenido y rastrear el contenido modificado desde la última sincronización. Al sincronizar el origen de datos con la base de conocimientos por primera vez, todo el contenido se rastrea de forma predeterminada.

Para sincronizar el origen de datos con la base de conocimientos, utilice la API de StartIngestionJob o seleccione su base de conocimientos en la consola y seleccione Sincronizar en la sección de información general del origen de datos.

importante

Todos los datos que sincronice desde el origen de datos estarán disponibles para cualquier persona que tenga permisos bedrock:Retrieve para obtenerlos. Esto también puede incluir los datos con permisos de orígenes de datos controlados. Para obtener más información, consulte Permisos de la base de conocimientos.

(Si utiliza la autenticación básica) Las credenciales de autenticación secretas en AWS Secrets Manager deben incluir los siguientes pares clave-valor:

  • username: dirección de correo electrónico del usuario administrador de la cuenta de Atlassian

  • password: token de la API de Confluence

(Si utiliza la autenticación OAuth 2.0) Las credenciales de autenticación secretas en AWS Secrets Manager deben incluir los siguientes pares clave-valor:

  • confluenceAppKey: clave de aplicación

  • confluenceAppSecret: secreto de aplicación

  • confluenceAccessToken: token de acceso a la aplicación

  • confluenceRefreshToken: token de actualización de la aplicación

nota

El token de acceso a OAuth 2.0 de Confluence tiene un período de caducidad predeterminado de 60 minutos. Si este token caduca mientras se está sincronizando el origen de datos (trabajo de sincronización), Amazon Bedrock utilizará el token de actualización proporcionado para regenerar este token. Esta regeneración actualiza los tokens de acceso y de actualización. Para mantener los tokens actualizados desde el trabajo de sincronización actual al siguiente trabajo de sincronización, Amazon Bedrock necesita permisos de escritura o colocación para las credenciales secretas como parte del rol de IAM en la base de conocimientos.

nota

Su secreto en AWS Secrets Manager debe usar la misma región que su base de conocimiento.

Console
Conexión de una instancia de Confluence a la base de conocimiento

  1. Siga los pasos que se indican en Creación de una base de conocimiento conectándola a un origen de datos de Bases de conocimiento de Amazon Bedrock y elija Confluence como el origen de datos.

  2. Proporcione un nombre y una descripción opcional para el origen de datos.

  3. Proporcione la URL de la instancia de Confluence. Por ejemplo, para Confluence Cloud, https://example.atlassian.net. La URL de Confluence Cloud debe ser la URL básica y terminar en .atlassian.net.

  4. En la sección Configuración avanzada, si lo desea, puede configurar lo siguiente:

    • Clave de KMS para el almacenamiento de datos transitorios: puede cifrar los datos transitorios y, al mismo tiempo, convertirlos en incrustaciones con la Clave administrada de AWS predeterminada o con su propia clave de KMS. Para obtener más información, consulte Cifrado del almacenamiento de datos transitorios durante la ingesta de datos.

    • Política de eliminación de datos: puede eliminar las incrustaciones vectoriales de su origen de datos que están almacenadas en el almacén de vectores de forma predeterminada u optar por conservar los datos del almacén de vectores.

  5. Proporcione la información de autenticación para conectarse a la instancia de Confluence:

    • Para la autenticación básica, vaya a AWS Secrets Manager para añadir sus credenciales de autenticación secretas o utilice un nombre de recurso de Amazon (ARN) existente para el secreto que ha creado. El secreto debe contener la dirección de correo electrónico del usuario administrador de la cuenta de Atlassian como nombre de usuario y un token de la API de Confluence en lugar de una contraseña. Para obtener más información sobre cómo crear un token de la API de Confluence, consulte Manage API tokens for your Atlassian account en el sitio web de Atlassian.

    • Para la autenticación OAuth 2.0, vaya a AWS Secrets Manager para añadir sus credenciales de autenticación secretas o utilice un nombre de recurso de Amazon (ARN) existente para el secreto que ha creado. El secreto debe contener la clave de la aplicación de Confluence, el secreto de la aplicación, el token de acceso y el token de actualización. Para obtener más información, consulte OAuth 2.0 apps en el sitio web de Atlassian.

  6. (Opcional) En la sección Análisis y fragmentación del contenido, puede personalizar la forma de analizar y fragmentar los datos. Para obtener más información sobre estas personalizaciones, consulte los siguientes recursos:

  7. Elija usar patrones de filtros o expresiones regulares para incluir o excluir determinado contenido. De lo contrario, se rastreará todo el contenido estándar.

  8. Continúe eligiendo un modelo de incrustación y un almacén de vectores. Para ver los pasos restantes, regrese a Creación de una base de conocimiento conectándola a un origen de datos de Bases de conocimiento de Amazon Bedrock y continúe desde allí después de conectar el origen de datos.

API

El siguiente es un ejemplo de una configuración para conectarse a Confluence Cloud para la base de conocimientos de Amazon Bedrock. El origen de datos se configura mediante la API con la AWS CLI o un SDK compatible, como Python. Después de llamar a CreateKnowledgeBase, llame a CreateDataSource para crear el origen de datos con la información de conexión en dataSourceConfiguration.

Para obtener información sobre las personalizaciones que puede aplicar a la ingesta mediante la inclusión del campo vectorIngestionConfiguration opcional, consulte Personalización de la ingesta de un origen de datos.

AWS Command Line Interface

aws bedrock create-data-source \
 --name "Confluence Cloud/SaaS connector" \
 --description "Confluence Cloud/SaaS data source connector for Amazon Bedrock to use content in Confluence" \
 --knowledge-base-id "your-knowledge-base-id" \
 --data-source-configuration file://confluence-bedrock-connector-configuration.json \
 --data-deletion-policy "DELETE" \
 --vector-ingestion-configuration '{"chunkingConfiguration":[{"chunkingStrategy":"FIXED_SIZE","fixedSizeChunkingConfiguration":[{"maxTokens":"100","overlapPercentage":"10"}]}]}'

confluence-bedrock-connector-configuration.json
{
    "confluenceConfiguration": {
        "sourceConfiguration": {
            "hostUrl": "https://example.atlassian.net",
            "hostType": "SAAS",
            "authType": "OAUTH2_CLIENT_CREDENTIALS",
            "credentialsSecretArn": "arn:aws::secretsmanager:your-region:secret:AmazonBedrock-Confluence"
        },
        "crawlerConfiguration": {
            "filterConfiguration": {
                "type": "PATTERN",
                "patternObjectFilter": {
                    "filters": [
                        {
                            "objectType": "Attachment",
                            "inclusionFilters": [
                                ".*\\.pdf"
                            ],
                            "exclusionFilters": [
                                ".*private.*\\.pdf"
                            ]
                        }
                    ]
                }
            }
        }
    },
    "type": "CONFLUENCE"
}