Skip to content

docs: remove kb ingestion and rename kb retrieval #12065

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mendonk merged 1 commit into from
Mar 5, 2026
Merged

docs: remove kb ingestion and rename kb retrieval #12065

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/docs/Components/knowledge-retrieval.mdx → docs/docs/Components/knowledge-base.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Knowledge Retrieval
slug: /knowledge-retrieval
title: Knowledge Base
slug: /knowledge-base
---

import Icon from "@site/src/components/icon";
Expand All @@ -9,11 +9,11 @@ import PartialKbSummary from '@site/docs/_partial-kb-summary.mdx';

<PartialKbSummary />

The **Knowledge Retrieval** component reads from an existing knowledge base using semantic search.
The **Knowledge Base** component reads from an existing knowledge base using semantic search.

The output is a [`DataFrame`](/data-types#dataframe) containing the top matching results from the queried knowledge base.

## Knowledge Retrieval parameters
## Knowledge Base parameters

<PartialParams />

Expand All @@ -25,11 +25,11 @@ The output is a [`DataFrame`](/data-types#dataframe) containing the top matching
| top_k | Top K Results | Input parameter. Number of search results to return. Default: `5`. |
| include_metadata | Include Metadata | Input parameter. Whether to include all metadata and embeddings in the output. If enabled, each output row includes all metadata, embeddings, and content. If disabled, only the content is returned. Default: Enabled (true). |

## Use the Knowledge Retrieval component in a flow
## Use the Knowledge Base component in a flow

After you create and load data to a knowledge base, you can use the **Knowledge Retrieval** component in any flow to retrieve data from your knowledge base using semantic search:
After you create and load data to a [knowledge base](/knowledge), you can use the **Knowledge Base** component in any flow to retrieve data from your knowledge base using semantic search:

1. Add a **Knowledge Retrieval** component to your flow.
1. Add a **Knowledge Base** component to your flow.

2. In the **Knowledge** field, select the knowledge base you want to search, such as the customer sales data knowledge base created in the previous steps.

Expand All @@ -39,8 +39,8 @@ After you create and load data to a knowledge base, you can use the **Knowledge

For the customer sales data example, enter a product name like `laptop` or `wireless devices`.

5. Click <Icon name="Play" aria-hidden="true"/> **Run component** on the **Knowledge Retrieval** component, and then open the **Playground** to view the output.
5. Click <Icon name="Play" aria-hidden="true"/> **Run component** on the **Knowledge Base** component, and then open the **Playground** to view the output.

## See also

* [**Knowledge Ingestion** component](/knowledge-ingestion)
* [Manage vector data](/knowledge)
177 changes: 0 additions & 177 deletions docs/docs/Components/knowledge-ingestion.mdx
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/docs/Develop/knowledge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Optionally, to create an empty knowledge base, click **Create**.
7. Your data is embedded as a **Knowledge**.
When it is available to use, the **Status** changes to **Ready**.

To use the new knowledge base in a flow, see [Use the Knowledge Ingestion component in a flow](/knowledge-ingestion#usage-example).
To use the new knowledge base in a flow, see [Use the Knowledge Base component in a flow](/knowledge-base).

### Manage knowledge bases

Expand All @@ -123,7 +123,7 @@ To view a knowledge base's chunks, click <Icon name="EllipsisVertical" aria-hidd
To delete a knowledge base, click <Icon name="EllipsisVertical" aria-hidden="true"/> **More**, and then click <Icon name="Trash2" aria-hidden="true"/> **Delete**.
If any flows use the deleted knowledge base, you must update them to use a different knowledge base.

For more information on using knowledge bases in a flow, see the [**Knowledge Ingestion**](/knowledge-ingestion) and [**Knowledge Retrieval**](/knowledge-retrieval) components.
For more information on using knowledge bases in a flow, see the [**Knowledge Base** component](/knowledge-base) documentation.

## See also

Expand Down
3 changes: 1 addition & 2 deletions docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,8 +305,7 @@ module.exports = {
label: "Files and Knowledge",
items: [
"Components/directory",
"Components/knowledge-ingestion",
"Components/knowledge-retrieval",
"Components/knowledge-base",
"Components/read-file",
"Components/write-file",
]
Expand Down
Loading