Confluence

The Confluence Source Connector allows you to integrate Confluence as a data source for your pipelines. This guide explains the configuration options available when setting up a Confluence connector.

Before you begin

Before starting, you'll need:

• The API token for your Confluence account.

• Your Confluence account's email address.

• Your Confluence domain.

If you don't have a Confluence API token created yet, check out our guide How to Create a Confluence API token.

Configure the Connector

To configure a connector to your Confluence instance:

1. Click Source Connectors from the main menu.

2. Click New Source Connector from the Source Connectors page.

3. Select the Confluence card.

   

   Confluence Card
4. Enter the integration name, your Confluence username, API token, and domain, and one or more Confluence spaces for your pipeline to pull data from, then click Create Confluence Integration.

   

   Confluence Parameters

The following table outlines the fields available when configuring a Confluence source for use within a Retrieval-Augmented Generation (RAG) pipeline.

Field	Description	Required
Name	The integration's name.	Yes
Username	The username (email address) of the Confluence user to run as.	Yes
API Token	The Confluence API token.	Yes
Domain	The URL for your Confluence installation. Ex. vectorize.atlassian.net.	No
Spaces	One or more Confluence spaces to pull data from. Allowed formats: - Space name (ex. "RAG Pipelines" - Space key (ex. "RP") -Space ID	Yes

You can retrieve a Confluence space id via cURL:

curl -u {your_email}:{your_api_token} \
-X GET "https://{your_confluence_domain}/wiki/rest/api/space/{space_key}" \
-H "Accept: application/json"

The first field in the response will be the id:

{
  "id":163842,
  "key":"~222033f69c08a86a9975faa48852e4c88b5f67"
  …

Configuring the Confluence Connector in a RAG Pipeline

You can think of the Confluence connector as having two parts to it. The first is authorization with your API token. This part is re-usable across pipelines and allows you to connect to this same service account in different pipelines without providing the credentials every time.

The second part is the configuration that's specific to your RAG Pipeline. This allows you to optionally specify a root folder in your Confluence space to pull data from, as opposed to pulling data from the entire space.

Configuring Confluence for RAG Pipeline

What's next?

• If you haven't yet built a connector to your vector database, go to Configuring Vector Database Connectors and select the platform you prefer to use for storing output vectors.

  OR

• If you're ready to start producing vector embeddings from your input data, head to Pipeline Basics. Select your new connector as the data source to use it in your pipeline.