docs: link components to docs pages (#8850)

* docs-links

* Update url.py

---------

Co-authored-by: Edwin Jose <edwin.jose@datastax.com>
This commit is contained in:
Mendon Kissling 2025-07-03 17:08:13 -04:00 • committed by GitHub
commit dd55acb7f3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
34 changed files with 35 additions and 1 deletions

View file

@ -94,6 +94,7 @@ class MCPToolsComponent(ComponentWithCache):
display_name = "MCP Tools" display_name = "MCP Tools"
description = "Connect to an MCP server to use its tools." description = "Connect to an MCP server to use its tools."
documentation: str = "https://docs.langflow.org/mcp-client"
icon = "Mcp" icon = "Mcp"
name = "MCPTools" name = "MCPTools"

View file

@ -45,6 +45,7 @@ DEFAULT_FIELDS = ["mode"]
class APIRequestComponent(Component): class APIRequestComponent(Component):
display_name = "API Request" display_name = "API Request"
description = "Make HTTP requests using URL or cURL commands." description = "Make HTTP requests using URL or cURL commands."
documentation: str = "https://docs.langflow.org/components-data#api-request"
icon = "Globe" icon = "Globe"
name = "APIRequest" name = "APIRequest"

View file

@ -9,6 +9,7 @@ from langflow.template.field.base import Output
class DirectoryComponent(Component): class DirectoryComponent(Component):
display_name = "Directory" display_name = "Directory"
description = "Recursively load files from a directory." description = "Recursively load files from a directory."
documentation: str = "https://docs.langflow.org/components-data#directory"
icon = "folder" icon = "folder"
name = "Directory" name = "Directory"

View file

@ -16,6 +16,7 @@ class FileComponent(BaseFileComponent):
display_name = "File" display_name = "File"
description = "Loads content from one or more files as a DataFrame." description = "Loads content from one or more files as a DataFrame."
documentation: str = "https://docs.langflow.org/components-data#file"
icon = "file-text" icon = "file-text"
name = "File" name = "File"

View file

@ -12,6 +12,7 @@ from langflow.schema import DataFrame
class NewsSearchComponent(Component): class NewsSearchComponent(Component):
display_name = "News Search" display_name = "News Search"
description = "Searches Google News via RSS. Returns clean article data." description = "Searches Google News via RSS. Returns clean article data."
documentation: str = "https://docs.langflow.org/components-data#news-search"
icon = "newspaper" icon = "newspaper"
name = "NewsSearch" name = "NewsSearch"

View file

@ -11,6 +11,7 @@ from langflow.schema import DataFrame
class RSSReaderComponent(Component): class RSSReaderComponent(Component):
display_name = "RSS Reader" display_name = "RSS Reader"
description = "Fetches and parses an RSS feed." description = "Fetches and parses an RSS feed."
documentation: str = "https://docs.langflow.org/components-data#rss-reader"
icon = "rss" icon = "rss"
name = "RSSReaderSimple" name = "RSSReaderSimple"

View file

@ -18,6 +18,7 @@ class SQLComponent(ComponentWithCache):
display_name = "SQL Database" display_name = "SQL Database"
description = "Executes SQL queries on SQLAlchemy-compatible databases." description = "Executes SQL queries on SQLAlchemy-compatible databases."
documentation: str = "https://docs.langflow.org/components-data#sql-database"
icon = "database" icon = "database"
name = "SQLComponent" name = "SQLComponent"
metadata = {"keywords": ["sql", "database", "query", "db", "fetch"]} metadata = {"keywords": ["sql", "database", "query", "db", "fetch"]}

View file

@ -41,6 +41,7 @@ class URLComponent(Component):
display_name = "URL" display_name = "URL"
description = "Fetch content from one or more web pages, following links recursively." description = "Fetch content from one or more web pages, following links recursively."
documentation: str = "https://docs.langflow.org/components-data#url"
icon = "layout-template" icon = "layout-template"
name = "URLComponent" name = "URLComponent"

View file

@ -14,6 +14,7 @@ from langflow.services.deps import get_settings_service
class WebSearchComponent(Component): class WebSearchComponent(Component):
display_name = "Web Search" display_name = "Web Search"
description = "Performs a basic DuckDuckGo search (HTML scraping). May be subject to rate limits." description = "Performs a basic DuckDuckGo search (HTML scraping). May be subject to rate limits."
documentation: str = "https://docs.langflow.org/components-data#web-search"
icon = "search" icon = "search"
name = "WebSearchNoAPI" name = "WebSearchNoAPI"

View file

@ -7,6 +7,7 @@ from langflow.schema.data import Data
class WebhookComponent(Component): class WebhookComponent(Component):
display_name = "Webhook" display_name = "Webhook"
documentation: str = "https://docs.langflow.org/components-data#webhook"
name = "Webhook" name = "Webhook"
icon = "webhook" icon = "webhook"

View file

@ -11,6 +11,7 @@ from langflow.schema.data import Data
class CalculatorComponent(Component): class CalculatorComponent(Component):
display_name = "Calculator" display_name = "Calculator"
description = "Perform basic arithmetic operations on a given expression." description = "Perform basic arithmetic operations on a given expression."
documentation: str = "https://docs.langflow.org/components-helpers#calculator"
icon = "calculator" icon = "calculator"
# Cache operators dictionary as a class variable # Cache operators dictionary as a class variable

View file

@ -11,6 +11,7 @@ from langflow.schema.message import Message
class CurrentDateComponent(Component): class CurrentDateComponent(Component):
display_name = "Current Date" display_name = "Current Date"
description = "Returns the current date and time in the selected timezone." description = "Returns the current date and time in the selected timezone."
documentation: str = "https://docs.langflow.org/components-helpers#current-date"
icon = "clock" icon = "clock"
name = "CurrentDate" name = "CurrentDate"

View file

@ -16,6 +16,7 @@ from langflow.utils.constants import MESSAGE_SENDER_AI, MESSAGE_SENDER_NAME_AI,
class MemoryComponent(Component): class MemoryComponent(Component):
display_name = "Message History" display_name = "Message History"
description = "Stores or retrieves stored chat messages from Langflow tables or an external memory." description = "Stores or retrieves stored chat messages from Langflow tables or an external memory."
documentation: str = "https://docs.langflow.org/components-helpers#message-history"
icon = "message-square-more" icon = "message-square-more"
name = "Memory" name = "Memory"
default_keys = ["mode", "memory"] default_keys = ["mode", "memory"]

View file

@ -19,6 +19,7 @@ from langflow.utils.constants import (
class ChatInput(ChatComponent): class ChatInput(ChatComponent):
display_name = "Chat Input" display_name = "Chat Input"
description = "Get chat inputs from the Playground." description = "Get chat inputs from the Playground."
documentation: str = "https://docs.langflow.org/components-io#chat-input"
icon = "MessagesSquare" icon = "MessagesSquare"
name = "ChatInput" name = "ChatInput"
minimized = True minimized = True

View file

@ -22,6 +22,7 @@ from langflow.utils.constants import (
class ChatOutput(ChatComponent): class ChatOutput(ChatComponent):
display_name = "Chat Output" display_name = "Chat Output"
description = "Display a chat message in the Playground." description = "Display a chat message in the Playground."
documentation: str = "https://docs.langflow.org/components-io#chat-output"
icon = "MessagesSquare" icon = "MessagesSquare"
name = "ChatOutput" name = "ChatOutput"
minimized = True minimized = True

View file

@ -6,6 +6,7 @@ from langflow.schema.message import Message
class TextInputComponent(TextComponent): class TextInputComponent(TextComponent):
display_name = "Text Input" display_name = "Text Input"
description = "Get user text inputs." description = "Get user text inputs."
documentation: str = "https://docs.langflow.org/components-io#text-input"
icon = "type" icon = "type"
name = "TextInput" name = "TextInput"

View file

@ -6,6 +6,7 @@ from langflow.schema.message import Message
class TextOutputComponent(TextComponent): class TextOutputComponent(TextComponent):
display_name = "Text Output" display_name = "Text Output"
description = "Sends text output via API." description = "Sends text output via API."
documentation: str = "https://docs.langflow.org/components-io#text-output"
icon = "type" icon = "type"
name = "TextOutput" name = "TextOutput"

View file

@ -8,6 +8,7 @@ from langflow.schema.message import Message
class ConditionalRouterComponent(Component): class ConditionalRouterComponent(Component):
display_name = "If-Else" display_name = "If-Else"
description = "Routes an input message to a corresponding output based on text comparison." description = "Routes an input message to a corresponding output based on text comparison."
documentation: str = "https://docs.langflow.org/components-logic#conditional-router-if-else-component"
icon = "split" icon = "split"
name = "ConditionalRouter" name = "ConditionalRouter"

View file

@ -10,6 +10,7 @@ class LoopComponent(Component):
description = ( description = (
"Iterates over a list of Data objects, outputting one item at a time and aggregating results from loop inputs." "Iterates over a list of Data objects, outputting one item at a time and aggregating results from loop inputs."
) )
documentation: str = "https://docs.langflow.org/components-logic#loop"
icon = "infinity" icon = "infinity"
inputs = [ inputs = [

View file

@ -13,6 +13,7 @@ class RunFlowComponent(RunFlowBaseComponent):
"Creates a tool component from a Flow that takes all its inputs and runs it. " "Creates a tool component from a Flow that takes all its inputs and runs it. "
" \n **Select a Flow to use the tool mode**" " \n **Select a Flow to use the tool mode**"
) )
documentation: str = "https://docs.langflow.org/components-logic#run-flow"
beta = True beta = True
name = "RunFlow" name = "RunFlow"
icon = "Workflow" icon = "Workflow"

View file

@ -20,6 +20,7 @@ from langflow.schema.dotdict import dotdict
class EmbeddingModelComponent(LCEmbeddingsModel): class EmbeddingModelComponent(LCEmbeddingsModel):
display_name = "Embedding Model" display_name = "Embedding Model"
description = "Generate embeddings using a specified provider." description = "Generate embeddings using a specified provider."
documentation: str = "https://docs.langflow.org/components-embedding-models"
icon = "binary" icon = "binary"
name = "EmbeddingModel" name = "EmbeddingModel"
category = "models" category = "models"

View file

@ -17,7 +17,8 @@ from langflow.schema.dotdict import dotdict
class LanguageModelComponent(LCModelComponent): class LanguageModelComponent(LCModelComponent):
display_name = "Language Model" display_name = "Language Model"
description = "Runs a language model given a specified provider. " description = "Runs a language model given a specified provider."
documentation: str = "https://docs.langflow.org/components-models"
icon = "brain-circuit" icon = "brain-circuit"
category = "models" category = "models"
priority = 0 # Set priority to 0 to make it appear first priority = 0 # Set priority to 0 to make it appear first

View file

@ -16,6 +16,7 @@ if TYPE_CHECKING:
class BatchRunComponent(Component): class BatchRunComponent(Component):
display_name = "Batch Run" display_name = "Batch Run"
description = "Runs an LLM on each row of a DataFrame column. If no column is specified, all columns are used." description = "Runs an LLM on each row of a DataFrame column. If no column is specified, all columns are used."
documentation: str = "https://docs.langflow.org/components-processing#batch-run"
icon = "List" icon = "List"
inputs = [ inputs = [

View file

@ -50,6 +50,7 @@ def convert_to_dataframe(v: DataFrame | Data | Message | dict) -> DataFrame:
class TypeConverterComponent(Component): class TypeConverterComponent(Component):
display_name = "Type Convert" display_name = "Type Convert"
description = "Convert between different types (Message, Data, DataFrame)" description = "Convert between different types (Message, Data, DataFrame)"
documentation: str = "https://docs.langflow.org/components-processing#type-convert"
icon = "repeat" icon = "repeat"
inputs = [ inputs = [

View file

@ -33,6 +33,7 @@ OPERATORS = {
class DataOperationsComponent(Component): class DataOperationsComponent(Component):
display_name = "Data Operations" display_name = "Data Operations"
description = "Perform various operations on a Data object." description = "Perform various operations on a Data object."
documentation: str = "https://docs.langflow.org/components-processing#data-operations"
icon = "file-json" icon = "file-json"
name = "DataOperations" name = "DataOperations"
default_keys = ["operations", "data"] default_keys = ["operations", "data"]

View file

@ -15,6 +15,7 @@ from langflow.schema.dataframe import DataFrame
class DataFrameOperationsComponent(Component): class DataFrameOperationsComponent(Component):
display_name = "DataFrame Operations" display_name = "DataFrame Operations"
description = "Perform various operations on a DataFrame." description = "Perform various operations on a DataFrame."
documentation: str = "https://docs.langflow.org/components-processing#dataframe-operations"
icon = "table" icon = "table"
name = "DataFrameOperations" name = "DataFrameOperations"

View file

@ -16,6 +16,7 @@ if TYPE_CHECKING:
class LambdaFilterComponent(Component): class LambdaFilterComponent(Component):
display_name = "Smart Function" display_name = "Smart Function"
description = "Uses an LLM to generate a function for filtering or transforming structured data." description = "Uses an LLM to generate a function for filtering or transforming structured data."
documentation: str = "https://docs.langflow.org/components-processing#smart-function"
icon = "square-function" icon = "square-function"
name = "Smart Function" name = "Smart Function"

View file

@ -17,6 +17,7 @@ from langflow.template.field.base import Output
class LLMRouterComponent(Component): class LLMRouterComponent(Component):
display_name = "LLM Router" display_name = "LLM Router"
description = "Routes the input to the most appropriate LLM based on OpenRouter model specifications" description = "Routes the input to the most appropriate LLM based on OpenRouter model specifications"
documentation: str = "https://docs.langflow.org/components-processing#llm-router"
icon = "git-branch" icon = "git-branch"
# Constants for magic values # Constants for magic values

View file

@ -10,6 +10,7 @@ from langflow.template.field.base import Output
class ParserComponent(Component): class ParserComponent(Component):
display_name = "Parser" display_name = "Parser"
description = "Extracts text using a template." description = "Extracts text using a template."
documentation: str = "https://docs.langflow.org/components-processing#parser"
icon = "braces" icon = "braces"
inputs = [ inputs = [

View file

@ -9,6 +9,7 @@ from langflow.template.utils import update_template_values
class PromptComponent(Component): class PromptComponent(Component):
display_name: str = "Prompt Template" display_name: str = "Prompt Template"
description: str = "Create a prompt template with dynamic variables." description: str = "Create a prompt template with dynamic variables."
documentation: str = "https://docs.langflow.org/components-prompts"
icon = "braces" icon = "braces"
trace_type = "prompt" trace_type = "prompt"
name = "Prompt Template" name = "Prompt Template"

View file

@ -10,6 +10,7 @@ from langflow.schema.data import Data
class PythonREPLComponent(Component): class PythonREPLComponent(Component):
display_name = "Python Interpreter" display_name = "Python Interpreter"
description = "Run Python code with optional imports. Use print() to see the output." description = "Run Python code with optional imports. Use print() to see the output."
documentation: str = "https://docs.langflow.org/components-processing#python-interpreter"
icon = "square-terminal" icon = "square-terminal"
inputs = [ inputs = [

View file

@ -20,6 +20,7 @@ from langflow.template.field.base import Output
class SaveToFileComponent(Component): class SaveToFileComponent(Component):
display_name = "Save File" display_name = "Save File"
description = "Save data to a local file in the selected format." description = "Save data to a local file in the selected format."
documentation: str = "https://docs.langflow.org/components-processing#save-file"
icon = "save" icon = "save"
name = "SaveToFile" name = "SaveToFile"

View file

@ -11,6 +11,7 @@ from langflow.utils.util import unescape_string
class SplitTextComponent(Component): class SplitTextComponent(Component):
display_name: str = "Split Text" display_name: str = "Split Text"
description: str = "Split text into chunks based on specified criteria." description: str = "Split text into chunks based on specified criteria."
documentation: str = "https://docs.langflow.org/components-processing#split-text"
icon = "scissors-line-dashed" icon = "scissors-line-dashed"
name = "SplitText" name = "SplitText"

View file

@ -18,6 +18,7 @@ from langflow.schema.table import EditMode
class StructuredOutputComponent(Component): class StructuredOutputComponent(Component):
display_name = "Structured Output" display_name = "Structured Output"
description = "Uses an LLM to generate structured data. Ideal for extraction and consistency." description = "Uses an LLM to generate structured data. Ideal for extraction and consistency."
documentation: str = "https://docs.langflow.org/components-processing#structured-output"
name = "StructuredOutput" name = "StructuredOutput"
icon = "braces" icon = "braces"