mirror of
https://github.com/langflow-ai/langflow.git
synced 2026-07-24 04:13:36 +08:00
b36444f5d9
* fix: nightly now properly gets 1.9.0 branch (#12215) before it was attempting to pull release-notes as letters are alphanumerically after numbers when we sort -V then grab tail now we only look at branch names that follow the pattern '^release-[0-9]+\.[0-9]+\.[0-9]+$' * docs: add search icon (#12216) add-back-svg * initial-content * cut-1.8-release-and-include-next-version * stage-1.8.0-and-next --------- Co-authored-by: Adam-Aghili <149833988+Adam-Aghili@users.noreply.github.com>
242 lines
15 KiB
Plaintext
242 lines
15 KiB
Plaintext
---
|
|
title: Components overview
|
|
slug: /concepts-components
|
|
---
|
|
|
|
import Icon from "@site/src/components/icon";
|
|
import CodeSnippet from "@site/src/components/CodeSnippet";
|
|
import RecursiveCharacterSource from "!!raw-loader!@langflow/src/lfx/src/lfx/components/langchain_utilities/recursive_character.py";
|
|
|
|
Components are the building blocks of your flows.
|
|
Like classes in an application, each component is designed for a specific use case or integration.
|
|
|
|
:::tip
|
|
Langflow provides keyboard shortcuts for the workspace.
|
|
|
|
In the Langflow header, click your profile icon, select **Settings**, and then click **Shortcuts** to view the available shortcuts.
|
|
:::
|
|
|
|
## Add a component to a flow {#component-menus}
|
|
|
|
To add a component to a flow, drag the component from the <Icon name="Component" aria-hidden="true" /> **Core components** or <Icon name="Blocks" aria-hidden="true" /> **Bundles** menu into the [workspace](/concepts-overview#workspace).
|
|
|
|
Components are grouped by type or provider, and some components are hidden by default:
|
|
|
|
* <Icon name="Component" aria-hidden="true" /> **Core components**: Langflow's base components are grouped by purpose, such as **Inputs and Outputs** or **Data**.
|
|
These components either provide generic functionality, like loops and parsing, or they provide single components that support multiple third-party integrations.
|
|
|
|
* <Icon name="Blocks" aria-hidden="true" /> **Bundles**: Bundles contain one or more components that support specific third-party integrations, and they are grouped by service provider.
|
|
|
|
* **Legacy**: These components are hidden by default.
|
|
For more information, see [Legacy components](#legacy-components).
|
|
|
|
### Configure a component
|
|
|
|
After adding a component to a flow, configure the component's parameters and connect it to the other components in your flows.
|
|
|
|
Each component has inputs, outputs, parameters, and controls related to the component's purpose.
|
|
By default, components show only required and common options.
|
|
To access additional settings and controls, including meta settings, use the [component inspection panel](#component-inspection-panel).
|
|
|
|
### Component inspection panel {#component-inspection-panel}
|
|
|
|
When you select a component in the workspace, a component inspection panel appears on the right side of the screen.
|
|
|
|
The inspection panel displays all of a component's parameters, including hidden or advanced parameters.
|
|
|
|
### Component header menus
|
|
|
|
To access a component's header menu, click the component in your workspace.
|
|
|
|
|
|
|
|
The following options are available directly on the header menu:
|
|
|
|
- **Code**: Modify component settings by directly editing the component's Python code.
|
|
- **Freeze**: Freeze a component and all upstream components to prevent re-running. For more information, see [Freeze a component](#freeze-a-component).
|
|
- **Tool Mode**: Enable this option when combining a component with an **Agent** component.
|
|
|
|
For all other options, including **Delete** and **Duplicate** controls, click <Icon name="Ellipsis" aria-hidden="true" /> **Show More**.
|
|
|
|
### Rename a component
|
|
|
|
To modify a component's name or description, click the component in the workspace, and then click <Icon name="PencilLine" aria-hidden="true"/> **Edit**.
|
|
Component descriptions accept Markdown syntax.
|
|
|
|
### Run a component
|
|
|
|
To run a single component, click <Icon name="Play" aria-label="Play button" /> **Run component**.
|
|
A **Last Run** value indicates that the component ran successfully.
|
|
|
|
Running a single component is different from running an entire flow. In a single component run, the `build_vertex` function is called, which builds and runs only the single component with direct inputs provided through the visual editor (the `inputs_dict` parameter). The `VertexBuildResult` data is passed to the `build_and_run` method that calls the component's `build` method and runs it. Unlike running an entire flow, running a single component doesn't automatically execute its upstream dependencies.
|
|
|
|
### Inspect component output and logs
|
|
|
|
To view the output and logs for a single component, click <Icon name="TextSearch" aria-hidden="true" /> **Inspect**.
|
|
|
|
### Freeze a component
|
|
|
|
:::info
|
|
Freezing a component also freezes all components upstream of the selected component.
|
|
:::
|
|
|
|
Use the freeze option if you expect consistent output from a component _and all upstream components_, and you only need to run those components once.
|
|
|
|
Freezing a component prevents that component and all upstream components from re-running, and it preserves the last output state for those components.
|
|
Any future flow runs use the preserved output.
|
|
|
|
To freeze a component, click the component in the workspace to expose the component's header menu, and then click **Freeze**.
|
|
|
|
## Component ports
|
|
|
|
Around the border of each component, there are circular port icons like <Icon name="Circle" size="16" aria-label="Indigo message port" style={{ color: '#4f46e5', fill: '#4f46e5' }}/>.
|
|
These indicate a component _connection point_ or _port_.
|
|
|
|
Ports either accept input or produce output of a specific data type.
|
|
You can infer the data type from the field the port is attached to or from the [port's color](#port-colors).
|
|
For example, the **System Message** field accepts [message data](/data-types#message), as illustrated by the blue port icon: <Icon name="Circle" size="16" aria-label="Indigo message port" style={{ color: '#4f46e5', fill: '#4f46e5' }} />.
|
|
|
|
|
|
|
|
When building flows, connect output ports to input ports of the same type (color) to transfer that type of data between two components.
|
|
For information about the programmatic representation of each data type, see [Langflow data types](/data-types).
|
|
|
|
:::tip
|
|
* In the workspace, hover over a port to see connection details for that port.
|
|
Click a port to <Icon name="Search" aria-hidden="true" /> **Search** for compatible components.
|
|
|
|
* If two components have incompatible data types, you can use a processing component like the [**Type Convert** component](/type-convert) to convert the data between components.
|
|
:::
|
|
|
|
### Dynamic ports
|
|
|
|
Some components have ports that are dynamically added or removed.
|
|
For example, the **Prompt Template** component accepts [inputs wrapped in curly braces](/components-prompts#define-variables-in-prompts), and new ports are opened when a value wrapped in curly braces is detected in the **Template** field.
|
|
|
|
|
|
|
|
### Output type selection
|
|
|
|
All components produce output that is either sent to another component in the flow or returned as the final flow result.
|
|
|
|
Some components can produce multiple types of output:
|
|
|
|
* If the component emits all types at once, the component has multiple output ports in the visual editor. In component code, this is represented by `group_outputs=True`
|
|
|
|
* If the component emits only one type, you must select the output type by clicking the output label near the output port, and then selecting the desired output type. In component code, this is represented by `group_outputs=False` or omitting the `group_outputs` parameter.
|
|
|
|
For example, a language model component can output _either_ a **Model Response** or **Language Model**.
|
|
The **Model Response** output produces [`Message`](/data-types#message) data that can be passed to another component's `Message` port.
|
|
The **Language Model** output must be connected to a component with a **Language Model** input, such as the [**Structured Output** component](/structured-output), that uses the attached LLM to power the receiving component's reasoning.
|
|
|
|
|
|
|
|
### Port colors
|
|
|
|
Component port colors indicate the data type ingested or emitted by the port.
|
|
For example, a **Message** port either accepts or emits `Message` data.
|
|
|
|
The following table lists the component data types and their corresponding port colors:
|
|
|
|
| Data type | Port color | Port icon example |
|
|
|-----------|--------------|----------|
|
|
| Data | Red | <Icon name="Circle" size="16" aria-label="Red data port" style={{ color: '#dc2626', fill: '#dc2626' }} /> |
|
|
| DataFrame | Pink | <Icon name="Circle" size="16" aria-label="Pink dataframe port" style={{ color: '#ec4899', fill:'#ec4899' }} /> |
|
|
| Embeddings | Emerald | <Icon name="Circle" size="16" aria-label="Emerald embeddings port" style={{ color: '#10b981', fill: '#10b981' }} /> |
|
|
| LanguageModel | Fuchsia | <Icon name="Circle" size="16" aria-label="Fuchsia language model port" style={{ color: '#c026d3', fill: '#c026d3' }} /> |
|
|
| Memory | Orange | <Icon name="Circle" size="16" aria-label="Orange memory port" style={{ color: '#f97316', fill: '#f97316' }} /> |
|
|
| Message | Indigo | <Icon name="Circle" size="16" aria-label="Indigo message port" style={{ color: '#4f46e5', fill: '#4f46e5' }} /> |
|
|
| Tool | Cyan | <Icon name="Circle" size="16" aria-label="Cyan tool port" style={{ color: '#06b6d4', fill: '#06b6d4' }} /> |
|
|
| Unknown or multiple types | Gray | <Icon name="Circle" size="16" aria-label="Gray unknown port" style={{ color: '#9CA3AF', fill: '#9CA3AF' }} /> |
|
|
|
|
## Component code
|
|
|
|
You can edit components in the [workspace](/concepts-overview#workspace) and in code. When editing a flow, select a component, and then click <Icon name="Code" aria-hidden="true"/> **Code** to see and edit the component's underlying Python code.
|
|
|
|
All components have underlying code that determines how you configure them and what actions they can perform.
|
|
In the context of creating and running flows, component code does the following:
|
|
|
|
* Determines what configuration options to show in the visual editor.
|
|
* Validates inputs based on the component's defined input types.
|
|
* Processes data using the configured parameters, methods, and functions.
|
|
* Passes results to the next component in the flow.
|
|
|
|
All components inherit from a base `Component` class that defines the component's interface and behavior.
|
|
For example, the [**Recursive Character Text Splitter** component](https://github.com/langflow-ai/langflow/blob/main/src/lfx/src/lfx/components/langchain_utilities/recursive_character.py) is a child of the [`LCTextSplitterComponent`](https://github.com/langflow-ai/langflow/blob/main/src/lfx/src/lfx/base/textsplitters/model.py) class.
|
|
|
|
Each component's code includes definitions for inputs and outputs, which are represented in the workspace as [component ports](#component-ports).
|
|
For example, the `RecursiveCharacterTextSplitter` has four inputs. Each input definition specifies the input type, such as `IntInput`, as well as the encoded name, display name, description, and other parameters for that specific input.
|
|
These values determine the component settings, such as display names and tooltips in the visual editor.
|
|
|
|
<CodeSnippet
|
|
source={RecursiveCharacterSource}
|
|
startLine={17}
|
|
endLine={41}
|
|
language="python"
|
|
title="RecursiveCharacterTextSplitter inputs (from recursive_character.py)"
|
|
showLineNumbers
|
|
/>
|
|
|
|
Additionally, components have methods or functions that handle their functionality.
|
|
For example, the `RecursiveCharacterTextSplitter` has two methods:
|
|
|
|
<CodeSnippet
|
|
source={RecursiveCharacterSource}
|
|
startLine={45}
|
|
endLine={60}
|
|
language="python"
|
|
title="RecursiveCharacterTextSplitter methods (from recursive_character.py)"
|
|
showLineNumbers
|
|
/>
|
|
|
|
The `get_data_input` method retrieves the text to be split from the component's input, which makes the data available to the class.
|
|
The `build_text_splitter` method creates a `RecursiveCharacterTextSplitter` object by calling its parent class's `build` method. Then, the text is split with the created splitter and passed to the next component.
|
|
|
|
## Component versions
|
|
|
|
Component versions and states are stored in an internal Langflow database. When you add a component to a flow, you create a detached copy of the component based on the information in the Langflow database.
|
|
These copies are detached from the primary Langflow database, and they don't synchronize with any updates that can occur when you upgrade your Langflow version.
|
|
|
|
In other words, an individual instance of a component retains the version number and state from the moment you add it to a specific flow. For example, if a component is at version 1.0 when you add it to a flow, it remains at version 1.0 _in that flow_ unless you update it.
|
|
|
|
### Update component versions
|
|
|
|
When editing a flow in the workspace, Langflow notifies you if a component's workspace version is behind the database version so you can update the component's workspace version:
|
|
|
|
* **Update ready**: This notification means the component update contains no breaking changes.
|
|
* **Update available**: This notification means the component update might contain breaking changes.
|
|
|
|
Breaking changes modify component inputs and outputs, causing the components to be disconnected and break the flow. After updating the component, you might need to edit the component settings or reconnect component ports.
|
|
|
|
There are two ways to update components:
|
|
|
|
* Click **Update** to update a single component. This is recommended for updates without breaking changes.
|
|
* Click **Review** to view all available updates and create a snapshot before updating. This is recommended for updates with breaking changes.
|
|
|
|
To save a snapshot of your flow before updating the components, enable **Create backup flow before updating**. Backup flows are stored in the same project folder as the original flow with the suffix `(backup)`.
|
|
|
|
To update specific components, select the components you want to update, and then click **Update Components**.
|
|
|
|
Components are updated to the latest available version, based on the version of Langflow you are running.
|
|
|
|
## Group components
|
|
|
|
Multiple components can be grouped into a single component for reuse. This is useful for organizing large flows by combining related components together, such as a RAG **Agent** component and it's associated tools or vector store components.
|
|
|
|
1. Hold <kbd>Shift</kbd>, and then click and drag to highlight all components you want to merge. Components must be completely within the selection area to be merged.
|
|
|
|
Alternatively, to select components for merging one by one, hold <kbd>Ctrl</kbd> on Windows or <kbd>Cmd</kbd> on Mac, and then click each component to add them to the group.
|
|
|
|
2. Release the mouse and keyboard, and then click **Group** to merge the components into a single, group component.
|
|
|
|
Grouped components are configured and managed as a single component, including the component name, code, and settings.
|
|
|
|
To ungroup the components, click the component in the workspace to expose the component's header menu, click <Icon name="Ellipsis" aria-hidden="true" /> **Show More**, and then select **Ungroup**.
|
|
|
|
If you want to reuse this grouping in other flows, click the component in the workspace to expose the component's header menu, click <Icon name="Ellipsis" aria-hidden="true" /> **Show More**, and then select **Save** to save the component to the <Icon name="Component" aria-hidden="true" /> **Core components** menu as a custom component.
|
|
|
|
## Legacy components
|
|
|
|
import PartialLegacy from '@site/docs/_partial-legacy.mdx';
|
|
|
|
<PartialLegacy /> |