diff --git a/docs/docs/getting-started/install-langflow.mdx b/docs/docs/getting-started/install-langflow.mdx index 7d3de9a8e..8ffff19c0 100644 --- a/docs/docs/getting-started/install-langflow.mdx +++ b/docs/docs/getting-started/install-langflow.mdx @@ -46,12 +46,14 @@ python -m langflow run 2. Confirm that a local Langflow instance starts by visiting `http://127.0.0.1:7860` in a Chromium-based browser. -```bash -│ Welcome to ⛓ Langflow │ -│ │ -│ Access http://127.0.0.1:7860 │ -│ Collaborate, and contribute at our GitHub Repo 🚀 │ -``` + 3. Continue on to the [Quickstart](./quickstart). @@ -61,7 +63,7 @@ HuggingFace provides a great alternative for running Langflow in their Spaces en 1. **Access Langflow Space**: Open a Chromium-based browser and navigate to the [Langflow Space](https://huggingface.co/spaces/Langflow/Langflow?duplicate=true). This link directs you to a pre-configured environment for Langflow. -2. **Duplicate the Space**: Upon arrival, you'll encounter an option to duplicate the Langflow space. This step involves a few simple decisions: +2. **Duplicate the Space**: You'll encounter an option to duplicate the Langflow space. This step involves a few simple decisions: - **Naming Your Space**: Assign a unique name to your new Space. - **Visibility Settings**: Choose between Public or Private visibility for your Space. - After setting these parameters, click on **Duplicate Space** to initiate the setup. diff --git a/docs/docs/getting-started/new-to-llms.mdx b/docs/docs/getting-started/new-to-llms.mdx index bce3c1ec6..c6a73e96d 100644 --- a/docs/docs/getting-started/new-to-llms.mdx +++ b/docs/docs/getting-started/new-to-llms.mdx @@ -4,7 +4,9 @@ Large Language Models, or LLMs, are part of an exciting new world in computing. We made Langflow for anyone to create with LLMs, and hope you'll feel comfortable installing Langflow and [getting started](./quickstart). -If you want to learn more about LLMs, prompt engineering, and AI models, Langflow recommends [promptingguide.ai](https://promptingguide.ai), an open-source repository of prompt engineering content maintained by AI experts. +If you want to learn the basics of LLMs, prompt engineering, and AI models, Langflow recommends [promptingguide.ai](https://promptingguide.ai), an open-source repository of prompt engineering content maintained by AI experts. PromptingGuide offers content for [beginners](https://www.promptingguide.ai/introduction/basics) and [experts](https://www.promptingguide.ai/techniques/cot), as well as the latest [research papers](https://www.promptingguide.ai/papers) and [test results](https://www.promptingguide.ai/research) fueling AI's progress. -Wherever you are on your AI journey, it's helpful to keep Prompting Guide open in a tab. +For an in depth readings, we recommend [Awesome LLM Books](https://github.com/Hannibal046/Awesome-LLM?tab=readme-ov-file#llm-books), a curated list of resources for learning about LLMs and their applications. + +{/* Wherever you are on your AI journey, it's helpful to keep Prompting Guide open in a tab. */} diff --git a/docs/docs/getting-started/quickstart.mdx b/docs/docs/getting-started/quickstart.mdx index 0ec833e7c..7d4f15573 100644 --- a/docs/docs/getting-started/quickstart.mdx +++ b/docs/docs/getting-started/quickstart.mdx @@ -6,7 +6,7 @@ import Admonition from "@theme/Admonition"; # ⚡️ Quickstart -This guide demonstrates how to build a basic prompt flow and modify that prompt for different outcomes. +This guide demonstrates how to build a basic flow and modify the prompt for different outcomes. ## Prerequisites @@ -16,13 +16,6 @@ This guide demonstrates how to build a basic prompt flow and modify that prompt - [OpenAI API key](https://platform.openai.com) - - Langflow is also available in HuggingFace Spaces. [Clone the space - using this - link](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true) - to create your own Langflow workspace in minutes. - - ## Hello World - Basic Prompting Let's start with a Prompt component to instruct an OpenAI Model. @@ -79,7 +72,7 @@ By creating an environment variable, you keep your API key secure and make it ea Well done! You've built your first prompt in Langflow. 🎉 -By adding Langflow components to your flow, you can create all sorts of interesting behaviors. Here are a couple of examples: +By dragging Langflow components to your workspace, you can create all sorts of interesting behaviors. Here are a couple of examples: - [Memory Chatbot](/starter-projects/memory-chatbot) - [Blog Writer](/starter-projects/blog-writer) diff --git a/docs/docs/getting-started/workspace.mdx b/docs/docs/getting-started/workspace.mdx index 2372d8420..f937501cf 100644 --- a/docs/docs/getting-started/workspace.mdx +++ b/docs/docs/getting-started/workspace.mdx @@ -4,11 +4,11 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; import ReactPlayer from "react-player"; import Admonition from "@theme/Admonition"; -# 🖥️ Langflow Workspace +# 🎨 Langflow Workspace ## The Langflow Workspace Interface -The Langflow Workspace interface is designed to facilitate the creation, management, and execution of flows. It features a minimalistic design with various menus and options that are accessible for building and customizing a chatbot. +The **Langflow Workspace** is where you assemble new flows and create AIs by connecting and running components. To get started, click on **New Project**. You can either build a flow from scratch (Blank Flow) or choose from pre-built starter examples. ### Sidebar Menu @@ -27,43 +27,35 @@ The large central area where users can visually assemble and connect components In the top navigation bar, the dropdown menu labeled with the project name offers several management and customization options for the current flow in the Langflow Workspace. -* **New**: Create a new flow from scratch. +- **New**: Create a new flow from scratch. -* **Settings**: Adjust settings specific to the current flow, such as its Name, Description, and Endpoint Name. +- **Settings**: Adjust settings specific to the current flow, such as its Name, Description, and Endpoint Name. -* **Logs**: View logs for the current project, including execution history, errors, and other runtime events. +- **Logs**: View logs for the current project, including execution history, errors, and other runtime events. -* **Import**: Import a flow or component from a JSON file into the Workspace. +- **Import**: Import a flow or component from a JSON file into the Workspace. -* **Export**: Export the current flow as a JSON file. +- **Export**: Export the current flow as a JSON file. -* **Undo (⌘Z)**: Revert the last action taken in the project. +- **Undo (⌘Z)**: Revert the last action taken in the project. -* **Redo (⌘Y)**: Reapply a previously undone action. +- **Redo (⌘Y)**: Reapply a previously undone action. -* **Refresh All**: Refresh all components and data within the Workspace. +- **Refresh All**: Refresh all components and delete cache. ## Control Panel -- **Star**: Located in the top-right corner, allowing users to star or favorite the project for easy access. - **Playground**: Button that executes the current flow in the workspace. - **API**: Provides API access details and integration options for the current flow. -- **Share**: Allows users to share their project or flow with others, providing options for collaboration and review. - -## Utility Buttons - -- **Plus (+)**: Located at the bottom of the sidebar, used to add new components to the workspace. -- **Settings (gear icon)**: Provides access to settings for the Langflow Workspace, where users can customize their experience or manage account settings. - -The **Langflow Workspace** is where you assemble new flows by connecting components and run them. To get started, click on **New Project**. You can either build a flow from scratch (Blank Flow) or choose from pre-built starter examples. +- **Share**: Allows users to share their AI with others. ## Flows & Components @@ -85,14 +77,16 @@ For example, the [Basic Prompting](../starter-projects/basic-prompting) flow is light: useBaseUrl("img/basic-prompting.png"), dark: useBaseUrl("img/basic-prompting.png"), }} - style={{ width: "100%", maxWidth: "800px", margin: "0 auto" }} + style={{ width: "100%", maxWidth: "800px", margin: "20px auto" }} /> +{" "} + In this flow, the **OpenAI Model** receives input (left side) and produces output (right side) - in this case, receiving input from the **Chat Input** and **Prompt** components and passing the output to the **Chat Output** component. ## Component -Components are the building blocks of flows. They consist 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 in the [Components Section](../components). +Components are the building blocks of flows. They consist 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.
During the flow creation process, you will notice handles (colored circles) @@ -101,57 +95,66 @@ Components are the building blocks of flows. They consist of inputs, outputs, an Hover over a handle to see connection details.
-
-For example, if you select a ConversationChain component, you -will see orange o and purple{" "} - - o input handles. They indicate that - this component accepts an LLM and a Memory component as inputs. The red - asterisk * means that at least one input - of that type is required. -
- {" "}
-In the top right corner of the component, you'll find the component status icon (![Status icon](/logos/playbutton.svg)). +{/\* On the top right corner of the component, you'll find the component status icon (![Status icon](/logos/playbutton.svg)). Build the flow by clicking the **![Playground icon](/logos/botmessage.svg)Playground** at the bottom right of the workspace. Once the validation is complete, the status of each validated component should turn green (![Status icon](/logos/greencheck.svg)). -To debug, hover over the component status to see the outputs. +To debug, hover over the component status to see the outputs. \*/}
-### Multiple outputs +{/\* ### Multiple outputs -A component can have multiple outputs. For example, this one Chat Input component routes through three prompt chains, and returns three different responses to a single question in the Playground. - - +A component can have multiple outputs. For example, this one Chat Input component routes through three prompt chains, and returns three different responses to a single question in the Playground. \*/} ### Output Preview -Langflow now includes an output visualizer for components that opens a pop-up screen. This allows you to easily inspect and monitor transmissions between components, providing instant feedback on your workflows. +Langflow includes an output visualizer for components that opens a pop-up screen. This allows you to easily inspect and monitor transmissions between components, providing instant feedback on your workflows. -### Component Parameters + -Langflow components can be edited by clicking the component settings button. +### Component Menu + +Each component is a little unique, but they will all have a menu bar on top that looks something like this. + + + +It consists of options such as: + +**Code** - displays component's Python code. You can modify the code and save it. + +**Advanced** - See and adjust all parameters of a component. + +**Freeze** - After a component runs, lock its previous output state to prevent it from re-running. + +Click **All** (the "..." button) to see all options.
+### Advanced Settings + +Langflow components can be edited by clicking the **Advanced Settings** button. + +
+ +
+ Hide parameters with the **SHOW** button to reduce complexity and keep the workspace clean and intuitive for experimentation. -Double-click the component name to rename it. +You can also double-click a component's name and description to modify those. Component descriptions accept markdown syntax. -### Component menu +### Group Components -Each component is a little unique, but they will all have a menu bar on top that looks something like this. -The menu options are **Code**, **Advanced Settings**, **Freeze**, and **More**. +Multiple components can be grouped into a single component for reuse. This is useful when combining large flows into single components (like RAG with a vector database, for example) and saving space. - - -### Code menu - -The **Code** button displays your component's Python code. -You can modify the code and save it. - -### Advanced Settings - -Modify the parameters of your component. - -#### Freeze - -After a component runs, lock its previous output state to prevent it from re-running. - -This avoids spending tokens when consistent output is expected. - -#### More - -**Code** - Modify your component's Python code. -**Advanced** - modify the parameters of your component. - -
- -
- -**Copy** - copy your component. - -**Share** - share your component to the Langflow store. - -**Docs** - view documentation for your component. - -**Delete** - delete your component. - -### Group multiple components - -Components without input or output nodes can be grouped into a single component for reuse. -This is useful for combining large flows into single components (like RAG with a vector database, for example) and saving space. - -1. Hold **Shift** and drag to select the **Prompt** and **OpenAI** components. +1. Hold **Shift** and drag to select components. 2. Select **Group**. 3. The components merge into a single component. -4. To save the new component, select **Save**. It can now be reused from the **Saved** components folder. +4. Double click name and description to change them. +5. Save your grouped component to in the sidebar for later use! ### Update component version @@ -227,19 +197,29 @@ A component's state is stored in a database, while sidebar components are like s As soon as you drag a component from the sidebar to the workspace, the two components are no longer in parity. -The component will keep the version number it was initilized to the workspace with. Click the **Update Component** icon to bring the component up to the `latest` version. +The component will keep the version number it was initilized to the workspace with. Click the **Update Component** icon (exclamation mark) to bring the component up to the `latest` version. This will change the code of the component in place so you can validate that the component was updated by checking its Python code before and after updating it. + + ## Playground -Run your flow by clicking the **![Playground icon](/logos/botmessage.svg)Playground** button. +Run your AI by clicking the **![Playground icon](/logos/botmessage.svg)Playground** button. For more, see [Playground](../administration/playground). ## API -The **API** button opens the API window, where Langflow presents code for integrating your flow into external applications. +{/* rsn */} +The **API** session presents code templates for integrating your flow into external applications. -Modify the call's parameters in the **Tweaks** window, click the **Copy Code** or **Download** buttons, and paste your code where you want to use it. +{/* Modify parameters in the **Tweaks** window, click **Copy Code** or **Download** buttons, and paste your code where you want to use it. */} -### curl +### cURL -The **curl** tab displays sample code for posting a query to your flow. +The **cURL** tab displays sample code for posting a query to your flow. Modify the `input_value` to change your input message. Copy the code and run it to post a query to your flow and get the result. @@ -300,4 +280,4 @@ For example, changing the **Chat Input** component's `input_value` will change t style={{ marginBottom: "20px", display: "flex", justifyContent: "center" }} > - \ No newline at end of file + diff --git a/docs/docs/index.mdx b/docs/docs/index.mdx index 8a9e18abe..c6b6e0e71 100644 --- a/docs/docs/index.mdx +++ b/docs/docs/index.mdx @@ -5,14 +5,15 @@ import Admonition from "@theme/Admonition"; # 👋 Welcome to Langflow -Langflow is a new, visual way to build, iterate, and deploy AI applications. +Langflow is a new, visual framework for building multi-agent and RAG applications. It is open-source, Python-powered, fully customizable, LLM and vector store agnostic. Its intuitive interface allows for easy manipulation of AI building blocks, enabling developers to quickly prototype and turn their ideas into powerful, real-world solutions. {" "} +{/* rsn */} - Langflow is also available in HuggingFace Spaces. [Clone the space - using this + Langflow is also available in HuggingFace Spaces. [Clone the space using this link](https://huggingface.co/spaces/Langflow/Langflow-Preview?duplicate=true) - to create your own Langflow workspace in minutes. + to run your own Langflow instance in minutes. ## Learn more about Langflow 1.0 Learn more about the exciting changes in Langflow 1.0, and how to migrate your existing Langflow projects. +{/* rsn */} + - [A new chapter for Langflow](/whats-new/a-new-chapter-langflow) - [Migration guides](/migration/migrating-to-one-point-zero) diff --git a/docs/static/img/basic-prompting.png b/docs/static/img/basic-prompting.png index 76d658a2d..b56696f44 100644 Binary files a/docs/static/img/basic-prompting.png and b/docs/static/img/basic-prompting.png differ diff --git a/docs/static/img/component-menu.png b/docs/static/img/component-menu.png new file mode 100644 index 000000000..350e5dfbf Binary files /dev/null and b/docs/static/img/component-menu.png differ diff --git a/docs/static/img/component-update.png b/docs/static/img/component-update.png new file mode 100644 index 000000000..88ba32d2c Binary files /dev/null and b/docs/static/img/component-update.png differ diff --git a/docs/static/img/inspect-output.png b/docs/static/img/inspect-output.png new file mode 100644 index 000000000..14418f74c Binary files /dev/null and b/docs/static/img/inspect-output.png differ diff --git a/docs/static/img/menu-options.png b/docs/static/img/menu-options.png new file mode 100644 index 000000000..ecfc13332 Binary files /dev/null and b/docs/static/img/menu-options.png differ diff --git a/docs/static/img/single-component.png b/docs/static/img/single-component.png new file mode 100644 index 000000000..cdfe8bc46 Binary files /dev/null and b/docs/static/img/single-component.png differ diff --git a/docs/static/img/welcome-to-langflow.png b/docs/static/img/welcome-to-langflow.png new file mode 100644 index 000000000..b4903e7da Binary files /dev/null and b/docs/static/img/welcome-to-langflow.png differ