Skip to main content
Version: DEV

Retrieval component

A component that retrieves information from specified datasets.

Scenarios​

A Retrieval component is essential in most RAG scenarios, where information is extracted from designated knowledge bases before being sent to the LLM for content generation.

Configurations​

Click on a Retrieval component to open its configuration window.

Input​

The Retrieval component relies on input variables to specify its data inputs (queries). Click + Add variable in the Input section to add the desired input variables. There are two types of input variables: Reference and Text.

  • Reference: Uses a component's output or a user input as the data source. You are required to select from the dropdown menu:
    • A component ID under Component Output, or
    • A global variable under Begin input, which is defined in the Begin component.
  • Text: Uses fixed text as the query. You are required to enter static text.

Similarity threshold​

RAGFlow employs a combination of weighted keyword similarity and weighted vector cosine similarity during retrieval. This parameter sets the threshold for similarities between the user query and chunks stored in the datasets. Any chunk with a similarity score below this threshold will be excluded from the results.

Defaults to 0.2.

Keyword similarity weight​

This parameter sets the weight of keyword similarity in the combined similarity score. The total of the two weights must equal 1.0. Its default value is 0.7, which means the weight of vector similarity in the combined search is 1 - 0.7 = 0.3.

Top N​

This parameter selects the "Top N" chunks from retrieved ones and feed them to the LLM.

Defaults to 8.

Rerank model​

Optional

If a rerank model is selected, a combination of weighted keyword similarity and weighted reranking score will be used for retrieval.

WARNING

Using a rerank model will significantly increase the system's response time.

Tavily API key​

Optional

Enter your Tavily API key here to enable Tavily web search during retrieval. See here for instructions on getting a Tavily API key.

Use knowledge graph​

Whether to use knowledge graph(s) in the specified knowledge base(s) during retrieval for multi-hop question answering. When enabled, this would involve iterative searches across entity, relationship, and community report chunks, greatly increasing retrieval time.

Knowledge bases​

Optional

Select the knowledge base(s) to retrieve data from.

  • If no knowledge base is selected, meaning conversations with the agent will not be based on any knowledge base, ensure that the Empty response field is left blank to avoid an error.
  • If you select multiple knowledge bases, you must ensure that the knowledge bases (datasets) you select use the same embedding model; otherwise, an error message would occur.

Empty response​

  • Set this as a response if no results are retrieved from the knowledge base(s) for your query, or
  • Leave this field blank to allow the chat model to improvise when nothing is found.
WARNING

If you do not specify a knowledge base, you must leave this field blank; otherwise, an error would occur.

Examples​

Explore our customer service agent template, where the Retrieval component (component ID: Search product info) is used to search the dataset and send the Top N results to the LLM:

  1. Click the Agent tab at the top center of the page to access the Agent page.
  2. Click + Create agent on the top right of the page to open the agent template page.
  3. On the agent template page, hover over the Customer service card and click Use this template.
  4. Name your new agent and click OK to enter the workflow editor.
  5. Click on the Retrieval component to display its Configuration window.