Agents
+Agents
Agent components are used to define the behavior and capabilities of AI agents in your flow. Agents can interact with APIs, databases, and other services, but can also use LLMs as a reasoning engine to decide which course to take in your flow.
CSV Agent
This component creates a CSV agent from a CSV file and LLM.
diff --git a/Components/components-memories.html b/Components/components-memories.html index ebd4a1b327..203f4a70ea 100644 --- a/Components/components-memories.html +++ b/Components/components-memories.html @@ -10,13 +10,13 @@ - - + + -Memories
+Memories
Chat memory components store and retrieve chat messages by session_id.
AstraDBChatMemory Component
This component creates an AstraDBChatMessageHistory instance, which allows for storing and retrieving chat messages using Astra DB, a cloud-native database service.
Tools
+Tools
Tool components are used to interact with external services, APIs, and tools. They can be used to search the web, query databases, and perform other tasks.
Bing Search API
This component allows you to call the Bing Search API.
@@ -74,7 +74,7 @@Parameters
Inputs
| Name | Type | Description |
|---|---|---|
| retriever | BaseRetriever | The retriever to interact with |
| name | String | The name of the tool |
| description | String | A description of the tool's functionality |
Outputs
+Outputs
| Name | Type | Description |
|---|---|---|
| tool | Tool | Retriever tool for use in LangChain |
SearXNG Search Tool
This component creates a tool for searching using SearXNG, a metasearch engine.
@@ -91,7 +91,7 @@| Name | Display Name | Info |
|---|---|---|
| engine | Engine | The search engine to use (default: "google") |
| api_key | SearchAPI API Key | The API key for authenticating with SearchAPI |
| input_value | Input | The search query or input for the API call |
| search_params | Search parameters | Additional parameters for customizing the search |
Outputs
| Name | Display Name | Info |
|---|---|---|
| data | Search Results | List of Data objects containing search results |
| tool | Search API Tool | A Tool object for use in LangChain workflows |
Serp Search API
+Serp Search API
This component creates a tool for searching using the Serp API.
Parameters
Inputs
diff --git a/Starter-Projects/starter-projects-dynamic-agent.html b/Starter-Projects/starter-projects-dynamic-agent.html index 0f03a1e02b..658c48e82d 100644 --- a/Starter-Projects/starter-projects-dynamic-agent.html +++ b/Starter-Projects/starter-projects-dynamic-agent.html @@ -10,13 +10,13 @@ - - + + -Dynamic Agent
+Dynamic Agent
Build a Dynamic Agent flow for an agentic application using the CrewAI.
An agent uses an LLM as its "brain" to reason through tasks and select among the connected tools to complete them.
This flow uses CrewAI to manage a Hierarchical crew of Agents as they perform a sequence of Tasks.
diff --git a/Starter-Projects/starter-projects-simple-agent.html b/Starter-Projects/starter-projects-simple-agent.html index f485676938..a98769e8cc 100644 --- a/Starter-Projects/starter-projects-simple-agent.html +++ b/Starter-Projects/starter-projects-simple-agent.html @@ -10,13 +10,13 @@ - - + + -Simple Agent
Build a Simple Agent flow for an agentic application using the Tool-calling agent.
An agent uses an LLM as its "brain" to select among the connected tools and complete its tasks.
diff --git a/Starter-Projects/starter-projects-travel-planning-agent.html b/Starter-Projects/starter-projects-travel-planning-agent.html index d242ef9be0..65f38fc31a 100644 --- a/Starter-Projects/starter-projects-travel-planning-agent.html +++ b/Starter-Projects/starter-projects-travel-planning-agent.html @@ -10,13 +10,13 @@ - - + + -Travel Planning Agent
+Travel Planning Agent
Build a Travel Planning Agent flow for an agentic application using the multiple Tool-calling agents.
An agent uses an LLM as its "brain" to select among the connected tools and complete its tasks.
In this flow, multiple Tool-calling agents reason using an Open AI LLM to plan a travel journey. Each agent is given a different responsibility defined by its System Prompt field.
diff --git a/assets/images/683296796-497b95fbdb9c6efd3857e059c6efd0a7.png b/assets/images/683296796-497b95fbdb9c6efd3857e059c6efd0a7.png deleted file mode 100644 index 66965f8ed5..0000000000 Binary files a/assets/images/683296796-497b95fbdb9c6efd3857e059c6efd0a7.png and /dev/null differ diff --git a/assets/js/19136925.6473b46e.js b/assets/js/19136925.6473b46e.js new file mode 100644 index 0000000000..73e0b409fa --- /dev/null +++ b/assets/js/19136925.6473b46e.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[9141],{9813:(o,e,n)=>{n.r(e),n.d(e,{assets:()=>r,contentTitle:()=>c,default:()=>m,frontMatter:()=>i,metadata:()=>l,toc:()=>a});var t=n(4848),s=n(8453);const i={title:"Contribute components",sidebar_position:4,slug:"/contributing-components"},c=void 0,l={id:"Contributing/contributing-components",title:"Contribute components",description:"New components are added as objects of the\xa0CustomComponent\xa0class.",source:"@site/docs/Contributing/contributing-components.md",sourceDirName:"Contributing",slug:"/contributing-components",permalink:"/contributing-components",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:4,frontMatter:{title:"Contribute components",sidebar_position:4,slug:"/contributing-components"},sidebar:"defaultSidebar",previous:{title:"Ask for help on the Discussions board",permalink:"/contributing-github-discussions"},next:{title:"Join the Langflow community",permalink:"/contributing-community"}},r={},a=[{value:"Contribute an example component to Langflow",id:"contribute-an-example-component-to-langflow",level:3}];function d(o){const e={a:"a",code:"code",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",...(0,s.R)(),...o.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsxs)(e.p,{children:["New components are added as objects of the\xa0",(0,t.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/custom/custom_component/custom_component.py",children:"CustomComponent"}),"\xa0class."]}),"\n",(0,t.jsxs)(e.p,{children:["Any dependencies are added to the\xa0",(0,t.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow/blob/main/pyproject.toml#L148",children:"pyproject.toml"}),"\xa0file."]}),"\n",(0,t.jsx)(e.h3,{id:"contribute-an-example-component-to-langflow",children:"Contribute an example component to Langflow"}),"\n",(0,t.jsxs)(e.p,{children:["Anyone can contribute an example component. For example, if you created a new document loader called\xa0",(0,t.jsx)(e.strong,{children:"MyCustomDocumentLoader"}),", you can follow these steps to contribute it to Langflow."]}),"\n",(0,t.jsxs)(e.ol,{children:["\n",(0,t.jsxs)(e.li,{children:["Write your loader as an object of the\xa0",(0,t.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/custom/custom_component/custom_component.py",children:"CustomComponent"}),"\xa0class. You'll create a new class,\xa0",(0,t.jsx)(e.code,{children:"MyCustomDocumentLoader"}),", that will inherit from\xa0",(0,t.jsx)(e.code,{children:"CustomComponent"}),"\xa0and override the base class's methods."]}),"\n",(0,t.jsxs)(e.li,{children:["Define optional attributes like\xa0",(0,t.jsx)(e.code,{children:"display_name"}),",\xa0",(0,t.jsx)(e.code,{children:"description"}),", and\xa0",(0,t.jsx)(e.code,{children:"documentation"}),"\xa0to provide information about your custom component."]}),"\n",(0,t.jsxs)(e.li,{children:["Implement the\xa0",(0,t.jsx)(e.code,{children:"build_config"}),"\xa0method to define the configuration options for your custom component."]}),"\n",(0,t.jsxs)(e.li,{children:["Implement the\xa0",(0,t.jsx)(e.code,{children:"build"}),"\xa0method to define the logic for taking input parameters specified in the\xa0",(0,t.jsx)(e.code,{children:"build_config"}),"\xa0method and returning the desired output."]}),"\n",(0,t.jsxs)(e.li,{children:["Add the code to the\xa0",(0,t.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow/tree/dev/src/backend/base/langflow/components",children:"/components/documentloaders"}),"\xa0folder."]}),"\n",(0,t.jsxs)(e.li,{children:["Add the dependency to\xa0",(0,t.jsxs)(e.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/components/documentloaders/__init__.py",children:["/documentloaders/",(0,t.jsx)(e.strong,{children:"init"}),".py"]}),"\xa0as\xa0",(0,t.jsx)(e.code,{children:"from .MyCustomDocumentLoader import MyCustomDocumentLoader"}),"."]}),"\n",(0,t.jsxs)(e.li,{children:["Add any new dependencies to the\xa0",(0,t.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow/blob/main/pyproject.toml#L148",children:"pyproject.toml"}),"\xa0file."]}),"\n",(0,t.jsxs)(e.li,{children:["Submit documentation for your component. For this example, you'd submit documentation to the\xa0",(0,t.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow/blob/main/docs/docs/Components/components-loaders.md",children:"loaders page"}),"."]}),"\n",(0,t.jsx)(e.li,{children:"Submit your changes as a pull request. The Langflow team will have a look, suggest changes, and add your component to Langflow."}),"\n"]})]})}function m(o={}){const{wrapper:e}={...(0,s.R)(),...o.components};return e?(0,t.jsx)(e,{...o,children:(0,t.jsx)(d,{...o})}):d(o)}},8453:(o,e,n)=>{n.d(e,{R:()=>c,x:()=>l});var t=n(6540);const s={},i=t.createContext(s);function c(o){const e=t.useContext(i);return t.useMemo((function(){return"function"==typeof o?o(e):{...e,...o}}),[e,o])}function l(o){let e;return e=o.disableParentContext?"function"==typeof o.components?o.components(s):o.components||s:c(o.components),t.createElement(i.Provider,{value:e},o.children)}}}]); \ No newline at end of file diff --git a/assets/js/20e9af62.8d63ec91.js b/assets/js/20e9af62.8d63ec91.js deleted file mode 100644 index 9b20787f8a..0000000000 --- a/assets/js/20e9af62.8d63ec91.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[5562],{8096:(n,e,t)=>{t.r(e),t.d(e,{assets:()=>l,contentTitle:()=>r,default:()=>d,frontMatter:()=>i,metadata:()=>a,toc:()=>c});var o=t(4848),s=t(8453);const i={title:"Community",sidebar_position:3,slug:"/contributing-community"},r=void 0,a={id:"Contributing/contributing-community",title:"Community",description:"\ud83e\udd16 Join\xa0Langflow\xa0Discord server",source:"@site/docs/Contributing/contributing-community.md",sourceDirName:"Contributing",slug:"/contributing-community",permalink:"/contributing-community",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Community",sidebar_position:3,slug:"/contributing-community"},sidebar:"defaultSidebar",previous:{title:"GitHub Issues",permalink:"/contributing-github-issues"}},l={},c=[{value:"\ud83e\udd16 Join\xa0Langflow\xa0Discord server",id:"80011e0bda004e83a8012c7ec6eab29a",level:2},{value:"\ud83d\udc26 Stay tuned for\xa0Langflow\xa0on Twitter",id:"6a17ba5905ad4f7aa5347af7854779f6",level:2},{value:"\u2b50\ufe0f Star\xa0Langflow\xa0on GitHub",id:"c903a569934643799bf52b7d1b3514e1",level:2},{value:"\ud83d\udc40 Watch the GitHub repository for releases",id:"d0a089ed717742308bd17430e5ae6309",level:2}];function u(n){const e={a:"a",h2:"h2",hr:"hr",p:"p",strong:"strong",...(0,s.R)(),...n.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(e.h2,{id:"80011e0bda004e83a8012c7ec6eab29a",children:["\ud83e\udd16 Join\xa0",(0,o.jsx)(e.strong,{children:"Langflow"}),"\xa0Discord server"]}),"\n",(0,o.jsx)(e.hr,{}),"\n",(0,o.jsx)(e.p,{children:"Join us to ask questions and showcase your projects."}),"\n",(0,o.jsx)(e.p,{children:"Let's bring together the building blocks of AI integration!"}),"\n",(0,o.jsxs)(e.p,{children:["Langflow\xa0",(0,o.jsx)(e.a,{href:"https://discord.gg/EqksyE2EX9",children:"Discord"}),"\xa0server."]}),"\n",(0,o.jsxs)(e.h2,{id:"6a17ba5905ad4f7aa5347af7854779f6",children:["\ud83d\udc26 Stay tuned for\xa0",(0,o.jsx)(e.strong,{children:"Langflow"}),"\xa0on Twitter"]}),"\n",(0,o.jsx)(e.hr,{}),"\n",(0,o.jsxs)(e.p,{children:["Follow\xa0",(0,o.jsx)(e.a,{href:"https://twitter.com/langflow_ai",children:"@langflow_ai"}),"\xa0on\xa0",(0,o.jsx)(e.strong,{children:"Twitter"}),"\xa0to get the latest news about\xa0",(0,o.jsx)(e.strong,{children:"Langflow"}),"."]}),"\n",(0,o.jsxs)(e.h2,{id:"c903a569934643799bf52b7d1b3514e1",children:["\u2b50\ufe0f Star\xa0",(0,o.jsx)(e.strong,{children:"Langflow"}),"\xa0on GitHub"]}),"\n",(0,o.jsx)(e.hr,{}),"\n",(0,o.jsxs)(e.p,{children:['You can "star"\xa0',(0,o.jsx)(e.strong,{children:"Langflow"}),"\xa0in\xa0",(0,o.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow",children:"GitHub"}),"."]}),"\n",(0,o.jsx)(e.p,{children:"By adding a star, other users will be able to find it more easily and see that it has been already useful for others."}),"\n",(0,o.jsx)(e.h2,{id:"d0a089ed717742308bd17430e5ae6309",children:"\ud83d\udc40 Watch the GitHub repository for releases"}),"\n",(0,o.jsx)(e.hr,{}),"\n",(0,o.jsxs)(e.p,{children:['You can "watch"\xa0',(0,o.jsx)(e.strong,{children:"Langflow"}),"\xa0in\xa0",(0,o.jsx)(e.a,{href:"https://github.com/langflow-ai/langflow",children:"GitHub"}),'. If you select "Watching" instead of "Releases only" you will receive notifications when someone creates a new issue or question. You can also specify that you only want to be notified about new issues, discussions, PRs, etc. so you can try and help them solve those questions.']})]})}function d(n={}){const{wrapper:e}={...(0,s.R)(),...n.components};return e?(0,o.jsx)(e,{...n,children:(0,o.jsx)(u,{...n})}):u(n)}},8453:(n,e,t)=>{t.d(e,{R:()=>r,x:()=>a});var o=t(6540);const s={},i=o.createContext(s);function r(n){const e=o.useContext(i);return o.useMemo((function(){return"function"==typeof n?n(e):{...e,...n}}),[e,n])}function a(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(s):n.components||s:r(n.components),o.createElement(i.Provider,{value:e},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/20e9af62.e31ab0c8.js b/assets/js/20e9af62.e31ab0c8.js new file mode 100644 index 0000000000..f279749002 --- /dev/null +++ b/assets/js/20e9af62.e31ab0c8.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[5562],{8096:(n,o,e)=>{e.r(o),e.d(o,{assets:()=>a,contentTitle:()=>r,default:()=>h,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var t=e(4848),i=e(8453);const s={title:"Join the Langflow community",sidebar_position:5,slug:"/contributing-community"},r=void 0,l={id:"Contributing/contributing-community",title:"Join the Langflow community",description:"Join the Langflow Discord server",source:"@site/docs/Contributing/contributing-community.md",sourceDirName:"Contributing",slug:"/contributing-community",permalink:"/contributing-community",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:5,frontMatter:{title:"Join the Langflow community",sidebar_position:5,slug:"/contributing-community"},sidebar:"defaultSidebar",previous:{title:"Contribute components",permalink:"/contributing-components"}},a={},c=[{value:"Join the Langflow Discord server",id:"join-the-langflow-discord-server",level:2},{value:"Follow Langflow on X",id:"follow-langflow-on-x",level:2},{value:"Star\xa0Langflow\xa0on GitHub",id:"starlangflowon-github",level:2},{value:"Watch the GitHub repository for releases",id:"watch-the-github-repository-for-releases",level:2}];function u(n){const o={a:"a",h2:"h2",p:"p",strong:"strong",...(0,i.R)(),...n.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(o.h2,{id:"join-the-langflow-discord-server",children:"Join the Langflow Discord server"}),"\n",(0,t.jsxs)(o.p,{children:["Join the ",(0,t.jsx)(o.a,{href:"https://discord.gg/EqksyE2EX9",children:"Langflow Discord Server"})," to ask questions and showcase your projects."]}),"\n",(0,t.jsx)(o.h2,{id:"follow-langflow-on-x",children:"Follow Langflow on X"}),"\n",(0,t.jsxs)(o.p,{children:["Follow\xa0",(0,t.jsx)(o.a,{href:"https://twitter.com/langflow_ai",children:"@langflow_ai"}),"\xa0on\xa0X\xa0to get the latest news about\xa0Langflow."]}),"\n",(0,t.jsx)(o.h2,{id:"starlangflowon-github",children:"Star\xa0Langflow\xa0on GitHub"}),"\n",(0,t.jsxs)(o.p,{children:["You can ",(0,t.jsx)(o.a,{href:"https://github.com/langflow-ai/langflow",children:"star\xa0Langflow\xa0in\xa0GitHub"}),"."]}),"\n",(0,t.jsx)(o.p,{children:"By adding a star, other users will be able to find Langflow more easily, and see that it has been already useful for others."}),"\n",(0,t.jsx)(o.h2,{id:"watch-the-github-repository-for-releases",children:"Watch the GitHub repository for releases"}),"\n",(0,t.jsxs)(o.p,{children:["You can ",(0,t.jsx)(o.a,{href:"https://github.com/langflow-ai/langflow",children:"watch Langflow in GitHub"}),". If you select ",(0,t.jsx)(o.strong,{children:"Watching"})," instead of ",(0,t.jsx)(o.strong,{children:"Releases only"})," you will receive notifications when someone creates a new issue or question. You can also specify that you want to be notified only about new issues, discussions, and PRs so you can try to help solve those issues."]})]})}function h(n={}){const{wrapper:o}={...(0,i.R)(),...n.components};return o?(0,t.jsx)(o,{...n,children:(0,t.jsx)(u,{...n})}):u(n)}},8453:(n,o,e)=>{e.d(o,{R:()=>r,x:()=>l});var t=e(6540);const i={},s=t.createContext(i);function r(n){const o=t.useContext(s);return t.useMemo((function(){return"function"==typeof n?n(o):{...o,...n}}),[o,n])}function l(n){let o;return o=n.disableParentContext?"function"==typeof n.components?n.components(i):n.components||i:r(n.components),t.createElement(s.Provider,{value:o},n.children)}}}]); \ No newline at end of file diff --git a/assets/js/22dd74f7.234c10a6.js b/assets/js/22dd74f7.234c10a6.js deleted file mode 100644 index dcc2ac41a2..0000000000 --- a/assets/js/22dd74f7.234c10a6.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[1567],{5226:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"category","label":"What\u2019s New?","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"1.0 - A new chapter for Langflow","href":"/whats-new-a-new-chapter-langflow","docId":"What\u2019s-New/whats-new-a-new-chapter-langflow","unlisted":false}]},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"\ud83d\udc4b\xa0Welcome to Langflow","href":"/","docId":"Getting-Started/\ud83d\udc4b\xa0Welcome-to-Langflow","unlisted":false},{"type":"link","label":"\ud83d\udce6\xa0Installation","href":"/getting-started-installation","docId":"Getting-Started/getting-started-installation","unlisted":false},{"type":"link","label":"\u26a1\ufe0f Quickstart","href":"/getting-started-quickstart","docId":"Getting-Started/getting-started-quickstart","unlisted":false},{"type":"link","label":"\u2757\ufe0f Common Installation Issues","href":"/getting-started-common-installation-issues","docId":"Getting-Started/getting-started-common-installation-issues","unlisted":false}]},{"type":"category","label":"Starter Projects","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Basic Prompting","href":"/starter-projects-basic-prompting","docId":"Starter-Projects/starter-projects-basic-prompting","unlisted":false},{"type":"link","label":"Blog Writer","href":"/starter-projects-blog-writer","docId":"Starter-Projects/starter-projects-blog-writer","unlisted":false},{"type":"link","label":"Document QA","href":"/starter-projects-document-qa","docId":"Starter-Projects/starter-projects-document-qa","unlisted":false},{"type":"link","label":"Memory Chatbot","href":"/starter-projects-memory-chatbot","docId":"Starter-Projects/starter-projects-memory-chatbot","unlisted":false},{"type":"link","label":"Vector Store RAG","href":"/starter-projects-vector-store-rag","docId":"Starter-Projects/starter-projects-vector-store-rag","unlisted":false},{"type":"link","label":"Dynamic Agent","href":"/Starter-Projects/starter-projects-dynamic-agent","docId":"Starter-Projects/starter-projects-dynamic-agent","unlisted":false},{"type":"link","label":"Simple Agent","href":"/Starter-Projects/starter-projects-simple-agent","docId":"Starter-Projects/starter-projects-simple-agent","unlisted":false},{"type":"link","label":"Travel Planning Agent","href":"/Starter-Projects/starter-projects-travel-planning-agent","docId":"Starter-Projects/starter-projects-travel-planning-agent","unlisted":false}]},{"type":"category","label":"Guides","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"\ud83d\udcda New to LLMs?","href":"/guides-new-to-llms","docId":"Guides/guides-new-to-llms","unlisted":false},{"type":"link","label":"Chat Memory","href":"/guides-chat-memory","docId":"Guides/guides-chat-memory","unlisted":false},{"type":"link","label":"Data & Message","href":"/guides-data-message","docId":"Guides/guides-data-message","unlisted":false}]},{"type":"category","label":"Workspace","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Workspace concepts","href":"/workspace-overview","docId":"Workspace/workspace-overview","unlisted":false},{"type":"link","label":"API","href":"/workspace-api","docId":"Workspace/workspace-api","unlisted":false},{"type":"link","label":"Playground","href":"/workspace-playground","docId":"Workspace/workspace-playground","unlisted":false},{"type":"link","label":"Logs","href":"/workspace-logs","docId":"Workspace/workspace-logs","unlisted":false}]},{"type":"category","label":"Components","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"How to build flows with components","href":"/components-overview","docId":"Components/components-overview","unlisted":false},{"type":"link","label":"Inputs & Outputs","href":"/components-io","docId":"Components/components-io","unlisted":false},{"type":"link","label":"Prompts","href":"/components-prompts","docId":"Components/components-prompts","unlisted":false},{"type":"link","label":"Data","href":"/components-data","docId":"Components/components-data","unlisted":false},{"type":"link","label":"Helpers","href":"/components-helpers","docId":"Components/components-helpers","unlisted":false},{"type":"link","label":"Models","href":"/components-models","docId":"Components/components-models","unlisted":false},{"type":"link","label":"Embedding Models","href":"/components-embedding-models","docId":"Components/components-embedding-models","unlisted":false},{"type":"link","label":"Vector Stores","href":"/components-vector-stores","docId":"Components/components-vector-stores","unlisted":false},{"type":"link","label":"Custom Components","href":"/components-custom-components","docId":"Components/components-custom-components","unlisted":false},{"type":"link","label":"RAG","href":"/components-rag","docId":"Components/components-rag","unlisted":false},{"type":"link","label":"Loaders","href":"/components-loaders","docId":"Components/components-loaders","unlisted":false},{"type":"link","label":"Agents","href":"/Components/components-agents","docId":"Components/components-agents","unlisted":false},{"type":"link","label":"Memories","href":"/Components/components-memories","docId":"Components/components-memories","unlisted":false},{"type":"link","label":"Tools","href":"/Components/components-tools","docId":"Components/components-tools","unlisted":false}]},{"type":"category","label":"Deployment","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"\ud83e\udd17\xa0Spaces","href":"/deployment-hugging-face-spaces","docId":"Deployment/deployment-hugging-face-spaces","unlisted":false},{"type":"link","label":"Kubernetes","href":"/deployment-kubernetes","docId":"Deployment/deployment-kubernetes","unlisted":false},{"type":"link","label":"Docker","href":"/deployment-docker","docId":"Deployment/deployment-docker","unlisted":false},{"type":"link","label":"GCP","href":"/deployment-gcp","docId":"Deployment/deployment-gcp","unlisted":false},{"type":"link","label":"Render","href":"/deployment-render","docId":"Deployment/deployment-render","unlisted":false},{"type":"link","label":"Railway","href":"/deployment-railway","docId":"Deployment/deployment-railway","unlisted":false}]},{"type":"category","label":"Configuration","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Authentication","href":"/configuration-authentication","docId":"Configuration/configuration-authentication","unlisted":false},{"type":"link","label":"API keys","href":"/configuration-api-keys","docId":"Configuration/configuration-api-keys","unlisted":false},{"type":"link","label":"Langflow CLI","href":"/configuration-cli","docId":"Configuration/configuration-cli","unlisted":false},{"type":"link","label":"Run Langflow in backend-only mode","href":"/configuration-backend-only","docId":"Configuration/configuration-backend-only","unlisted":false},{"type":"link","label":"Global variables","href":"/configuration-global-variables","docId":"Configuration/configuration-global-variables","unlisted":false},{"type":"link","label":"Auto-saving","href":"/configuration-auto-save","docId":"Configuration/configuration-auto-saving","unlisted":false},{"type":"link","label":"Environment variables","href":"/environment-variables","docId":"Configuration/environment-variables","unlisted":false}]},{"type":"category","label":"Integrations","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"AssemblyAI","href":"/integrations-assemblyai","docId":"Integrations/integrations-assemblyai","unlisted":false},{"type":"category","label":"Google","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Setup Google OAuth for Langflow Integration","href":"/integrations-setup-google-oauth-langflow","docId":"Integrations/Google/integrations-setup-google-oauth-langflow","unlisted":false}]},{"type":"link","label":"Langfuse","href":"/integrations-langfuse","docId":"Integrations/integrations-langfuse","unlisted":false},{"type":"link","label":"LangSmith","href":"/integrations-langsmith","docId":"Integrations/integrations-langsmith","unlisted":false},{"type":"link","label":"LangWatch","href":"/integrations-langwatch","docId":"Integrations/integrations-langwatch","unlisted":false},{"type":"category","label":"Notion","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Setup","href":"/integrations/notion/setup","docId":"Integrations/Notion/integrations-notion","unlisted":false},{"type":"link","label":"Notion Meeting Notes Agent","href":"/integrations/notion/notion-agent-meeting-notes","docId":"Integrations/Notion/notion-agent-meeting-notes","unlisted":false},{"type":"link","label":"Notion Conversational Agent","href":"/integrations/notion/notion-agent-conversational","docId":"Integrations/Notion/notion-agent-conversational","unlisted":false}]}]},{"type":"category","label":"Contributing","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Telemetry","href":"/contributing-telemetry","docId":"Contributing/contributing-telemetry","unlisted":false},{"type":"link","label":"How to contribute?","href":"/contributing-how-to-contribute","docId":"Contributing/contributing-how-to-contribute","unlisted":false},{"type":"link","label":"GitHub Issues","href":"/contributing-github-issues","docId":"Contributing/contributing-github-issues","unlisted":false},{"type":"link","label":"Community","href":"/contributing-community","docId":"Contributing/contributing-community","unlisted":false}]}]},"docs":{"Components/components-agents":{"id":"Components/components-agents","title":"Agents","description":"Agent components are used to define the behavior and capabilities of AI agents in your flow. Agents can interact with APIs, databases, and other services, but can also use LLMs as a reasoning engine to decide which course to take in your flow.","sidebar":"defaultSidebar"},"Components/components-custom-components":{"id":"Components/components-custom-components","title":"Custom Components","description":"Custom components are created within Langflow and extend the platform\'s functionality with custom, resusable Python code.","sidebar":"defaultSidebar"},"Components/components-data":{"id":"Components/components-data","title":"Data","description":"API Request","sidebar":"defaultSidebar"},"Components/components-embedding-models":{"id":"Components/components-embedding-models","title":"Embedding Models","description":"Embeddings models are used to convert text into numerical vectors. These vectors can be used for various tasks such as similarity search, clustering, and classification.","sidebar":"defaultSidebar"},"Components/components-helpers":{"id":"Components/components-helpers","title":"Helpers","description":"Helper components provide utility functions to help manage data, tasks, and other components in your flow.","sidebar":"defaultSidebar"},"Components/components-io":{"id":"Components/components-io","title":"Inputs & Outputs","description":"This category of components defines where data enters and exits your flow. They dynamically alter the Playground and can be renamed to facilitate building and maintaining your flows.","sidebar":"defaultSidebar"},"Components/components-loaders":{"id":"Components/components-loaders","title":"Loaders","description":"Loaders are components used to load documents from various sources, such as databases, websites, and local files. They can be used to fetch data from external sources and convert it into a format that can be processed by other components.","sidebar":"defaultSidebar"},"Components/components-memories":{"id":"Components/components-memories","title":"Memories","description":"Chat memory components store and retrieve chat messages by session_id.","sidebar":"defaultSidebar"},"Components/components-models":{"id":"Components/components-models","title":"Models","description":"Model components are used to generate text using language models. These components can be used to generate text for various tasks such as chatbots, content generation, and more.","sidebar":"defaultSidebar"},"Components/components-overview":{"id":"Components/components-overview","title":"How to build flows with components","description":"A\xa0component\xa0is a single building block within a flow. It consists of inputs, outputs, and parameters that define their functionality. These elements provide a convenient and straightforward way to compose LLM-based applications. Learn more about components and how they work below.","sidebar":"defaultSidebar"},"Components/components-prompts":{"id":"Components/components-prompts","title":"Prompts","description":"A prompt serves as the input to a language model, comprising multiple components that can be parameterized using prompt templates.","sidebar":"defaultSidebar"},"Components/components-rag":{"id":"Components/components-rag","title":"RAG","description":"RAG (Retrieval-Augmented Generation) components process a user query by retrieving relevant documents and generating a concise summary that addresses the user\'s question.","sidebar":"defaultSidebar"},"Components/components-tools":{"id":"Components/components-tools","title":"Tools","description":"Tool components are used to interact with external services, APIs, and tools. They can be used to search the web, query databases, and perform other tasks.","sidebar":"defaultSidebar"},"Components/components-vector-stores":{"id":"Components/components-vector-stores","title":"Vector Stores","description":"Vector databases are used to store and search for vectors. They can be used to store embeddings, search for similar vectors, and perform other vector operations.","sidebar":"defaultSidebar"},"Configuration/configuration-api-keys":{"id":"Configuration/configuration-api-keys","title":"API keys","description":"Langflow provides an API key functionality that allows users to access their individual components and flows without traditional login authentication. The API key is a user-specific token that can be included in the request header, query parameter, or as a command line argument to authenticate API calls. This documentation outlines how to generate, use, and manage API keys in Langflow.","sidebar":"defaultSidebar"},"Configuration/configuration-authentication":{"id":"Configuration/configuration-authentication","title":"Authentication","description":"The login functionality in Langflow serves to authenticate users and protect sensitive routes in the application.","sidebar":"defaultSidebar"},"Configuration/configuration-auto-saving":{"id":"Configuration/configuration-auto-saving","title":"Auto-saving","description":"Langflow currently supports both manual and auto-saving functionality.","sidebar":"defaultSidebar"},"Configuration/configuration-backend-only":{"id":"Configuration/configuration-backend-only","title":"Run Langflow in backend-only mode","description":"Langflow can run in --backend-only mode to expose a Langflow app as an API endpoint, without running the frontend UI.","sidebar":"defaultSidebar"},"Configuration/configuration-cli":{"id":"Configuration/configuration-cli","title":"Langflow CLI","description":"The Langflow command line interface (Langflow CLI) is the main interface for managing and running the Langflow server.","sidebar":"defaultSidebar"},"Configuration/configuration-global-variables":{"id":"Configuration/configuration-global-variables","title":"Global variables","description":"Global variables let you store and reuse generic input values and credentials across your projects.","sidebar":"defaultSidebar"},"Configuration/environment-variables":{"id":"Configuration/environment-variables","title":"Environment variables","description":"Langflow lets you configure a number of settings using environment variables.","sidebar":"defaultSidebar"},"Contributing/contributing-community":{"id":"Contributing/contributing-community","title":"Community","description":"\ud83e\udd16 Join\xa0Langflow\xa0Discord server","sidebar":"defaultSidebar"},"Contributing/contributing-github-issues":{"id":"Contributing/contributing-github-issues","title":"GitHub Issues","description":"Our\xa0issues\xa0page is kept up to date with bugs, improvements, and feature requests. There is a taxonomy of labels to help with sorting and discovery of issues of interest.","sidebar":"defaultSidebar"},"Contributing/contributing-how-to-contribute":{"id":"Contributing/contributing-how-to-contribute","title":"How to contribute?","description":"This page may contain outdated information. It will be updated as soon as possible.","sidebar":"defaultSidebar"},"Contributing/contributing-telemetry":{"id":"Contributing/contributing-telemetry","title":"Telemetry","description":"This page may contain outdated information. It will be updated as soon as possible.","sidebar":"defaultSidebar"},"Deployment/deployment-docker":{"id":"Deployment/deployment-docker","title":"Docker","description":"This guide will help you get LangFlow up and running using Docker and Docker Compose.","sidebar":"defaultSidebar"},"Deployment/deployment-gcp":{"id":"Deployment/deployment-gcp","title":"GCP","description":"To deploy Langflow on Google Cloud Platform using Cloud Shell, use the below script.","sidebar":"defaultSidebar"},"Deployment/deployment-hugging-face-spaces":{"id":"Deployment/deployment-hugging-face-spaces","title":"\ud83e\udd17\xa0Spaces","description":"HuggingFace Spaces","sidebar":"defaultSidebar"},"Deployment/deployment-kubernetes":{"id":"Deployment/deployment-kubernetes","title":"Kubernetes","description":"This guide will help you get LangFlow up and running in Kubernetes cluster, including the following steps:","sidebar":"defaultSidebar"},"Deployment/deployment-railway":{"id":"Deployment/deployment-railway","title":"Railway","description":"Deploy on Railway","sidebar":"defaultSidebar"},"Deployment/deployment-render":{"id":"Deployment/deployment-render","title":"Render","description":"Deploy on Render","sidebar":"defaultSidebar"},"Getting-Started/\ud83d\udc4b\xa0Welcome-to-Langflow":{"id":"Getting-Started/\ud83d\udc4b\xa0Welcome-to-Langflow","title":"\ud83d\udc4b\xa0Welcome to Langflow","description":"Introduction","sidebar":"defaultSidebar"},"Getting-Started/getting-started-common-installation-issues":{"id":"Getting-Started/getting-started-common-installation-issues","title":"\u2757\ufe0f Common Installation Issues","description":"This is a list of possible issues that you may encounter when installing Langflow and how to solve them.","sidebar":"defaultSidebar"},"Getting-Started/getting-started-installation":{"id":"Getting-Started/getting-started-installation","title":"\ud83d\udce6\xa0Installation","description":"DataStax Langflow","sidebar":"defaultSidebar"},"Getting-Started/getting-started-quickstart":{"id":"Getting-Started/getting-started-quickstart","title":"\u26a1\ufe0f Quickstart","description":"Prerequisites","sidebar":"defaultSidebar"},"Guides/guides-chat-memory":{"id":"Guides/guides-chat-memory","title":"Chat Memory","description":"Langflow allows every chat message to be stored, and a single flow can have multiple memory sessions. This enables you to create separate memories for agents to store and recall information as needed.","sidebar":"defaultSidebar"},"Guides/guides-data-message":{"id":"Guides/guides-data-message","title":"Data & Message","description":"In Langflow, the\xa0Data\xa0and\xa0Message\xa0objects serve as structured, functional representations of data that enhance the capabilities and reliability of the platform.","sidebar":"defaultSidebar"},"Guides/guides-new-to-llms":{"id":"Guides/guides-new-to-llms","title":"\ud83d\udcda New to LLMs?","description":"Large Language Models, or LLMs, are part of an exciting new world in computing.","sidebar":"defaultSidebar"},"Integrations/Google/integrations-setup-google-oauth-langflow":{"id":"Integrations/Google/integrations-setup-google-oauth-langflow","title":"Setup Google OAuth for Langflow Integration","description":"A comprehensive guide on creating a Google OAuth app, obtaining tokens, and integrating them with Langflow\'s Google components.","sidebar":"defaultSidebar"},"Integrations/integrations-assemblyai":{"id":"Integrations/integrations-assemblyai","title":"AssemblyAI","description":"The AssemblyAI components allow you to apply powerful Speech AI models to your app for tasks like:","sidebar":"defaultSidebar"},"Integrations/integrations-langfuse":{"id":"Integrations/integrations-langfuse","title":"Langfuse","description":"Langfuse is an observability and analytics platform specifically designed for language models and AI applications.","sidebar":"defaultSidebar"},"Integrations/integrations-langsmith":{"id":"Integrations/integrations-langsmith","title":"LangSmith","description":"LangSmith is a full-lifecycle DevOps service from LangChain that provides monitoring and observability. To integrate with Langflow, just add your LangChain API key as a Langflow environment variable and you are good to go!","sidebar":"defaultSidebar"},"Integrations/integrations-langwatch":{"id":"Integrations/integrations-langwatch","title":"LangWatch","description":"938674091aac4d9d9aa4aa6eb5c215b4}","sidebar":"defaultSidebar"},"Integrations/Notion/integrations-notion":{"id":"Integrations/Notion/integrations-notion","title":"Setup","description":"To use Notion components in Langflow, you first need to create a Notion integration and configure it with the necessary capabilities. This guide will walk you through the process of setting up a Notion integration and granting it access to your Notion databases.","sidebar":"defaultSidebar"},"Integrations/Notion/notion-agent-conversational":{"id":"Integrations/Notion/notion-agent-conversational","title":"Notion Conversational Agent","description":"The Notion Conversational Agent is an AI-powered assistant that interacts with your Notion workspace through natural language conversations. This flow performs Notion-related tasks like creating pages, searching for information, and managing content, all through a chat interface.","sidebar":"defaultSidebar"},"Integrations/Notion/notion-agent-meeting-notes":{"id":"Integrations/Notion/notion-agent-meeting-notes","title":"Notion Meeting Notes Agent","description":"The Notion Agent for Meeting Notes is an AI-powered tool that automatically processes meeting transcripts and updates your Notion workspace. It identifies tasks, action items, and key points from your meetings, then creates new tasks or updates existing ones in Notion without manual input.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-basic-prompting":{"id":"Starter-Projects/starter-projects-basic-prompting","title":"Basic Prompting","description":"Prompts serve as the inputs to a large language model (LLM), acting as the interface between human instructions and computational tasks.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-blog-writer":{"id":"Starter-Projects/starter-projects-blog-writer","title":"Blog Writer","description":"Build a blog writer with OpenAI that uses URLs for reference content.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-document-qa":{"id":"Starter-Projects/starter-projects-document-qa","title":"Document QA","description":"Build a question-and-answer chatbot with a document loaded from local memory.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-dynamic-agent":{"id":"Starter-Projects/starter-projects-dynamic-agent","title":"Dynamic Agent","description":"Build a Dynamic Agent flow for an agentic application using the CrewAI.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-memory-chatbot":{"id":"Starter-Projects/starter-projects-memory-chatbot","title":"Memory Chatbot","description":"This flow extends the\xa0Basic Prompting\xa0flow to include a chat memory. This makes the AI remember previous user inputs.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-simple-agent":{"id":"Starter-Projects/starter-projects-simple-agent","title":"Simple Agent","description":"Build a Simple Agent flow for an agentic application using the Tool-calling agent.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-travel-planning-agent":{"id":"Starter-Projects/starter-projects-travel-planning-agent","title":"Travel Planning Agent","description":"Build a Travel Planning Agent flow for an agentic application using the multiple Tool-calling agents.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-vector-store-rag":{"id":"Starter-Projects/starter-projects-vector-store-rag","title":"Vector Store RAG","description":"Retrieval Augmented Generation, or RAG, is a pattern for training LLMs on your data and querying it.","sidebar":"defaultSidebar"},"What\u2019s-New/whats-new-a-new-chapter-langflow":{"id":"What\u2019s-New/whats-new-a-new-chapter-langflow","title":"1.0 - A new chapter for Langflow","description":"First things first","sidebar":"defaultSidebar"},"Workspace/workspace-api":{"id":"Workspace/workspace-api","title":"API","description":"The\xa0API\xa0section presents code templates for integrating your flow into external applications.","sidebar":"defaultSidebar"},"Workspace/workspace-logs":{"id":"Workspace/workspace-logs","title":"Logs","description":"The\xa0Logs\xa0page provides a detailed record of all component executions within a workspace. It is designed to help you track actions, debug issues, and understand the flow of data through various components.","sidebar":"defaultSidebar"},"Workspace/workspace-overview":{"id":"Workspace/workspace-overview","title":"Workspace concepts","description":"The workspace is where you create AI applications by connecting and running components in flows.","sidebar":"defaultSidebar"},"Workspace/workspace-playground":{"id":"Workspace/workspace-playground","title":"Playground","description":"The\xa0Playground\xa0is a dynamic interface designed for real-time interaction with AIs, allowing users to chat, access memories and monitor inputs and outputs. Here, users can directly prototype and their models, making adjustments and observing different outcomes.","sidebar":"defaultSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/22dd74f7.45c70a38.js b/assets/js/22dd74f7.45c70a38.js new file mode 100644 index 0000000000..6ebe795059 --- /dev/null +++ b/assets/js/22dd74f7.45c70a38.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[1567],{5226:e=>{e.exports=JSON.parse('{"version":{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"defaultSidebar":[{"type":"category","label":"What\u2019s New?","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"1.0 - A new chapter for Langflow","href":"/whats-new-a-new-chapter-langflow","docId":"What\u2019s-New/whats-new-a-new-chapter-langflow","unlisted":false}]},{"type":"category","label":"Getting Started","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"\ud83d\udc4b\xa0Welcome to Langflow","href":"/","docId":"Getting-Started/\ud83d\udc4b\xa0Welcome-to-Langflow","unlisted":false},{"type":"link","label":"\ud83d\udce6\xa0Installation","href":"/getting-started-installation","docId":"Getting-Started/getting-started-installation","unlisted":false},{"type":"link","label":"\u26a1\ufe0f Quickstart","href":"/getting-started-quickstart","docId":"Getting-Started/getting-started-quickstart","unlisted":false},{"type":"link","label":"\u2757\ufe0f Common Installation Issues","href":"/getting-started-common-installation-issues","docId":"Getting-Started/getting-started-common-installation-issues","unlisted":false}]},{"type":"category","label":"Starter Projects","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Basic Prompting","href":"/starter-projects-basic-prompting","docId":"Starter-Projects/starter-projects-basic-prompting","unlisted":false},{"type":"link","label":"Blog Writer","href":"/starter-projects-blog-writer","docId":"Starter-Projects/starter-projects-blog-writer","unlisted":false},{"type":"link","label":"Document QA","href":"/starter-projects-document-qa","docId":"Starter-Projects/starter-projects-document-qa","unlisted":false},{"type":"link","label":"Memory Chatbot","href":"/starter-projects-memory-chatbot","docId":"Starter-Projects/starter-projects-memory-chatbot","unlisted":false},{"type":"link","label":"Vector Store RAG","href":"/starter-projects-vector-store-rag","docId":"Starter-Projects/starter-projects-vector-store-rag","unlisted":false},{"type":"link","label":"Dynamic Agent","href":"/Starter-Projects/starter-projects-dynamic-agent","docId":"Starter-Projects/starter-projects-dynamic-agent","unlisted":false},{"type":"link","label":"Simple Agent","href":"/Starter-Projects/starter-projects-simple-agent","docId":"Starter-Projects/starter-projects-simple-agent","unlisted":false},{"type":"link","label":"Travel Planning Agent","href":"/Starter-Projects/starter-projects-travel-planning-agent","docId":"Starter-Projects/starter-projects-travel-planning-agent","unlisted":false}]},{"type":"category","label":"Guides","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"\ud83d\udcda New to LLMs?","href":"/guides-new-to-llms","docId":"Guides/guides-new-to-llms","unlisted":false},{"type":"link","label":"Chat Memory","href":"/guides-chat-memory","docId":"Guides/guides-chat-memory","unlisted":false},{"type":"link","label":"Data & Message","href":"/guides-data-message","docId":"Guides/guides-data-message","unlisted":false}]},{"type":"category","label":"Workspace","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Workspace concepts","href":"/workspace-overview","docId":"Workspace/workspace-overview","unlisted":false},{"type":"link","label":"API","href":"/workspace-api","docId":"Workspace/workspace-api","unlisted":false},{"type":"link","label":"Playground","href":"/workspace-playground","docId":"Workspace/workspace-playground","unlisted":false},{"type":"link","label":"Logs","href":"/workspace-logs","docId":"Workspace/workspace-logs","unlisted":false}]},{"type":"category","label":"Components","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"How to build flows with components","href":"/components-overview","docId":"Components/components-overview","unlisted":false},{"type":"link","label":"Inputs & Outputs","href":"/components-io","docId":"Components/components-io","unlisted":false},{"type":"link","label":"Prompts","href":"/components-prompts","docId":"Components/components-prompts","unlisted":false},{"type":"link","label":"Data","href":"/components-data","docId":"Components/components-data","unlisted":false},{"type":"link","label":"Helpers","href":"/components-helpers","docId":"Components/components-helpers","unlisted":false},{"type":"link","label":"Models","href":"/components-models","docId":"Components/components-models","unlisted":false},{"type":"link","label":"Embedding Models","href":"/components-embedding-models","docId":"Components/components-embedding-models","unlisted":false},{"type":"link","label":"Vector Stores","href":"/components-vector-stores","docId":"Components/components-vector-stores","unlisted":false},{"type":"link","label":"Custom Components","href":"/components-custom-components","docId":"Components/components-custom-components","unlisted":false},{"type":"link","label":"RAG","href":"/components-rag","docId":"Components/components-rag","unlisted":false},{"type":"link","label":"Loaders","href":"/components-loaders","docId":"Components/components-loaders","unlisted":false},{"type":"link","label":"Agents","href":"/Components/components-agents","docId":"Components/components-agents","unlisted":false},{"type":"link","label":"Memories","href":"/Components/components-memories","docId":"Components/components-memories","unlisted":false},{"type":"link","label":"Tools","href":"/Components/components-tools","docId":"Components/components-tools","unlisted":false}]},{"type":"category","label":"Deployment","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"\ud83e\udd17\xa0Spaces","href":"/deployment-hugging-face-spaces","docId":"Deployment/deployment-hugging-face-spaces","unlisted":false},{"type":"link","label":"Kubernetes","href":"/deployment-kubernetes","docId":"Deployment/deployment-kubernetes","unlisted":false},{"type":"link","label":"Docker","href":"/deployment-docker","docId":"Deployment/deployment-docker","unlisted":false},{"type":"link","label":"GCP","href":"/deployment-gcp","docId":"Deployment/deployment-gcp","unlisted":false},{"type":"link","label":"Render","href":"/deployment-render","docId":"Deployment/deployment-render","unlisted":false},{"type":"link","label":"Railway","href":"/deployment-railway","docId":"Deployment/deployment-railway","unlisted":false}]},{"type":"category","label":"Configuration","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Authentication","href":"/configuration-authentication","docId":"Configuration/configuration-authentication","unlisted":false},{"type":"link","label":"API keys","href":"/configuration-api-keys","docId":"Configuration/configuration-api-keys","unlisted":false},{"type":"link","label":"Langflow CLI","href":"/configuration-cli","docId":"Configuration/configuration-cli","unlisted":false},{"type":"link","label":"Run Langflow in backend-only mode","href":"/configuration-backend-only","docId":"Configuration/configuration-backend-only","unlisted":false},{"type":"link","label":"Global variables","href":"/configuration-global-variables","docId":"Configuration/configuration-global-variables","unlisted":false},{"type":"link","label":"Auto-saving","href":"/configuration-auto-save","docId":"Configuration/configuration-auto-saving","unlisted":false},{"type":"link","label":"Environment variables","href":"/environment-variables","docId":"Configuration/environment-variables","unlisted":false}]},{"type":"category","label":"Integrations","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"AssemblyAI","href":"/integrations-assemblyai","docId":"Integrations/integrations-assemblyai","unlisted":false},{"type":"category","label":"Google","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Setup Google OAuth for Langflow Integration","href":"/integrations-setup-google-oauth-langflow","docId":"Integrations/Google/integrations-setup-google-oauth-langflow","unlisted":false}]},{"type":"link","label":"Langfuse","href":"/integrations-langfuse","docId":"Integrations/integrations-langfuse","unlisted":false},{"type":"link","label":"LangSmith","href":"/integrations-langsmith","docId":"Integrations/integrations-langsmith","unlisted":false},{"type":"link","label":"LangWatch","href":"/integrations-langwatch","docId":"Integrations/integrations-langwatch","unlisted":false},{"type":"category","label":"Notion","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Setup","href":"/integrations/notion/setup","docId":"Integrations/Notion/integrations-notion","unlisted":false},{"type":"link","label":"Notion Meeting Notes Agent","href":"/integrations/notion/notion-agent-meeting-notes","docId":"Integrations/Notion/notion-agent-meeting-notes","unlisted":false},{"type":"link","label":"Notion Conversational Agent","href":"/integrations/notion/notion-agent-conversational","docId":"Integrations/Notion/notion-agent-conversational","unlisted":false}]}]},{"type":"category","label":"Contributing","collapsible":true,"collapsed":false,"items":[{"type":"link","label":"Telemetry","href":"/contributing-telemetry","docId":"Contributing/contributing-telemetry","unlisted":false},{"type":"link","label":"Contribute to Langflow","href":"/contributing-how-to-contribute","docId":"Contributing/contributing-how-to-contribute","unlisted":false},{"type":"link","label":"Request an enhancement or report a bug","href":"/contributing-github-issues","docId":"Contributing/contributing-github-issues","unlisted":false},{"type":"link","label":"Ask for help on the Discussions board","href":"/contributing-github-discussions","docId":"Contributing/contributing-github-discussion-board","unlisted":false},{"type":"link","label":"Contribute components","href":"/contributing-components","docId":"Contributing/contributing-components","unlisted":false},{"type":"link","label":"Join the Langflow community","href":"/contributing-community","docId":"Contributing/contributing-community","unlisted":false}]}]},"docs":{"Components/components-agents":{"id":"Components/components-agents","title":"Agents","description":"Agent components are used to define the behavior and capabilities of AI agents in your flow. Agents can interact with APIs, databases, and other services, but can also use LLMs as a reasoning engine to decide which course to take in your flow.","sidebar":"defaultSidebar"},"Components/components-custom-components":{"id":"Components/components-custom-components","title":"Custom Components","description":"Custom components are created within Langflow and extend the platform\'s functionality with custom, resusable Python code.","sidebar":"defaultSidebar"},"Components/components-data":{"id":"Components/components-data","title":"Data","description":"API Request","sidebar":"defaultSidebar"},"Components/components-embedding-models":{"id":"Components/components-embedding-models","title":"Embedding Models","description":"Embeddings models are used to convert text into numerical vectors. These vectors can be used for various tasks such as similarity search, clustering, and classification.","sidebar":"defaultSidebar"},"Components/components-helpers":{"id":"Components/components-helpers","title":"Helpers","description":"Helper components provide utility functions to help manage data, tasks, and other components in your flow.","sidebar":"defaultSidebar"},"Components/components-io":{"id":"Components/components-io","title":"Inputs & Outputs","description":"This category of components defines where data enters and exits your flow. They dynamically alter the Playground and can be renamed to facilitate building and maintaining your flows.","sidebar":"defaultSidebar"},"Components/components-loaders":{"id":"Components/components-loaders","title":"Loaders","description":"Loaders are components used to load documents from various sources, such as databases, websites, and local files. They can be used to fetch data from external sources and convert it into a format that can be processed by other components.","sidebar":"defaultSidebar"},"Components/components-memories":{"id":"Components/components-memories","title":"Memories","description":"Chat memory components store and retrieve chat messages by session_id.","sidebar":"defaultSidebar"},"Components/components-models":{"id":"Components/components-models","title":"Models","description":"Model components are used to generate text using language models. These components can be used to generate text for various tasks such as chatbots, content generation, and more.","sidebar":"defaultSidebar"},"Components/components-overview":{"id":"Components/components-overview","title":"How to build flows with components","description":"A\xa0component\xa0is a single building block within a flow. It consists of inputs, outputs, and parameters that define their functionality. These elements provide a convenient and straightforward way to compose LLM-based applications. Learn more about components and how they work below.","sidebar":"defaultSidebar"},"Components/components-prompts":{"id":"Components/components-prompts","title":"Prompts","description":"A prompt serves as the input to a language model, comprising multiple components that can be parameterized using prompt templates.","sidebar":"defaultSidebar"},"Components/components-rag":{"id":"Components/components-rag","title":"RAG","description":"RAG (Retrieval-Augmented Generation) components process a user query by retrieving relevant documents and generating a concise summary that addresses the user\'s question.","sidebar":"defaultSidebar"},"Components/components-tools":{"id":"Components/components-tools","title":"Tools","description":"Tool components are used to interact with external services, APIs, and tools. They can be used to search the web, query databases, and perform other tasks.","sidebar":"defaultSidebar"},"Components/components-vector-stores":{"id":"Components/components-vector-stores","title":"Vector Stores","description":"Vector databases are used to store and search for vectors. They can be used to store embeddings, search for similar vectors, and perform other vector operations.","sidebar":"defaultSidebar"},"Configuration/configuration-api-keys":{"id":"Configuration/configuration-api-keys","title":"API keys","description":"Langflow provides an API key functionality that allows users to access their individual components and flows without traditional login authentication. The API key is a user-specific token that can be included in the request header, query parameter, or as a command line argument to authenticate API calls. This documentation outlines how to generate, use, and manage API keys in Langflow.","sidebar":"defaultSidebar"},"Configuration/configuration-authentication":{"id":"Configuration/configuration-authentication","title":"Authentication","description":"The login functionality in Langflow serves to authenticate users and protect sensitive routes in the application.","sidebar":"defaultSidebar"},"Configuration/configuration-auto-saving":{"id":"Configuration/configuration-auto-saving","title":"Auto-saving","description":"Langflow currently supports both manual and auto-saving functionality.","sidebar":"defaultSidebar"},"Configuration/configuration-backend-only":{"id":"Configuration/configuration-backend-only","title":"Run Langflow in backend-only mode","description":"Langflow can run in --backend-only mode to expose a Langflow app as an API endpoint, without running the frontend UI.","sidebar":"defaultSidebar"},"Configuration/configuration-cli":{"id":"Configuration/configuration-cli","title":"Langflow CLI","description":"The Langflow command line interface (Langflow CLI) is the main interface for managing and running the Langflow server.","sidebar":"defaultSidebar"},"Configuration/configuration-global-variables":{"id":"Configuration/configuration-global-variables","title":"Global variables","description":"Global variables let you store and reuse generic input values and credentials across your projects.","sidebar":"defaultSidebar"},"Configuration/environment-variables":{"id":"Configuration/environment-variables","title":"Environment variables","description":"Langflow lets you configure a number of settings using environment variables.","sidebar":"defaultSidebar"},"Contributing/contributing-community":{"id":"Contributing/contributing-community","title":"Join the Langflow community","description":"Join the Langflow Discord server","sidebar":"defaultSidebar"},"Contributing/contributing-components":{"id":"Contributing/contributing-components","title":"Contribute components","description":"New components are added as objects of the\xa0CustomComponent\xa0class.","sidebar":"defaultSidebar"},"Contributing/contributing-github-discussion-board":{"id":"Contributing/contributing-github-discussion-board","title":"Ask for help on the Discussions board","description":"If you\'re looking for help with your code, consider posting a question on the Langflow\xa0GitHub Discussions board. The Langflow team cannot provide individual support via email. The team also believes that help is much more valuable if it\'s\xa0shared publicly, so that more people can benefit from it.","sidebar":"defaultSidebar"},"Contributing/contributing-github-issues":{"id":"Contributing/contributing-github-issues","title":"Request an enhancement or report a bug","description":"The\xa0Issues page in the Langflow repo is kept up to date with bugs, improvements, and feature requests. Labels are used to help with sorting and discovery of issues of interest. For an overview of the system Langflow uses to tag issues and pull requests, see the Langflow repo\'s labels page.","sidebar":"defaultSidebar"},"Contributing/contributing-how-to-contribute":{"id":"Contributing/contributing-how-to-contribute","title":"Contribute to Langflow","description":"This guide is intended to help you start contributing to Langflow.","sidebar":"defaultSidebar"},"Contributing/contributing-telemetry":{"id":"Contributing/contributing-telemetry","title":"Telemetry","description":"Langflow uses anonymous telemetry to collect essential usage statistics to enhance functionality and the user experience. This data helps us identify popular features and areas that need improvement, and ensures development efforts align with what you need.","sidebar":"defaultSidebar"},"Deployment/deployment-docker":{"id":"Deployment/deployment-docker","title":"Docker","description":"This guide will help you get LangFlow up and running using Docker and Docker Compose.","sidebar":"defaultSidebar"},"Deployment/deployment-gcp":{"id":"Deployment/deployment-gcp","title":"GCP","description":"To deploy Langflow on Google Cloud Platform using Cloud Shell, use the below script.","sidebar":"defaultSidebar"},"Deployment/deployment-hugging-face-spaces":{"id":"Deployment/deployment-hugging-face-spaces","title":"\ud83e\udd17\xa0Spaces","description":"HuggingFace Spaces","sidebar":"defaultSidebar"},"Deployment/deployment-kubernetes":{"id":"Deployment/deployment-kubernetes","title":"Kubernetes","description":"This guide will help you get LangFlow up and running in Kubernetes cluster, including the following steps:","sidebar":"defaultSidebar"},"Deployment/deployment-railway":{"id":"Deployment/deployment-railway","title":"Railway","description":"Deploy on Railway","sidebar":"defaultSidebar"},"Deployment/deployment-render":{"id":"Deployment/deployment-render","title":"Render","description":"Deploy on Render","sidebar":"defaultSidebar"},"Getting-Started/\ud83d\udc4b\xa0Welcome-to-Langflow":{"id":"Getting-Started/\ud83d\udc4b\xa0Welcome-to-Langflow","title":"\ud83d\udc4b\xa0Welcome to Langflow","description":"Introduction","sidebar":"defaultSidebar"},"Getting-Started/getting-started-common-installation-issues":{"id":"Getting-Started/getting-started-common-installation-issues","title":"\u2757\ufe0f Common Installation Issues","description":"This is a list of possible issues that you may encounter when installing Langflow and how to solve them.","sidebar":"defaultSidebar"},"Getting-Started/getting-started-installation":{"id":"Getting-Started/getting-started-installation","title":"\ud83d\udce6\xa0Installation","description":"DataStax Langflow","sidebar":"defaultSidebar"},"Getting-Started/getting-started-quickstart":{"id":"Getting-Started/getting-started-quickstart","title":"\u26a1\ufe0f Quickstart","description":"Prerequisites","sidebar":"defaultSidebar"},"Guides/guides-chat-memory":{"id":"Guides/guides-chat-memory","title":"Chat Memory","description":"Langflow allows every chat message to be stored, and a single flow can have multiple memory sessions. This enables you to create separate memories for agents to store and recall information as needed.","sidebar":"defaultSidebar"},"Guides/guides-data-message":{"id":"Guides/guides-data-message","title":"Data & Message","description":"In Langflow, the\xa0Data\xa0and\xa0Message\xa0objects serve as structured, functional representations of data that enhance the capabilities and reliability of the platform.","sidebar":"defaultSidebar"},"Guides/guides-new-to-llms":{"id":"Guides/guides-new-to-llms","title":"\ud83d\udcda New to LLMs?","description":"Large Language Models, or LLMs, are part of an exciting new world in computing.","sidebar":"defaultSidebar"},"Integrations/Google/integrations-setup-google-oauth-langflow":{"id":"Integrations/Google/integrations-setup-google-oauth-langflow","title":"Setup Google OAuth for Langflow Integration","description":"A comprehensive guide on creating a Google OAuth app, obtaining tokens, and integrating them with Langflow\'s Google components.","sidebar":"defaultSidebar"},"Integrations/integrations-assemblyai":{"id":"Integrations/integrations-assemblyai","title":"AssemblyAI","description":"The AssemblyAI components allow you to apply powerful Speech AI models to your app for tasks like:","sidebar":"defaultSidebar"},"Integrations/integrations-langfuse":{"id":"Integrations/integrations-langfuse","title":"Langfuse","description":"Langfuse is an observability and analytics platform specifically designed for language models and AI applications.","sidebar":"defaultSidebar"},"Integrations/integrations-langsmith":{"id":"Integrations/integrations-langsmith","title":"LangSmith","description":"LangSmith is a full-lifecycle DevOps service from LangChain that provides monitoring and observability. To integrate with Langflow, just add your LangChain API key as a Langflow environment variable and you are good to go!","sidebar":"defaultSidebar"},"Integrations/integrations-langwatch":{"id":"Integrations/integrations-langwatch","title":"LangWatch","description":"938674091aac4d9d9aa4aa6eb5c215b4}","sidebar":"defaultSidebar"},"Integrations/Notion/integrations-notion":{"id":"Integrations/Notion/integrations-notion","title":"Setup","description":"To use Notion components in Langflow, you first need to create a Notion integration and configure it with the necessary capabilities. This guide will walk you through the process of setting up a Notion integration and granting it access to your Notion databases.","sidebar":"defaultSidebar"},"Integrations/Notion/notion-agent-conversational":{"id":"Integrations/Notion/notion-agent-conversational","title":"Notion Conversational Agent","description":"The Notion Conversational Agent is an AI-powered assistant that interacts with your Notion workspace through natural language conversations. This flow performs Notion-related tasks like creating pages, searching for information, and managing content, all through a chat interface.","sidebar":"defaultSidebar"},"Integrations/Notion/notion-agent-meeting-notes":{"id":"Integrations/Notion/notion-agent-meeting-notes","title":"Notion Meeting Notes Agent","description":"The Notion Agent for Meeting Notes is an AI-powered tool that automatically processes meeting transcripts and updates your Notion workspace. It identifies tasks, action items, and key points from your meetings, then creates new tasks or updates existing ones in Notion without manual input.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-basic-prompting":{"id":"Starter-Projects/starter-projects-basic-prompting","title":"Basic Prompting","description":"Prompts serve as the inputs to a large language model (LLM), acting as the interface between human instructions and computational tasks.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-blog-writer":{"id":"Starter-Projects/starter-projects-blog-writer","title":"Blog Writer","description":"Build a blog writer with OpenAI that uses URLs for reference content.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-document-qa":{"id":"Starter-Projects/starter-projects-document-qa","title":"Document QA","description":"Build a question-and-answer chatbot with a document loaded from local memory.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-dynamic-agent":{"id":"Starter-Projects/starter-projects-dynamic-agent","title":"Dynamic Agent","description":"Build a Dynamic Agent flow for an agentic application using the CrewAI.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-memory-chatbot":{"id":"Starter-Projects/starter-projects-memory-chatbot","title":"Memory Chatbot","description":"This flow extends the\xa0Basic Prompting\xa0flow to include a chat memory. This makes the AI remember previous user inputs.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-simple-agent":{"id":"Starter-Projects/starter-projects-simple-agent","title":"Simple Agent","description":"Build a Simple Agent flow for an agentic application using the Tool-calling agent.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-travel-planning-agent":{"id":"Starter-Projects/starter-projects-travel-planning-agent","title":"Travel Planning Agent","description":"Build a Travel Planning Agent flow for an agentic application using the multiple Tool-calling agents.","sidebar":"defaultSidebar"},"Starter-Projects/starter-projects-vector-store-rag":{"id":"Starter-Projects/starter-projects-vector-store-rag","title":"Vector Store RAG","description":"Retrieval Augmented Generation, or RAG, is a pattern for training LLMs on your data and querying it.","sidebar":"defaultSidebar"},"What\u2019s-New/whats-new-a-new-chapter-langflow":{"id":"What\u2019s-New/whats-new-a-new-chapter-langflow","title":"1.0 - A new chapter for Langflow","description":"First things first","sidebar":"defaultSidebar"},"Workspace/workspace-api":{"id":"Workspace/workspace-api","title":"API","description":"The\xa0API\xa0section presents code templates for integrating your flow into external applications.","sidebar":"defaultSidebar"},"Workspace/workspace-logs":{"id":"Workspace/workspace-logs","title":"Logs","description":"The\xa0Logs\xa0page provides a detailed record of all component executions within a workspace. It is designed to help you track actions, debug issues, and understand the flow of data through various components.","sidebar":"defaultSidebar"},"Workspace/workspace-overview":{"id":"Workspace/workspace-overview","title":"Workspace concepts","description":"The workspace is where you create AI applications by connecting and running components in flows.","sidebar":"defaultSidebar"},"Workspace/workspace-playground":{"id":"Workspace/workspace-playground","title":"Playground","description":"The\xa0Playground\xa0is a dynamic interface designed for real-time interaction with AIs, allowing users to chat, access memories and monitor inputs and outputs. Here, users can directly prototype and their models, making adjustments and observing different outcomes.","sidebar":"defaultSidebar"}}}}')}}]); \ No newline at end of file diff --git a/assets/js/445668ec.5070ebd4.js b/assets/js/445668ec.5070ebd4.js deleted file mode 100644 index 8c8d90c39b..0000000000 --- a/assets/js/445668ec.5070ebd4.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[6008],{8553:(e,n,o)=>{o.r(n),o.d(n,{assets:()=>r,contentTitle:()=>l,default:()=>h,frontMatter:()=>s,metadata:()=>c,toc:()=>d});var t=o(4848),i=o(8453);const s={title:"How to contribute?",sidebar_position:1,slug:"/contributing-how-to-contribute"},l=void 0,c={id:"Contributing/contributing-how-to-contribute",title:"How to contribute?",description:"This page may contain outdated information. It will be updated as soon as possible.",source:"@site/docs/Contributing/contributing-how-to-contribute.md",sourceDirName:"Contributing",slug:"/contributing-how-to-contribute",permalink:"/contributing-how-to-contribute",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"How to contribute?",sidebar_position:1,slug:"/contributing-how-to-contribute"},sidebar:"defaultSidebar",previous:{title:"Telemetry",permalink:"/contributing-telemetry"},next:{title:"GitHub Issues",permalink:"/contributing-github-issues"}},r={},d=[{value:"Local Development",id:"0388cc3c758d434d994022863a6bafa9",level:2},{value:"Run Locally",id:"5225c2ef0cd6403c9f6c6bbd888115e0",level:2},{value:"Docker Compose",id:"b07f359414ff4220ac615afc364ee46e",level:2},{value:"Documentation",id:"5f34bcaeccdc4489b0c5ee2c4a21354e",level:2},{value:"Submitting Components",id:"9676353bc4504551a4014dd572ac8be8",level:2},{value:"Add an example component",id:"8caae106c853465d83183e7f5272e4d8",level:3},{value:"User Sharing",id:"34ac32e11f344eab892b94531a21d2c9",level:2}];function a(e){const n={a:"a",admonition:"admonition",code:"code",h2:"h2",h3:"h3",hr:"hr",img:"img",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)(n.admonition,{type:"info",children:(0,t.jsx)(n.p,{children:"This page may contain outdated information. It will be updated as soon as possible."})}),"\n",(0,t.jsx)(n.p,{children:"\ud83d\udc4b Hello there!"}),"\n",(0,t.jsxs)(n.p,{children:["We welcome contributions from developers of all levels to our open-source project on\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow",children:"GitHub"}),". If you'd like to contribute, please check our contributing guidelines and help make Langflow more accessible."]}),"\n",(0,t.jsx)(n.p,{children:"As an open-source project in a rapidly developing field, we are extremely open to contributions, whether in the form of a new feature, improved infra, or better documentation."}),"\n",(0,t.jsxs)(n.p,{children:["To contribute to this project, please follow a\xa0",(0,t.jsx)(n.a,{href:"https://docs.github.com/en/get-started/quickstart/contributing-to-projects",children:'"fork and pull request"'}),"\xa0workflow. Please do not try to push directly to this repo unless you are a maintainer."]}),"\n",(0,t.jsx)(n.h2,{id:"0388cc3c758d434d994022863a6bafa9",children:"Local Development"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.p,{children:"You can develop Langflow using docker compose, or locally."}),"\n",(0,t.jsxs)(n.p,{children:["We provide a\xa0",(0,t.jsx)(n.code,{children:".vscode/launch.json"}),"\xa0file for debugging the backend in VSCode, which is a lot faster than using docker compose."]}),"\n",(0,t.jsx)(n.p,{children:"Setting up hooks:"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"make init"})}),"\n",(0,t.jsxs)(n.p,{children:["This will install the pre-commit hooks, which will run\xa0",(0,t.jsx)(n.code,{children:"make format"}),"\xa0on every commit."]}),"\n",(0,t.jsxs)(n.p,{children:["It is advised to run\xa0",(0,t.jsx)(n.code,{children:"make lint"}),"\xa0before pushing to the repository."]}),"\n",(0,t.jsx)(n.h2,{id:"5225c2ef0cd6403c9f6c6bbd888115e0",children:"Run Locally"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.p,{children:"Langflow can run locally by cloning the repository and installing the dependencies. We recommend using a virtual environment to isolate the dependencies from your system."}),"\n",(0,t.jsx)(n.p,{children:"Before you start, make sure you have the following installed:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:"Poetry (>=1.4)"}),"\n",(0,t.jsx)(n.li,{children:"Node.js"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Then, in the root folder, install the dependencies and start the development server for the backend:"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"make backend"})}),"\n",(0,t.jsx)(n.p,{children:"And the frontend:"}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"make frontend"})}),"\n",(0,t.jsx)(n.h2,{id:"b07f359414ff4220ac615afc364ee46e",children:"Docker Compose"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.p,{children:["The following snippet will run the backend and frontend in separate containers. The frontend will be available at\xa0",(0,t.jsx)(n.code,{children:"localhost:3000"}),"\xa0and the backend at\xa0",(0,t.jsx)(n.code,{children:"localhost:7860"}),"."]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"docker compose up --build# ormake dev build=1"})}),"\n",(0,t.jsx)(n.h2,{id:"5f34bcaeccdc4489b0c5ee2c4a21354e",children:"Documentation"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.p,{children:["The documentation is built using\xa0",(0,t.jsx)(n.a,{href:"https://docusaurus.io/",children:"Docusaurus"}),". To run the documentation locally, run the following commands:"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.code,{children:"cd docsnpm installnpm run start"})}),"\n",(0,t.jsxs)(n.p,{children:["The documentation will be available at\xa0",(0,t.jsx)(n.code,{children:"localhost:3000"}),"\xa0and all the files are located in the\xa0",(0,t.jsx)(n.code,{children:"docs/docs"}),"\xa0folder. Once you are done with your changes, you can create a Pull Request to the\xa0",(0,t.jsx)(n.code,{children:"main"}),"\xa0branch."]}),"\n",(0,t.jsx)(n.h2,{id:"9676353bc4504551a4014dd572ac8be8",children:"Submitting Components"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsxs)(n.p,{children:["New components are added as objects of the\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/interface/custom/custom_component/custom_component.py",children:"CustomComponent"}),"\xa0class and any dependencies are added to the\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/pyproject.toml#L27",children:"pyproject.toml"}),"\xa0file."]}),"\n",(0,t.jsx)(n.h3,{id:"8caae106c853465d83183e7f5272e4d8",children:"Add an example component"}),"\n",(0,t.jsxs)(n.p,{children:["You have a new document loader called\xa0",(0,t.jsx)(n.strong,{children:"MyCustomDocumentLoader"}),"\xa0and it would look awesome in Langflow."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Write your loader as an object of the\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/interface/custom/custom_component/custom_component.py",children:"CustomComponent"}),"\xa0class. You'll create a new class,\xa0",(0,t.jsx)(n.code,{children:"MyCustomDocumentLoader"}),", that will inherit from\xa0",(0,t.jsx)(n.code,{children:"CustomComponent"}),"\xa0and override the base class's methods."]}),"\n",(0,t.jsxs)(n.li,{children:["Define optional attributes like\xa0",(0,t.jsx)(n.code,{children:"display_name"}),",\xa0",(0,t.jsx)(n.code,{children:"description"}),", and\xa0",(0,t.jsx)(n.code,{children:"documentation"}),"\xa0to provide information about your custom component."]}),"\n",(0,t.jsxs)(n.li,{children:["Implement the\xa0",(0,t.jsx)(n.code,{children:"build_config"}),"\xa0method to define the configuration options for your custom component."]}),"\n",(0,t.jsxs)(n.li,{children:["Implement the\xa0",(0,t.jsx)(n.code,{children:"build"}),"\xa0method to define the logic for taking input parameters specified in the\xa0",(0,t.jsx)(n.code,{children:"build_config"}),"\xa0method and returning the desired output."]}),"\n",(0,t.jsxs)(n.li,{children:["Add the code to the\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow/tree/dev/src/backend/base/langflow/components",children:"/components/documentloaders"}),"\xa0folder."]}),"\n",(0,t.jsxs)(n.li,{children:["Add the dependency to\xa0",(0,t.jsxs)(n.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/components/documentloaders/__init__.py",children:["/documentloaders/",(0,t.jsx)(n.strong,{children:"init"}),".py"]}),"\xa0as\xa0",(0,t.jsx)(n.code,{children:"from .MyCustomDocumentLoader import MyCustomDocumentLoader"}),"."]}),"\n",(0,t.jsxs)(n.li,{children:["Add any new dependencies to the outer\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/pyproject.toml#L27",children:"pyproject.toml"}),"\xa0file."]}),"\n",(0,t.jsxs)(n.li,{children:["Submit documentation for your component. For this example, you'd submit documentation to the\xa0",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow/blob/dev/docs/docs/components/loaders",children:"loaders page"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"Submit your changes as a pull request. The Langflow team will have a look, suggest changes, and add your component to Langflow."}),"\n"]}),"\n",(0,t.jsx)(n.h2,{id:"34ac32e11f344eab892b94531a21d2c9",children:"User Sharing"}),"\n",(0,t.jsx)(n.hr,{}),"\n",(0,t.jsx)(n.p,{children:"You might want to share and test your custom component with others, but don't need it merged into the main source code."}),"\n",(0,t.jsx)(n.p,{children:"If so, you can share your component on the Langflow store."}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:[(0,t.jsx)(n.a,{href:"https://www.langflow.store/login/",children:"Register at the Langflow store"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Undergo pre-validation before receiving an API key."}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["To deploy your amazing component directly to the Langflow store, without it being merged into the main source code, navigate to your flow, and then click\xa0",(0,t.jsx)(n.strong,{children:"Share"}),". The share window appears:"]}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:(0,t.jsx)(n.img,{src:o(2771).A+"",width:"1442",height:"858"})}),"\n",(0,t.jsxs)(n.ol,{start:"4",children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Choose whether you want to flow to be public or private. You can also\xa0",(0,t.jsx)(n.strong,{children:"Export"}),"\xa0your flow as a JSON file from this window. When you're ready to share the flow, click\xa0",(0,t.jsx)(n.strong,{children:"Share Flow"}),". You should see a\xa0",(0,t.jsx)(n.strong,{children:"Flow shared successfully"}),"\xa0popup."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["To confirm, navigate to the\xa0",(0,t.jsx)(n.strong,{children:"Langflow Store"}),"\xa0and filter results by\xa0",(0,t.jsx)(n.strong,{children:"Created By Me"}),". You should see your new flow on the\xa0",(0,t.jsx)(n.strong,{children:"Langflow Store"}),"."]}),"\n"]}),"\n"]})]})}function h(e={}){const{wrapper:n}={...(0,i.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(a,{...e})}):a(e)}},2771:(e,n,o)=>{o.d(n,{A:()=>t});const t=o.p+"assets/images/683296796-497b95fbdb9c6efd3857e059c6efd0a7.png"},8453:(e,n,o)=>{o.d(n,{R:()=>l,x:()=>c});var t=o(6540);const i={},s=t.createContext(i);function l(e){const n=t.useContext(s);return t.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(i):e.components||i:l(e.components),t.createElement(s.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/445668ec.b310996f.js b/assets/js/445668ec.b310996f.js new file mode 100644 index 0000000000..cef52afba0 --- /dev/null +++ b/assets/js/445668ec.b310996f.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[6008],{8553:(e,n,o)=>{o.r(n),o.d(n,{CH:()=>a,assets:()=>c,chCodeConfig:()=>h,contentTitle:()=>l,default:()=>g,frontMatter:()=>s,metadata:()=>d,toc:()=>u});var t=o(4848),r=o(8453),i=o(4754);const s={title:"Contribute to Langflow",sidebar_position:1,slug:"/contributing-how-to-contribute"},l=void 0,d={id:"Contributing/contributing-how-to-contribute",title:"Contribute to Langflow",description:"This guide is intended to help you start contributing to Langflow.",source:"@site/docs/Contributing/contributing-how-to-contribute.md",sourceDirName:"Contributing",slug:"/contributing-how-to-contribute",permalink:"/contributing-how-to-contribute",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:1,frontMatter:{title:"Contribute to Langflow",sidebar_position:1,slug:"/contributing-how-to-contribute"},sidebar:"defaultSidebar",previous:{title:"Telemetry",permalink:"/contributing-telemetry"},next:{title:"Request an enhancement or report a bug",permalink:"/contributing-github-issues"}},c={},a={annotations:i.hk,Code:i.Cy},h={staticMediaQuery:"not screen, (max-width: 768px)",lineNumbers:!0,showCopyButton:!0,themeName:"github-dark"},u=[{value:"Contribute code",id:"contribute-code",level:2},{value:"Prerequisites",id:"prerequisites",level:3},{value:"Clone the Langflow Repository",id:"clone-the-langflow-repository",level:3},{value:"Prepare the development environment",id:"prepare-the-development-environment",level:3},{value:"Debug",id:"debug",level:3},{value:"Run Langflow locally",id:"run-langflow-locally",level:3},{value:"Contribute documentation",id:"contribute-documentation",level:2},{value:"Prerequisites",id:"prerequisites-1",level:3},{value:"Clone the Langflow repository",id:"clone-the-langflow-repository-1",level:3},{value:"Open a pull request",id:"open-a-pull-request",level:2}];function p(e){const n={a:"a",code:"code",h2:"h2",h3:"h3",li:"li",ol:"ol",p:"p",strong:"strong",ul:"ul",...(0,r.R)(),...e.components};return a||f("CH",!1),a.Code||f("CH.Code",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("style",{dangerouslySetInnerHTML:{__html:'[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; }'}}),"\n",(0,t.jsx)(n.p,{children:"This guide is intended to help you start contributing to Langflow.\nAs an open-source project in a rapidly developing field, Langflow welcomes contributions, whether it be in the form of a new feature, improved infrastructure, or better documentation."}),"\n",(0,t.jsxs)(n.p,{children:["To contribute code or documentation to this project, follow the ",(0,t.jsx)(n.a,{href:"https://docs.github.com/en/get-started/quickstart/contributing-to-projects",children:"fork and pull request"})," workflow."]}),"\n",(0,t.jsx)(n.h2,{id:"contribute-code",children:"Contribute code"}),"\n",(0,t.jsxs)(n.p,{children:["Develop Langflow locally with ",(0,t.jsx)(n.a,{href:"https://docs.astral.sh/uv/getting-started/installation/",children:"uv"})," and ",(0,t.jsx)(n.a,{href:"https://nodejs.org/en/download/package-manager",children:"Node.js"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://docs.astral.sh/uv/getting-started/installation/",children:"uv(>=0.4)"})}),"\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://nodejs.org/en/download/package-manager",children:"Node.js"})}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"clone-the-langflow-repository",children:"Clone the Langflow Repository"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Navigate to the ",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow",children:"Langflow GitHub repository"}),", and then click ",(0,t.jsx)(n.strong,{children:"Fork"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Add the new remote to your local repository on your local machine:"}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"git ",props:{style:{color:"#FFA657"}}},{content:"remote add fork https://github.com/",props:{style:{color:"#A5D6FF"}}},{content:"<",props:{style:{color:"#FF7B72"}}},{content:"your_git_usernam",props:{style:{color:"#A5D6FF"}}},{content:"e",props:{style:{color:"#C9D1D9"}}},{content:">",props:{style:{color:"#FF7B72"}}},{content:"/langflow.git",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(n.h3,{id:"prepare-the-development-environment",children:"Prepare the development environment"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Create development hooks."}),"\n"]}),"\n",(0,t.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"make ",props:{style:{color:"#FFA657"}}},{content:"init",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(n.p,{children:["This command sets up the development environment by installing backend and frontend dependencies, building the frontend static files, and initializing the project. It runs ",(0,t.jsx)(n.code,{children:"make install_backend"}),", ",(0,t.jsx)(n.code,{children:"make install_frontend"}),", ",(0,t.jsx)(n.code,{children:"make build_frontend"}),", and finally ",(0,t.jsx)(n.code,{children:"uv run langflow run"})," to start the application."]}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsxs)(n.li,{children:["Run ",(0,t.jsx)(n.code,{children:"make lint"}),", ",(0,t.jsx)(n.code,{children:"make format"}),", and ",(0,t.jsx)(n.code,{children:"make unit_tests"})," before pushing to the repository."]}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"debug",children:"Debug"}),"\n",(0,t.jsxs)(n.p,{children:["The repo includes a ",(0,t.jsx)(n.code,{children:".vscode/launch.json"})," file for debugging the backend in VSCode, which is faster than debugging with Docker Compose. To debug Langflow with the ",(0,t.jsx)(n.code,{children:"launch.json"})," file in VSCode:"]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"Open Langflow in VSCode."}),"\n",(0,t.jsxs)(n.li,{children:["Press ",(0,t.jsx)(n.strong,{children:"Ctrl+Shift+D"})," for Windows ",(0,t.jsx)(n.strong,{children:"or Cmd+Shift+D"})," for Mac to open the Run and Debug view."]}),"\n",(0,t.jsxs)(n.li,{children:["From the ",(0,t.jsx)(n.strong,{children:"Run and Debug"})," dropdown, choose a debugging configuration."]}),"\n",(0,t.jsxs)(n.li,{children:["Click the green ",(0,t.jsx)(n.strong,{children:"Play"})," button or press F5 to start debugging."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["Use ",(0,t.jsx)(n.code,{children:"launch.json"})," to quickly debug different parts of your application, like the backend, frontend, or CLI, directly from VSCode."]}),"\n",(0,t.jsx)(n.h3,{id:"run-langflow-locally",children:"Run Langflow locally"}),"\n",(0,t.jsxs)(n.p,{children:["After setting up the environment with ",(0,t.jsx)(n.code,{children:"make init"}),", you can run Langflow's backend and frontend separately for development.\nLangflow recommends using a virtual environment like ",(0,t.jsx)(n.a,{href:"https://docs.python.org/3/library/venv.html",children:"venv"})," or ",(0,t.jsx)(n.a,{href:"https://anaconda.org/anaconda/conda",children:"conda"})," to isolate dependencies."]}),"\n",(0,t.jsxs)(n.p,{children:["Before you begin, ensure you have ",(0,t.jsx)(n.a,{href:"https://docs.astral.sh/uv/getting-started/installation/",children:"uv"})," and ",(0,t.jsx)(n.a,{href:"https://nodejs.org/en/download/package-manager",children:"Node.js"})," installed."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsx)(n.li,{children:"In the repository root, install the dependencies and start the development server for the backend:"}),"\n"]}),"\n",(0,t.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"make ",props:{style:{color:"#FFA657"}}},{content:"backend",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(n.ol,{start:"2",children:["\n",(0,t.jsx)(n.li,{children:"Install dependencies and start the frontend:"}),"\n"]}),"\n",(0,t.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"make ",props:{style:{color:"#FFA657"}}},{content:"frontend",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsx)(n.p,{children:"This approach allows you to work on the backend and frontend independently, with hot-reloading for faster development."}),"\n",(0,t.jsx)(n.h2,{id:"contribute-documentation",children:"Contribute documentation"}),"\n",(0,t.jsxs)(n.p,{children:["The documentation is built using ",(0,t.jsx)(n.a,{href:"https://docusaurus.io/",children:"Docusaurus"})," and written in ",(0,t.jsx)(n.a,{href:"https://docusaurus.io/docs/markdown-features",children:"Markdown"}),"."]}),"\n",(0,t.jsx)(n.h3,{id:"prerequisites-1",children:"Prerequisites"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsx)(n.li,{children:(0,t.jsx)(n.a,{href:"https://nodejs.org/en/download/package-manager",children:"Node.js"})}),"\n"]}),"\n",(0,t.jsx)(n.h3,{id:"clone-the-langflow-repository-1",children:"Clone the Langflow repository"}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsxs)(n.p,{children:["Navigate to the ",(0,t.jsx)(n.a,{href:"https://github.com/langflow-ai/langflow",children:"Langflow GitHub repository"}),", and then click ",(0,t.jsx)(n.strong,{children:"Fork"}),"."]}),"\n"]}),"\n",(0,t.jsxs)(n.li,{children:["\n",(0,t.jsx)(n.p,{children:"Add the new remote to your local repository on your local machine:"}),"\n"]}),"\n"]}),"\n",(0,t.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"git ",props:{style:{color:"#FFA657"}}},{content:"remote add fork https://github.com/",props:{style:{color:"#A5D6FF"}}},{content:"<",props:{style:{color:"#FF7B72"}}},{content:"your_git_usernam",props:{style:{color:"#A5D6FF"}}},{content:"e",props:{style:{color:"#C9D1D9"}}},{content:">",props:{style:{color:"#FF7B72"}}},{content:"/langflow.git",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(n.ol,{start:"3",children:["\n",(0,t.jsx)(n.li,{children:"To run the documentation locally, run the following commands:"}),"\n"]}),"\n",(0,t.jsx)(a.Code,{codeConfig:h,northPanel:{tabs:[""],active:"",heightRatio:1},files:[{name:"",focus:"",code:{lines:[{tokens:[{content:"cd ",props:{style:{color:"#79C0FF"}}},{content:"docs",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"npm ",props:{style:{color:"#FFA657"}}},{content:"install",props:{style:{color:"#A5D6FF"}}}]},{tokens:[{content:"npm ",props:{style:{color:"#FFA657"}}},{content:"run start",props:{style:{color:"#A5D6FF"}}}]}],lang:"bash"},annotations:[]}]}),"\n",(0,t.jsxs)(n.p,{children:["The documentation will be available at ",(0,t.jsx)(n.code,{children:"localhost:3000"})," and all the files are located in the ",(0,t.jsx)(n.code,{children:"docs/docs"})," folder."]}),"\n",(0,t.jsx)(n.h2,{id:"open-a-pull-request",children:"Open a pull request"}),"\n",(0,t.jsxs)(n.p,{children:["Once you have written and manually tested your changes with ",(0,t.jsx)(n.code,{children:"make lint"})," and ",(0,t.jsx)(n.code,{children:"make unit_tests"}),", open a pull request to send your changes upstream to the main Langflow repository."]}),"\n",(0,t.jsxs)(n.ol,{children:["\n",(0,t.jsxs)(n.li,{children:["Open a new GitHub pull request with your patch against the ",(0,t.jsx)(n.code,{children:"main"})," branch."]}),"\n",(0,t.jsxs)(n.li,{children:["Ensure the PR title follows semantic commit conventions. For example, features are ",(0,t.jsx)(n.code,{children:"feat: add new feature"})," and fixes are ",(0,t.jsx)(n.code,{children:"fix: correct issue with X"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"A Langflow maintainer will review your pull request. Thanks for your contribution!"}),"\n"]}),"\n",(0,t.jsx)(n.p,{children:"Some additional guidance on pull request titles:"}),"\n",(0,t.jsxs)(n.ul,{children:["\n",(0,t.jsxs)(n.li,{children:["Ensure the pull request description clearly describes the problem and solution. If the PR fixes an issue, include a link to the fixed issue in the PR description with ",(0,t.jsx)(n.code,{children:"Fixes #1234"}),"."]}),"\n",(0,t.jsx)(n.li,{children:"Pull request titles appear in Langflow's release notes, so they should explain what the PR does as explicitly as possible."}),"\n",(0,t.jsxs)(n.li,{children:["Pull requests should strive to fix one thing ",(0,t.jsx)(n.strong,{children:"only"}),", and should contain a good description of what is being fixed."]}),"\n"]}),"\n",(0,t.jsxs)(n.p,{children:["For more information, see the ",(0,t.jsx)(n.a,{href:"https://devguide.python.org/getting-started/pull-request-lifecycle/index.html#making-good-commits",children:"Python Developer's Guide"}),"."]})]})}function g(e={}){const{wrapper:n}={...(0,r.R)(),...e.components};return n?(0,t.jsx)(n,{...e,children:(0,t.jsx)(p,{...e})}):p(e)}function f(e,n){throw new Error("Expected "+(n?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}}}]); \ No newline at end of file diff --git a/assets/js/667d0790.5f9fab49.js b/assets/js/667d0790.5f9fab49.js new file mode 100644 index 0000000000..4df2bf70a2 --- /dev/null +++ b/assets/js/667d0790.5f9fab49.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunklangflow_docs=self.webpackChunklangflow_docs||[]).push([[9306],{5174:(e,i,n)=>{n.r(i),n.d(i,{assets:()=>a,contentTitle:()=>r,default:()=>d,frontMatter:()=>s,metadata:()=>l,toc:()=>c});var o=n(4848),t=n(8453);const s={title:"Ask for help on the Discussions board",sidebar_position:3,slug:"/contributing-github-discussions"},r=void 0,l={id:"Contributing/contributing-github-discussion-board",title:"Ask for help on the Discussions board",description:"If you're looking for help with your code, consider posting a question on the Langflow\xa0GitHub Discussions board. The Langflow team cannot provide individual support via email. The team also believes that help is much more valuable if it's\xa0shared publicly, so that more people can benefit from it.",source:"@site/docs/Contributing/contributing-github-discussion-board.md",sourceDirName:"Contributing",slug:"/contributing-github-discussions",permalink:"/contributing-github-discussions",draft:!1,unlisted:!1,tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Ask for help on the Discussions board",sidebar_position:3,slug:"/contributing-github-discussions"},sidebar:"defaultSidebar",previous:{title:"Request an enhancement or report a bug",permalink:"/contributing-github-issues"},next:{title:"Contribute components",permalink:"/contributing-components"}},a={},c=[];function u(e){const i={a:"a",code:"code",em:"em",li:"li",p:"p",ul:"ul",...(0,t.R)(),...e.components};return(0,o.jsxs)(o.Fragment,{children:[(0,o.jsxs)(i.p,{children:["If you're looking for help with your code, consider posting a question on the Langflow\xa0",(0,o.jsx)(i.a,{href:"https://github.com/langflow-ai/langflow/discussions",children:"GitHub Discussions board"}),". The Langflow team cannot provide individual support via email. The team also believes that help is much more valuable if it's\xa0shared publicly, so that more people can benefit from it."]}),"\n",(0,o.jsx)(i.p,{children:"Since the Discussions board is public, please follow this guidance when posting your code questions."}),"\n",(0,o.jsxs)(i.ul,{children:["\n",(0,o.jsxs)(i.li,{children:["\n",(0,o.jsxs)(i.p,{children:["When describing your issue, try to provide as many details as possible. What exactly goes wrong?\xa0",(0,o.jsx)(i.em,{children:"How"}),"\xa0is it failing? Is there an error? \"XY doesn't work\" usually isn't that helpful for tracking down problems. Always remember to include the code you ran and if possible, extract only the relevant parts and don't just dump your entire script. This will make it easier for us to reproduce the error."]}),"\n"]}),"\n",(0,o.jsxs)(i.li,{children:["\n",(0,o.jsxs)(i.p,{children:["When you include long code, logs, or tracebacks, wrap them in\xa0",(0,o.jsx)(i.code,{children:"Your Docusaurus site did not load properly.
\nA very common reason is a wrong site baseUrl configuration.
\nCurrent configured baseUrl = ${e} ${"/"===e?" (default value)":""}
\nWe suggest trying baseUrl =
\n>>0?1:0),g=o.low=g+N,o.high=h+j+(g>>>0>>0?1:0),O=p.low=O+H,p.high=A+U+(O>>>0