Data Transmission Service:Tutorial: Integrating with a Dify knowledge base

Step 1: Create and populate your knowledge base

First, you need to create a knowledge base in RAGFlow and upload the documents that will serve as the foundation for your RAG application.

1. Log on to the RAGFlow page.

2. Create a knowledge base.

   1. In the upper-right corner of the page, click Create Knowledge Base.

   2. In the Create Knowledge Base dialog box, enter the Name of the knowledge base.

   3. Click OK.

   4. Configure the knowledge base based on your actual requirements, and then click Save.

3. Upload files to the knowledge base.

   1. On the Dataset page of the knowledge base, select Add File > Local File.

   2. In the Upload File dialog box, select and upload the prepared local file.

   3. Select Parse When Creating.

   4. Click OK.

Step 2: Connect RAGFlow to DMS Dify

Now, you'll configure Dify to recognize your RAGFlow knowledge base as an external data source.

1. Go to the Knowledge Base page of DMS.

   Note

   For access methods, contact the DMS help desk.

2. Add an external knowledge base API.

   1. On the right side of the page, click External Knowledge Base API.

   2. Click Add External Knowledge Base API.

   3. Configure the external knowledge base API information.

      Parameter	Description
      Name	We recommend that you enter a business-meaningful name for easy identification later.
      API Endpoint	The API address of the DTS RAGFlow knowledge base, in the format of http://<IP>/api/v1/dify. Note <IP> needs to be replaced with the connection address of the DTS RAGFlow knowledge base. To use the Internal Knowledge Base Address, add the IPv4 CIDR block of the vSwitch where DMS Dify is located to the IP whitelist of the DTS RAGFlow knowledge base. To use the External Knowledge Base Address, add the Internet egress address of DMS Dify to the IP whitelist of the DTS RAGFlow knowledge base.
      API Key	The API key of the RAGFlow knowledge base. Note For information about how to obtain the API key, see Get the API key of the RAGFlow knowledge base.

   4. Click Save.

3. Connect to the external knowledge base.

   1. On the right side of the page, click on the External Knowledge Base API panel.

   2. In the Create Knowledge Base card, click Connect External Knowledge Base.

   3. Configure the external knowledge base information.

      Parameter	Description
      External Knowledge Base Name	We recommend that you enter a business-meaningful external knowledge base name for easy identification later.
      Knowledge Base Description (optional)	Enter the description of the external knowledge base for easy identification later.
      External Knowledge Base API	Select the external knowledge base API added in Step 2.
      External Knowledge Base ID	Enter the ID of the external knowledge base. Note For information about how to obtain the ID, see Get the ID of the RAGFlow knowledge base.
      Retrieval Settings	Based on your actual requirements, set Top K and Score Threshold.

   4. Click Connect.

      A card with the name specified in External Knowledge Base Name appears on the Knowledge Base page of DMS.

Step 3: Build your AI applications

With the knowledge base connected, you can now use it to build an LLM-powered application, such as a chat assistant, in the DMS console.

Get the connection address

1. Go to the RAGFlow knowledge base list page for the destination region.

   1. Log on to the Data Transmission Service (DTS) console.

   2. In the navigation pane on the left, click Data preparation.

   3. In the upper-left corner of the page, select the region where your data preparation instance is located.

   4. Click the RAGFlow Knowledge Base tab.

2. In the Actions column of the target RAGFlow knowledge base, click Manage.

3. In the Connection Address section, obtain the Internal Knowledge Base Address or External Knowledge Base Address.

Get the API key of the RAGFlow knowledge base

1. Log on to the RAGFlow page.

2. In the navigation pane on the left, click API.

3. On the right side of RAGFlow API, click API KEY.

4. In the API KEY dialog box, click Create New Key.

5. Click to record the token.

Get the ID of the RAGFlow knowledge base

1. Log on to the RAGFlow page.

2. On the Knowledge Base page, click the target knowledge base.

3. In the URL of the current page, record the ID of the knowledge base.

   Note

   The information after id= is the ID of the knowledge base.

Create and use a chat assistant application

1. Create a chat assistant application.

   1. On the Knowledge Base page of DMS, click the Studio tab.

   2. Click Chat Assistant.

   3. In the Create Application card, click Create Blank Application.

   4. Configure the application information.

      Parameter	Description
      Select Application Type	Select Chat Assistant.
      Application Name & Icon	Enter the name of the chat assistant application and set an icon.
      Description (optional)	Enter the description of the chat assistant application for easy identification later.

   5. Click Create.

2. Click the created chat assistant application.

3. Orchestrate the chat assistant application.

   1. Based on your actual requirements, enter the Prompt.

   2. In the Knowledge Base section, click Add.

   3. Select the external knowledge base configured in Step 3, and click Add.

   4. Based on your actual requirements, configure Retrieval Settings, and click Save.

   5. In the upper-right corner of the page, select the model that the chat assistant application needs to use.

4. In the Chat With Robot text box, enter your question for testing.