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:
parent
78d64eb7af
commit
dd55acb7f3
34 changed files with 35 additions and 1 deletions
|
|
@ -94,6 +94,7 @@ class MCPToolsComponent(ComponentWithCache):
|
|||
|
||||
display_name = "MCP Tools"
|
||||
description = "Connect to an MCP server to use its tools."
|
||||
documentation: str = "https://docs.langflow.org/mcp-client"
|
||||
icon = "Mcp"
|
||||
name = "MCPTools"
|
||||
|
||||
|
|
|
|||
|
|
@ -45,6 +45,7 @@ DEFAULT_FIELDS = ["mode"]
|
|||
class APIRequestComponent(Component):
|
||||
display_name = "API Request"
|
||||
description = "Make HTTP requests using URL or cURL commands."
|
||||
documentation: str = "https://docs.langflow.org/components-data#api-request"
|
||||
icon = "Globe"
|
||||
name = "APIRequest"
|
||||
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ from langflow.template.field.base import Output
|
|||
class DirectoryComponent(Component):
|
||||
display_name = "Directory"
|
||||
description = "Recursively load files from a directory."
|
||||
documentation: str = "https://docs.langflow.org/components-data#directory"
|
||||
icon = "folder"
|
||||
name = "Directory"
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ class FileComponent(BaseFileComponent):
|
|||
|
||||
display_name = "File"
|
||||
description = "Loads content from one or more files as a DataFrame."
|
||||
documentation: str = "https://docs.langflow.org/components-data#file"
|
||||
icon = "file-text"
|
||||
name = "File"
|
||||
|
||||
|
|
|
|||
|
|
@ -12,6 +12,7 @@ from langflow.schema import DataFrame
|
|||
class NewsSearchComponent(Component):
|
||||
display_name = "News Search"
|
||||
description = "Searches Google News via RSS. Returns clean article data."
|
||||
documentation: str = "https://docs.langflow.org/components-data#news-search"
|
||||
icon = "newspaper"
|
||||
name = "NewsSearch"
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ from langflow.schema import DataFrame
|
|||
class RSSReaderComponent(Component):
|
||||
display_name = "RSS Reader"
|
||||
description = "Fetches and parses an RSS feed."
|
||||
documentation: str = "https://docs.langflow.org/components-data#rss-reader"
|
||||
icon = "rss"
|
||||
name = "RSSReaderSimple"
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ class SQLComponent(ComponentWithCache):
|
|||
|
||||
display_name = "SQL Database"
|
||||
description = "Executes SQL queries on SQLAlchemy-compatible databases."
|
||||
documentation: str = "https://docs.langflow.org/components-data#sql-database"
|
||||
icon = "database"
|
||||
name = "SQLComponent"
|
||||
metadata = {"keywords": ["sql", "database", "query", "db", "fetch"]}
|
||||
|
|
|
|||
|
|
@ -41,6 +41,7 @@ class URLComponent(Component):
|
|||
|
||||
display_name = "URL"
|
||||
description = "Fetch content from one or more web pages, following links recursively."
|
||||
documentation: str = "https://docs.langflow.org/components-data#url"
|
||||
icon = "layout-template"
|
||||
name = "URLComponent"
|
||||
|
||||
|
|
|
|||
|
|
@ -14,6 +14,7 @@ from langflow.services.deps import get_settings_service
|
|||
class WebSearchComponent(Component):
|
||||
display_name = "Web Search"
|
||||
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"
|
||||
name = "WebSearchNoAPI"
|
||||
|
||||
|
|
|
|||
|
|
@ -7,6 +7,7 @@ from langflow.schema.data import Data
|
|||
|
||||
class WebhookComponent(Component):
|
||||
display_name = "Webhook"
|
||||
documentation: str = "https://docs.langflow.org/components-data#webhook"
|
||||
name = "Webhook"
|
||||
icon = "webhook"
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ from langflow.schema.data import Data
|
|||
class CalculatorComponent(Component):
|
||||
display_name = "Calculator"
|
||||
description = "Perform basic arithmetic operations on a given expression."
|
||||
documentation: str = "https://docs.langflow.org/components-helpers#calculator"
|
||||
icon = "calculator"
|
||||
|
||||
# Cache operators dictionary as a class variable
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ from langflow.schema.message import Message
|
|||
class CurrentDateComponent(Component):
|
||||
display_name = "Current Date"
|
||||
description = "Returns the current date and time in the selected timezone."
|
||||
documentation: str = "https://docs.langflow.org/components-helpers#current-date"
|
||||
icon = "clock"
|
||||
name = "CurrentDate"
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ from langflow.utils.constants import MESSAGE_SENDER_AI, MESSAGE_SENDER_NAME_AI,
|
|||
class MemoryComponent(Component):
|
||||
display_name = "Message History"
|
||||
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"
|
||||
name = "Memory"
|
||||
default_keys = ["mode", "memory"]
|
||||
|
|
|
|||
|
|
@ -19,6 +19,7 @@ from langflow.utils.constants import (
|
|||
class ChatInput(ChatComponent):
|
||||
display_name = "Chat Input"
|
||||
description = "Get chat inputs from the Playground."
|
||||
documentation: str = "https://docs.langflow.org/components-io#chat-input"
|
||||
icon = "MessagesSquare"
|
||||
name = "ChatInput"
|
||||
minimized = True
|
||||
|
|
|
|||
|
|
@ -22,6 +22,7 @@ from langflow.utils.constants import (
|
|||
class ChatOutput(ChatComponent):
|
||||
display_name = "Chat Output"
|
||||
description = "Display a chat message in the Playground."
|
||||
documentation: str = "https://docs.langflow.org/components-io#chat-output"
|
||||
icon = "MessagesSquare"
|
||||
name = "ChatOutput"
|
||||
minimized = True
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ from langflow.schema.message import Message
|
|||
class TextInputComponent(TextComponent):
|
||||
display_name = "Text Input"
|
||||
description = "Get user text inputs."
|
||||
documentation: str = "https://docs.langflow.org/components-io#text-input"
|
||||
icon = "type"
|
||||
name = "TextInput"
|
||||
|
||||
|
|
|
|||
|
|
@ -6,6 +6,7 @@ from langflow.schema.message import Message
|
|||
class TextOutputComponent(TextComponent):
|
||||
display_name = "Text Output"
|
||||
description = "Sends text output via API."
|
||||
documentation: str = "https://docs.langflow.org/components-io#text-output"
|
||||
icon = "type"
|
||||
name = "TextOutput"
|
||||
|
||||
|
|
|
|||
|
|
@ -8,6 +8,7 @@ from langflow.schema.message import Message
|
|||
class ConditionalRouterComponent(Component):
|
||||
display_name = "If-Else"
|
||||
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"
|
||||
name = "ConditionalRouter"
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ class LoopComponent(Component):
|
|||
description = (
|
||||
"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"
|
||||
|
||||
inputs = [
|
||||
|
|
|
|||
|
|
@ -13,6 +13,7 @@ class RunFlowComponent(RunFlowBaseComponent):
|
|||
"Creates a tool component from a Flow that takes all its inputs and runs it. "
|
||||
" \n **Select a Flow to use the tool mode**"
|
||||
)
|
||||
documentation: str = "https://docs.langflow.org/components-logic#run-flow"
|
||||
beta = True
|
||||
name = "RunFlow"
|
||||
icon = "Workflow"
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@ from langflow.schema.dotdict import dotdict
|
|||
class EmbeddingModelComponent(LCEmbeddingsModel):
|
||||
display_name = "Embedding Model"
|
||||
description = "Generate embeddings using a specified provider."
|
||||
documentation: str = "https://docs.langflow.org/components-embedding-models"
|
||||
icon = "binary"
|
||||
name = "EmbeddingModel"
|
||||
category = "models"
|
||||
|
|
|
|||
|
|
@ -17,7 +17,8 @@ from langflow.schema.dotdict import dotdict
|
|||
|
||||
class LanguageModelComponent(LCModelComponent):
|
||||
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"
|
||||
category = "models"
|
||||
priority = 0 # Set priority to 0 to make it appear first
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ if TYPE_CHECKING:
|
|||
class BatchRunComponent(Component):
|
||||
display_name = "Batch Run"
|
||||
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"
|
||||
|
||||
inputs = [
|
||||
|
|
|
|||
|
|
@ -50,6 +50,7 @@ def convert_to_dataframe(v: DataFrame | Data | Message | dict) -> DataFrame:
|
|||
class TypeConverterComponent(Component):
|
||||
display_name = "Type Convert"
|
||||
description = "Convert between different types (Message, Data, DataFrame)"
|
||||
documentation: str = "https://docs.langflow.org/components-processing#type-convert"
|
||||
icon = "repeat"
|
||||
|
||||
inputs = [
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ OPERATORS = {
|
|||
class DataOperationsComponent(Component):
|
||||
display_name = "Data Operations"
|
||||
description = "Perform various operations on a Data object."
|
||||
documentation: str = "https://docs.langflow.org/components-processing#data-operations"
|
||||
icon = "file-json"
|
||||
name = "DataOperations"
|
||||
default_keys = ["operations", "data"]
|
||||
|
|
|
|||
|
|
@ -15,6 +15,7 @@ from langflow.schema.dataframe import DataFrame
|
|||
class DataFrameOperationsComponent(Component):
|
||||
display_name = "DataFrame Operations"
|
||||
description = "Perform various operations on a DataFrame."
|
||||
documentation: str = "https://docs.langflow.org/components-processing#dataframe-operations"
|
||||
icon = "table"
|
||||
name = "DataFrameOperations"
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ if TYPE_CHECKING:
|
|||
class LambdaFilterComponent(Component):
|
||||
display_name = "Smart Function"
|
||||
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"
|
||||
name = "Smart Function"
|
||||
|
||||
|
|
|
|||
|
|
@ -17,6 +17,7 @@ from langflow.template.field.base import Output
|
|||
class LLMRouterComponent(Component):
|
||||
display_name = "LLM Router"
|
||||
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"
|
||||
|
||||
# Constants for magic values
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ from langflow.template.field.base import Output
|
|||
class ParserComponent(Component):
|
||||
display_name = "Parser"
|
||||
description = "Extracts text using a template."
|
||||
documentation: str = "https://docs.langflow.org/components-processing#parser"
|
||||
icon = "braces"
|
||||
|
||||
inputs = [
|
||||
|
|
|
|||
|
|
@ -9,6 +9,7 @@ from langflow.template.utils import update_template_values
|
|||
class PromptComponent(Component):
|
||||
display_name: str = "Prompt Template"
|
||||
description: str = "Create a prompt template with dynamic variables."
|
||||
documentation: str = "https://docs.langflow.org/components-prompts"
|
||||
icon = "braces"
|
||||
trace_type = "prompt"
|
||||
name = "Prompt Template"
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ from langflow.schema.data import Data
|
|||
class PythonREPLComponent(Component):
|
||||
display_name = "Python Interpreter"
|
||||
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"
|
||||
|
||||
inputs = [
|
||||
|
|
|
|||
|
|
@ -20,6 +20,7 @@ from langflow.template.field.base import Output
|
|||
class SaveToFileComponent(Component):
|
||||
display_name = "Save File"
|
||||
description = "Save data to a local file in the selected format."
|
||||
documentation: str = "https://docs.langflow.org/components-processing#save-file"
|
||||
icon = "save"
|
||||
name = "SaveToFile"
|
||||
|
||||
|
|
|
|||
|
|
@ -11,6 +11,7 @@ from langflow.utils.util import unescape_string
|
|||
class SplitTextComponent(Component):
|
||||
display_name: str = "Split Text"
|
||||
description: str = "Split text into chunks based on specified criteria."
|
||||
documentation: str = "https://docs.langflow.org/components-processing#split-text"
|
||||
icon = "scissors-line-dashed"
|
||||
name = "SplitText"
|
||||
|
||||
|
|
|
|||
|
|
@ -18,6 +18,7 @@ from langflow.schema.table import EditMode
|
|||
class StructuredOutputComponent(Component):
|
||||
display_name = "Structured Output"
|
||||
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"
|
||||
icon = "braces"
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue