pengjunjie/langflow
1
0
Fork 1
mirror of https://github.com/langflow-ai/langflow.git synced 2026-07-24 03:55:34 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
e52fcf0f435702beb2f0f64cbc0779228ccb5739
langflow/components-data.html
github-merge-queue[bot] e52fcf0f43 deploy: c57ed6f464
2025-02-25 23:21:43 +00:00

111 lines
38 KiB
HTML
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-current docs-doc-page docs-doc-id-Components/components-data" data-has-hydrated="false">
<head>
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.7.0">
<title data-rh="true">Data | Langflow Documentation</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://docs.langflow.org/components-data"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="Data | Langflow Documentation"><meta data-rh="true" name="description" content="Data components load data from a source into your flow."><meta data-rh="true" property="og:description" content="Data components load data from a source into your flow."><link data-rh="true" rel="icon" href="/img/favicon.ico"><link data-rh="true" rel="canonical" href="https://docs.langflow.org/components-data"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/components-data" hreflang="en"><link data-rh="true" rel="alternate" href="https://docs.langflow.org/components-data" hreflang="x-default"><link data-rh="true" rel="preconnect" href="https://UZK6BDPCVY-dsn.algolia.net" crossorigin="anonymous"><link rel="preconnect" href="https://www.google-analytics.com">
<link rel="preconnect" href="https://www.googletagmanager.com">
<script async src="https://www.googletagmanager.com/gtag/js?id=G-XHC7G628ZP"></script>
<script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-XHC7G628ZP",{anonymize_ip:!0})</script>
<link rel="preconnect" href="https://www.googletagmanager.com">
<script>window.dataLayer=window.dataLayer||[]</script>
<script>!function(e,t,a,n){e[n]=e[n]||[],e[n].push({"gtm.start":(new Date).getTime(),event:"gtm.js"});var g=t.getElementsByTagName(a)[0],m=t.createElement(a);m.async=!0,m.src="https://www.googletagmanager.com/gtm.js?id=GTM-NK5M4ZT8",g.parentNode.insertBefore(m,g)}(window,document,"script","dataLayer")</script>
<link rel="search" type="application/opensearchdescription+xml" title="Langflow Documentation" href="/opensearch.xml"><link rel="stylesheet" href="/assets/css/styles.e5a88218.css">
<script src="/assets/js/runtime~main.222d37de.js" defer="defer"></script>
<script src="/assets/js/main.fa64d841.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
<noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NK5M4ZT8" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();null!==e?t(e):window.matchMedia("(prefers-color-scheme: dark)").matches?t("dark"):(window.matchMedia("(prefers-color-scheme: light)").matches,t("light"))}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="navbar navbar--fixed-top navbarHideable_m1mJ"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="navbar__items navbar__items--right"><a href="https://github.com/langflow-ai/langflow" target="_blank" class="navbar__item navbar__link header-github-link"></a><a href="https://twitter.com/langflow_ai" target="_blank" class="navbar__item navbar__link header-twitter-link"></a><a href="https://discord.gg/EqksyE2EX9" target="_blank" class="navbar__item navbar__link header-discord-link"></a><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)" aria-live="polite" aria-pressed="false"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search (Command+K)"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd sidebarWithHideableNavbar_wUlq"><a tabindex="-1" class="sidebarLogo_isFc" href="/"><img src="/img/langflow-logo-black.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/langflow-logo-white.svg" alt="Langflow" class="themedComponent_mlkZ themedComponent--dark_xIcU"></a><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/">Welcome to Langflow</a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/get-started-installation">Get started</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/starter-projects-basic-prompting">Starter projects</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/tutorials-blog-writer">Tutorials</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/concepts-overview">Concepts</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/components-agents">Components</a></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-agents">Agents</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-custom-components">Create custom Python components</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/components-data">Data</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-embedding-models">Embeddings</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-helpers">Helpers</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-io">Inputs and outputs</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-loaders">Loaders</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-logic">Logic</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-memories">Memories</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-models">Models</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-processing">Processing</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-prompts">Prompts</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-tools">Tools</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/components-vector-stores">Vector stores</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/agents-overview">Agents</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/configuration-api-keys">Configuration</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/Deployment/deployment-docker">Deployment</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/api">API reference</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/integrations-apify">Integrations</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/contributing-community">Contributing</a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a href="https://github.com/langflow-ai/langflow/releases/latest" target="_blank" rel="noopener noreferrer" class="menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false">Changelog</a></div></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Components</span><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">Data</span><meta itemprop="position" content="2"></li></ul></nav><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><style>[data-ch-theme="github-dark"] { --ch-t-colorScheme: dark;--ch-t-foreground: #c9d1d9;--ch-t-background: #0d1117;--ch-t-lighter-inlineBackground: #0d1117e6;--ch-t-editor-background: #0d1117;--ch-t-editor-foreground: #c9d1d9;--ch-t-editor-lineHighlightBackground: #6e76811a;--ch-t-editor-rangeHighlightBackground: #ffffff0b;--ch-t-editor-infoForeground: #3794FF;--ch-t-editor-selectionBackground: #264F78;--ch-t-focusBorder: #1f6feb;--ch-t-tab-activeBackground: #0d1117;--ch-t-tab-activeForeground: #c9d1d9;--ch-t-tab-inactiveBackground: #010409;--ch-t-tab-inactiveForeground: #8b949e;--ch-t-tab-border: #30363d;--ch-t-tab-activeBorder: #0d1117;--ch-t-editorGroup-border: #30363d;--ch-t-editorGroupHeader-tabsBackground: #010409;--ch-t-editorLineNumber-foreground: #6e7681;--ch-t-input-background: #0d1117;--ch-t-input-foreground: #c9d1d9;--ch-t-input-border: #30363d;--ch-t-icon-foreground: #8b949e;--ch-t-sideBar-background: #010409;--ch-t-sideBar-foreground: #c9d1d9;--ch-t-sideBar-border: #30363d;--ch-t-list-activeSelectionBackground: #6e768166;--ch-t-list-activeSelectionForeground: #c9d1d9;--ch-t-list-hoverBackground: #6e76811a;--ch-t-list-hoverForeground: #c9d1d9; }</style>
<header><h1>Data components in Langflow</h1></header>
<p>Data components load data from a source into your flow.</p>
<p>They may perform some processing or type checking, like converting raw HTML data into text, or ensuring your loaded file is of an acceptable type.</p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="use-a-data-component-in-a-flow">Use a data component in a flow<a href="#use-a-data-component-in-a-flow" class="hash-link" aria-label="Direct link to Use a data component in a flow" title="Direct link to Use a data component in a flow">​</a></h2>
<p>The <strong>URL</strong> data component loads content from a list of URLs.</p>
<p>In the component&#x27;s <strong>URLs</strong> field, enter a comma-separated list of URLs you want to load. Alternatively, connect a component that outputs the <code>Message</code> type, like the <strong>Chat Input</strong> component, to supply your URLs with a component.</p>
<p>To output a <code>Data</code> type, in the <strong>Output Format</strong> dropdown, select <strong>Raw HTML</strong>.
To output a <code>Message</code> type, in the <strong>Output Format</strong> dropdown, select <strong>Text</strong>. This option applies postprocessing with the <code>data_to_text</code> helper function.</p>
<p>In this example of a document ingestion pipeline, the URL component outputs raw HTML to a text splitter, which splits the raw content into chunks for a vector database to ingest.</p>
<p><img decoding="async" loading="lazy" alt="URL component in a data ingestion pipeline" src="/assets/images/url-component-0ced1fa00ee3b97582421254b6d5be78.png" width="2586" height="1550" class="img_ev3q"></p>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="api-request">API Request<a href="#api-request" class="hash-link" aria-label="Direct link to API Request" title="Direct link to API Request">​</a></h2>
<p>This component makes HTTP requests using URLs or cURL commands.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs">Inputs<a href="#inputs" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>urls</td><td>URLs</td><td>Enter one or more URLs, separated by commas.</td></tr><tr><td>curl</td><td>cURL</td><td>Paste a curl command to populate the dictionary fields for headers and body.</td></tr><tr><td>method</td><td>Method</td><td>The HTTP method to use.</td></tr><tr><td>use_curl</td><td>Use cURL</td><td>Enable cURL mode to populate fields from a cURL command.</td></tr><tr><td>query_params</td><td>Query Parameters</td><td>The query parameters to append to the URL.</td></tr><tr><td>body</td><td>Body</td><td>The body to send with the request as a dictionary (for <code>POST</code>, <code>PATCH</code>, <code>PUT</code>).</td></tr><tr><td>headers</td><td>Headers</td><td>The headers to send with the request as a dictionary.</td></tr><tr><td>timeout</td><td>Timeout</td><td>The timeout to use for the request.</td></tr><tr><td>follow_redirects</td><td>Follow Redirects</td><td>Whether to follow http redirects.</td></tr><tr><td>save_to_file</td><td>Save to File</td><td>Save the API response to a temporary file</td></tr><tr><td>include_httpx_metadata</td><td>Include HTTPx Metadata</td><td>Include properties such as <code>headers</code>, <code>status_code</code>, <code>response_headers</code>, and <code>redirection_history</code> in the output.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs">Outputs<a href="#outputs" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>data</td><td>Data</td><td>The result of the API requests.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="directory">Directory<a href="#directory" class="hash-link" aria-label="Direct link to Directory" title="Direct link to Directory">​</a></h2>
<p>This component recursively loads files from a directory, with options for file types, depth, and concurrency.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-1">Inputs<a href="#inputs-1" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Input</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>path</td><td>MessageTextInput</td><td>Path to the directory to load files from</td></tr><tr><td>types</td><td>MessageTextInput</td><td>File types to load (leave empty to load all types)</td></tr><tr><td>depth</td><td>IntInput</td><td>Depth to search for files</td></tr><tr><td>max_concurrency</td><td>IntInput</td><td>Maximum concurrency for loading files</td></tr><tr><td>load_hidden</td><td>BoolInput</td><td>If true, hidden files are loaded</td></tr><tr><td>recursive</td><td>BoolInput</td><td>If true, the search is recursive</td></tr><tr><td>silent_errors</td><td>BoolInput</td><td>If true, errors do not raise an exception</td></tr><tr><td>use_multithreading</td><td>BoolInput</td><td>If true, multithreading is used</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-1">Outputs<a href="#outputs-1" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Output</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>List[Data]</td><td>Loaded file data from the directory</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="file">File<a href="#file" class="hash-link" aria-label="Direct link to File" title="Direct link to File">​</a></h2>
<p>The FileComponent is a class that loads and parses text files of various supported formats, converting the content into a Data object. It supports multiple file types and provides an option for silent error handling.</p>
<p>The maximum supported file size is 100 MB.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-2">Inputs<a href="#inputs-2" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>path</td><td>Path</td><td>File path to load.</td></tr><tr><td>silent_errors</td><td>Silent Errors</td><td>If true, errors do not raise an exception.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-2">Outputs<a href="#outputs-2" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>data</td><td>Data</td><td>Parsed content of the file as a Data object.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="gmail-loader">Gmail Loader<a href="#gmail-loader" class="hash-link" aria-label="Direct link to Gmail Loader" title="Direct link to Gmail Loader">​</a></h2>
<p>This component loads emails from Gmail using provided credentials and filters.</p>
<p>For more on creating a service account JSON, see <a href="https://developers.google.com/identity/protocols/oauth2/service-account" target="_blank" rel="noopener noreferrer">Service Account JSON</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-3">Inputs<a href="#inputs-3" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Input</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>json_string</td><td>SecretStrInput</td><td>JSON string containing OAuth 2.0 access token information for service account access</td></tr><tr><td>label_ids</td><td>MessageTextInput</td><td>Comma-separated list of label IDs to filter emails</td></tr><tr><td>max_results</td><td>MessageTextInput</td><td>Maximum number of emails to load</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-3">Outputs<a href="#outputs-3" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Output</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>Data</td><td>Loaded email data</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="google-drive-loader">Google Drive Loader<a href="#google-drive-loader" class="hash-link" aria-label="Direct link to Google Drive Loader" title="Direct link to Google Drive Loader">​</a></h2>
<p>This component loads documents from Google Drive using provided credentials and a single document ID.</p>
<p>For more on creating a service account JSON, see <a href="https://developers.google.com/identity/protocols/oauth2/service-account" target="_blank" rel="noopener noreferrer">Service Account JSON</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-4">Inputs<a href="#inputs-4" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Input</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>json_string</td><td>SecretStrInput</td><td>JSON string containing OAuth 2.0 access token information for service account access</td></tr><tr><td>document_id</td><td>MessageTextInput</td><td>Single Google Drive document ID</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-4">Outputs<a href="#outputs-4" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Output</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>docs</td><td>Data</td><td>Loaded document data</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="google-drive-search">Google Drive Search<a href="#google-drive-search" class="hash-link" aria-label="Direct link to Google Drive Search" title="Direct link to Google Drive Search">​</a></h2>
<p>This component searches Google Drive files using provided credentials and query parameters.</p>
<p>For more on creating a service account JSON, see <a href="https://developers.google.com/identity/protocols/oauth2/service-account" target="_blank" rel="noopener noreferrer">Service Account JSON</a>.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-5">Inputs<a href="#inputs-5" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Input</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>token_string</td><td>SecretStrInput</td><td>JSON string containing OAuth 2.0 access token information for service account access</td></tr><tr><td>query_item</td><td>DropdownInput</td><td>The field to query</td></tr><tr><td>valid_operator</td><td>DropdownInput</td><td>Operator to use in the query</td></tr><tr><td>search_term</td><td>MessageTextInput</td><td>The value to search for in the specified query item</td></tr><tr><td>query_string</td><td>MessageTextInput</td><td>The query string used for searching (can be edited manually)</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-5">Outputs<a href="#outputs-5" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Output</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>doc_urls</td><td>List[str]</td><td>URLs of the found documents</td></tr><tr><td>doc_ids</td><td>List[str]</td><td>IDs of the found documents</td></tr><tr><td>doc_titles</td><td>List[str]</td><td>Titles of the found documents</td></tr><tr><td>Data</td><td>Data</td><td>Document titles and URLs in a structured format</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="sql-query">SQL Query<a href="#sql-query" class="hash-link" aria-label="Direct link to SQL Query" title="Direct link to SQL Query">​</a></h2>
<p>This component executes SQL queries on a specified database.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-6">Inputs<a href="#inputs-6" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>query</td><td>Query</td><td>The SQL query to execute.</td></tr><tr><td>database_url</td><td>Database URL</td><td>The URL of the database.</td></tr><tr><td>include_columns</td><td>Include Columns</td><td>Include columns in the result.</td></tr><tr><td>passthrough</td><td>Passthrough</td><td>If an error occurs, return the query instead of raising an exception.</td></tr><tr><td>add_error</td><td>Add Error</td><td>Add the error to the result.</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-6">Outputs<a href="#outputs-6" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>result</td><td>Result</td><td>The result of the SQL query execution.</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="url">URL<a href="#url" class="hash-link" aria-label="Direct link to URL" title="Direct link to URL">​</a></h2>
<p>This component fetches content from one or more URLs, processes the content, and returns it as a list of <a href="/concepts-objects">Data</a> objects.</p>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-7">Inputs<a href="#inputs-7" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>urls</td><td>URLs</td><td>Enter one or more URLs</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-7">Outputs<a href="#outputs-7" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Display Name</th><th>Info</th></tr></thead><tbody><tr><td>data</td><td>Data</td><td>List of Data objects containing fetched content and metadata</td></tr></tbody></table>
<h2 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="webhook">Webhook<a href="#webhook" class="hash-link" aria-label="Direct link to Webhook" title="Direct link to Webhook">​</a></h2>
<p>This component defines a webhook trigger that runs a flow when it receives an HTTP POST request.</p>
<p>If the input is not valid JSON, the component wraps it in a <code>payload</code> object so that it can be processed and still trigger the flow. The component does not require an API key.</p>
<p>When a <strong>Webhook</strong> component is added to the workspace, a new <strong>Webhook cURL</strong> tab becomes available in the <strong>API</strong> pane that contains an HTTP POST request for triggering the webhook component. For example:</p>
<div class="ch-codeblock not-prose" data-ch-theme="github-dark"><div class="ch-code-wrapper ch-code" data-ch-measured="false"><code class="ch-code-scroll-parent"><br><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span>curl -X POST \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> &quot;http://127.0.0.1:7860/api/v1/webhook/**YOUR_FLOW_ID**&quot; \</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -H &#x27;Content-Type: application/json&#x27;\</span></div></div><div><span class="ch-code-line-number">_<!-- -->10</span><div style="display:inline-block;margin-left:16px"><span> -d &#x27;{&quot;any&quot;: &quot;data&quot;}&#x27;</span></div></div><br></code></div></div>
<p>To test the webhook component:</p>
<ol>
<li>Add a <strong>Webhook</strong> component to the flow.</li>
<li>Connect the <strong>Webhook</strong> component&#x27;s <strong>Data</strong> output to the <strong>Data</strong> input of a <a href="/components-processing#data-to-message">Data to Message</a> component.</li>
<li>Connect the <strong>Data to Message</strong> component&#x27;s <strong>Message</strong> output to the <strong>Text</strong> input of a <a href="/components-io#chat-output">Chat Output</a> component.</li>
<li>To send a POST request, copy the code from the <strong>Webhook cURL</strong> tab in the <strong>API</strong> pane and paste it into a terminal.</li>
<li>Send the POST request.</li>
<li>Open the <strong>Playground</strong>.
Your JSON data is posted to the <strong>Chat Output</strong> component, which indicates that the webhook component is correctly triggering the flow.</li>
</ol>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="inputs-8">Inputs<a href="#inputs-8" class="hash-link" aria-label="Direct link to Inputs" title="Direct link to Inputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>data</td><td>String</td><td>JSON payload for testing the webhook component</td></tr></tbody></table>
<h3 class="anchor anchorWithHideOnScrollNavbar_WYt5" id="outputs-8">Outputs<a href="#outputs-8" class="hash-link" aria-label="Direct link to Outputs" title="Direct link to Outputs">​</a></h3>
<table><thead><tr><th>Name</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>output_data</td><td>Data</td><td>Processed data from the webhook input</td></tr></tbody></table></div></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/components-custom-components"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Create custom Python components</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/components-embedding-models"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">Embeddings</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#use-a-data-component-in-a-flow" class="table-of-contents__link toc-highlight">Use a data component in a flow</a></li><li><a href="#api-request" class="table-of-contents__link toc-highlight">API Request</a><ul><li><a href="#inputs" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#directory" class="table-of-contents__link toc-highlight">Directory</a><ul><li><a href="#inputs-1" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-1" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#file" class="table-of-contents__link toc-highlight">File</a><ul><li><a href="#inputs-2" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-2" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#gmail-loader" class="table-of-contents__link toc-highlight">Gmail Loader</a><ul><li><a href="#inputs-3" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-3" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#google-drive-loader" class="table-of-contents__link toc-highlight">Google Drive Loader</a><ul><li><a href="#inputs-4" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-4" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#google-drive-search" class="table-of-contents__link toc-highlight">Google Drive Search</a><ul><li><a href="#inputs-5" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-5" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#sql-query" class="table-of-contents__link toc-highlight">SQL Query</a><ul><li><a href="#inputs-6" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-6" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#url" class="table-of-contents__link toc-highlight">URL</a><ul><li><a href="#inputs-7" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-7" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li><li><a href="#webhook" class="table-of-contents__link toc-highlight">Webhook</a><ul><li><a href="#inputs-8" class="table-of-contents__link toc-highlight">Inputs</a></li><li><a href="#outputs-8" class="table-of-contents__link toc-highlight">Outputs</a></li></ul></li></ul></div></div></div></div></main></div></div></div><div style="position:fixed;right:20px;bottom:20px;z-index:100;display:flex;align-items:center;gap:10px;cursor:pointer"><div style="background-color:#f6f6f6;border-radius:50%;width:48px;height:48px;display:flex;align-items:center;justify-content:center;box-shadow:0 2px 4px rgba(0,0,0,0.1)"><img src="/img/langflow-icon-black-transparent.svg" style="width:40px" alt="Search"></div></div></div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink