Docs: New Getting Started (#4547)

* remove-and-redirect-1.0

* remove-and-redirect-installation-page

* remove-emojis-in-titles

* more-emoji

* welcome-cleanup-initial

* new-intro

* more-redirect

* better-title

* Apply suggestions from code review

Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>

* code-review

---------

Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
This commit is contained in:
Mendon Kissling 2024-11-12 17:31:09 -05:00 committed by GitHub
commit 9e64ae80c9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
12 changed files with 146 additions and 331 deletions

View file

@ -1,53 +0,0 @@
---
title: ❗️ Common Installation Issues
sidebar_position: 3
slug: /getting-started-common-installation-issues
---
This is a list of possible issues that you may encounter when installing Langflow and how to solve them.
---
```bash
> No module named 'langflow.__main__'
```
1. Run `python -m langflow run` instead of `langflow run`.
2. If that doesn't work, reinstall Langflow with `_python -m pip install langflow --pre -U`.
3. If that doesn't work, reinstall Langflow and its dependencies with `python -m pip install langflow --pre -U --force-reinstall`.
When you try to run Langflow using the command `langflow run`, you may encounter the following error:
```bash
> langflow runTraceback (most recent call last): File ".../langflow", line 5, in <module> from langflow.__main__ import mainModuleNotFoundError: No module named 'langflow.__main__'
```
There are two possible reasons for this error:
1. You've installed Langflow using `pip install langflow` but you already had a previous version of Langflow installed in your system. In this case, you might be running the wrong executable. To solve this issue, run the correct executable by running `python -m langflow run` instead of `langflow run`. If that doesn't work, try uninstalling and reinstalling Langflow with `python -m pip install langflow --pre -U`.
2. Some version conflicts might have occurred during the installation process. Run `python -m pip install langflow --pre -U --force-reinstall` to reinstall Langflow and its dependencies.
```bash
> Something went wrong running migrations. Please, run 'langflow migration --fix'
```
Clear the cache by deleting the contents of the cache folder.
This folder can be found at:
- **Linux or WSL2 on Windows**: `home/<username>/.cache/langflow/`
- **MacOS**: `/Users/<username>/Library/Caches/langflow/`
This error can occur during Langflow upgrades when the new version can't override `langflow-pre.db` in `.cache/langflow/`. Clearing the cache removes this file but will also erase your settings.
If you wish to retain your files, back them up before clearing the folder.

View file

@ -1,97 +1,115 @@
---
title: 📦 Installation
title: Install Langflow
sidebar_position: 1
slug: /getting-started-installation
---
You can deploy Langflow either locally or as a hosted service with [**Datastax Langflow**](#datastax-langflow).
## Install Langflow locally
## **DataStax Langflow** {#a3b4bd8dec5a49ebbfca4828492133e9}
---
The easiest way to get started with Langflow is through the DataStax Cloud Service!
**DataStax Langflow** is a hosted version of Langflow integrated with [Astra DB](https://www.datastax.com/products/datastax-astra). Be up and running in minutes with no installation or setup required. [Sign up for free](https://astra.datastax.com/signup?type=langflow).
![](./602374500.png)
## **Install Langflow Locally** {#ef364ee864c545649d248113ad7d3038}
---
:::caution
Langflow **requires** Python version 3.10 or greater and [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/) to be installed on your system.
:::
Install Langflow locally with [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/).
### Prerequisites
* [Python 3.10 to 3.12](https://www.python.org/downloads/release/python-3100/) installed
* [pip](https://pypi.org/project/pip/) or [pipx](https://pipx.pypa.io/stable/installation/) installed
* Before installing Langflow, we recommend creating a virtual environment to isolate your Python dependencies with [venv](https://docs.python.org/3/library/venv.html) or [conda](https://anaconda.org/anaconda/conda)
### Install Langflow with pip or pipx
Install Langflow with pip:
```bash
python -m pip install langflow -U
python -m pip install langflow
```
Install Langflow with pipx:
Install Langflow with pipx using the Python 3.10 executable:
```bash
pipx install langflow --python python3.10 --fetch-missing-python
pipx install langflow --python python3.10
```
Pipx can fetch the missing Python version for you with `--fetch-missing-python`, but you can also install the Python version manually. Use `--force-reinstall` to ensure you have the latest version of Langflow and its dependencies.
## Having a problem? {#86a16dad1d6e481cafb90efea2b9ff93}
---
If you encounter a problem, see [Common Installation Issues](/getting-started-common-installation-issues).
To get help in the Langflow CLI:
```bash
python -m langflow --help
```
## ⛓️ Run Langflow {#d318c4d486b74f5383c45b4f6859dcaa}
---
## Run Langflow
1. To run Langflow, enter the following command.
```bash
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.
Now that Langflow is running, follow the [Quickstart](/getting-started-quickstart) to create your first flow.
## Manage Langflow versions
To upgrade Langflow to the latest version, use the pip upgrade command.
```bash
python -m pip install langflow -U
```
To install a specific verison of the Langflow package, add the required version to the command.
```bash
python -m pip install langflow==1.1
```
To reinstall Langflow and all of its dependencies, add the `--force-reinstall` flag to the command.
```bash
python -m pip install langflow --force-reinstall
```
## DataStax Langflow {#datastax-langflow}
**DataStax Langflow** is a hosted version of Langflow integrated with [Astra DB](https://www.datastax.com/products/datastax-astra). Be up and running in minutes with no installation or setup required. [Sign up for free](https://astra.datastax.com/signup?type=langflow).
## Common installation issues
This is a list of possible issues that you may encounter when installing and running Langflow.
### No `langflow.__main__` module
When you try to run Langflow with the command `langflow run`, you encounter the following error:
```bash
> No module named 'langflow.__main__'
```
1. Run `python -m langflow run` instead of `langflow run`.
2. If that doesn't work, reinstall the latest Langflow version with `python -m pip install langflow -U`.
3. If that doesn't work, reinstall Langflow and its dependencies with `python -m pip install langflow --pre -U --force-reinstall`.
### Langflow runTraceback
When you try to run Langflow using the command `langflow run`, you encounter the following error:
```bash
> langflow runTraceback (most recent call last): File ".../langflow", line 5, in <module> from langflow.__main__ import mainModuleNotFoundError: No module named 'langflow.__main__'
```
There are two possible reasons for this error:
1. You've installed Langflow using `pip install langflow` but you already had a previous version of Langflow installed in your system. In this case, you might be running the wrong executable. To solve this issue, run the correct executable by running `python -m langflow run` instead of `langflow run`. If that doesn't work, try uninstalling and reinstalling Langflow with `python -m pip install langflow --pre -U`.
2. Some version conflicts might have occurred during the installation process. Run `python -m pip install langflow --pre -U --force-reinstall` to reinstall Langflow and its dependencies.
### Something went wrong running migrations
```bash
> Something went wrong running migrations. Please, run 'langflow migration --fix'
```
Clear the cache by deleting the contents of the cache folder.
This folder can be found at:
- **Linux or WSL2 on Windows**: `home/<username>/.cache/langflow/`
- **MacOS**: `/Users/<username>/Library/Caches/langflow/`
This error can occur during Langflow upgrades when the new version can't override `langflow-pre.db` in `.cache/langflow/`. Clearing the cache removes this file but also erases your settings.
If you wish to retain your files, back them up before clearing the folder.
![](./221680153.png)
3. Continue on to the [Quickstart](/getting-started-quickstart).

View file

@ -1,5 +1,5 @@
---
title: ⚡️ Quickstart
title: Quickstart
sidebar_position: 2
slug: /getting-started-quickstart
---

View file

@ -0,0 +1,40 @@
---
title: Welcome to Langflow
sidebar_position: 0
slug: /
---
Langflow is a new, visual framework for building multi-agent and RAG applications. It is open-source, Python-powered, fully customizable, and 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.
Langflow empowers developers to rapidly prototype and build AI applications with its user-friendly interface and powerful features. Whether you're a seasoned AI developer or just starting out, Langflow provides the tools you need to bring your AI ideas to life.
## Visual flow builder
Langflow is an intuitive visual flow builder. This drag-and-drop interface allows developers to create complex AI workflows without writing extensive code. You can easily connect different components, such as prompts, language models, and data sources, to build sophisticated AI applications.
![Langflow in action](./1160086633.gif)
## Use cases
Langflow can be used for a wide range of AI applications, including:
* [Craft intelligent chatbots](/starter-projects-memory-chatbot)
* [Build document analysis systems](/starter-projects-document-qa)
* [Generate compelling content](/starter-projects-blog-writer)
* [Orchestrate multi-agent applications](/starter-projects-simple-agent)
## Community and support
Join Langflow's vibrant community of developers and AI enthusiasts. See the following resources to join discussions, share your projects, and get support:
* [Contribute to Langflow](contributing-how-to-contribute)
* [Langflow Discord Server](https://discord.gg/EqksyE2EX9)
* [@langflow_ai](https://twitter.com/langflow_ai) 
## Get started with Langflow
- [Install Langflow](/getting-started-installation)
- [Quickstart](/getting-started-quickstart)

View file

@ -1,34 +0,0 @@
---
title: 👋 Welcome to Langflow
sidebar_position: 0
slug: /
---
## Introduction {#e12578e9f465459592d89dbe47a54460}
---
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.
![](./1160086633.gif)
## 🚀 First steps {#c1ccb5e315b040edaa8d9a67f4960d81}
---
- [Install Langflow](/getting-started-installation) - Install and start a local Langflow server.
- [Quickstart](/getting-started-quickstart) - Create a flow and run it.
- [Langflow Workspace](/workspace-overview) - Learn more about the Langflow Workspace.
Learn more about the exciting changes in Langflow 1.0 in [A new chapter for Langflow](/whats-new-a-new-chapter-langflow).

View file

@ -1,4 +1,8 @@
# Dynamic Agent
---
title: Dynamic agent
sidebar_position: 7
slug: /starter-projects-dynamic-agent
---
Build a **Dynamic Agent** flow for an agentic application using the CrewAI.

View file

@ -1,4 +1,8 @@
# Simple Agent
---
title: Simple agent
sidebar_position: 6
slug: /starter-projects-simple-agent
---
Build a **Simple Agent** flow for an agentic application using the Tool-calling agent.

View file

@ -1,4 +1,8 @@
# Travel Planning Agent
---
title: Travel planning agent
sidebar_position: 8
slug: /starter-projects-travel-planning-agent
---
Build a **Travel Planning Agent** flow for an agentic application using the multiple Tool-calling agents.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1 MiB

View file

@ -1 +0,0 @@
{"position":0, "label":"Whats New?"}

View file

@ -1,175 +0,0 @@
---
title: 1.0 - A new chapter for Langflow
sidebar_position: 0
slug: /whats-new-a-new-chapter-langflow
---
![](./1143907392.png)
## First things first {#5add758564574950862f689198a4e085}
---
**Thank you all for being part of the Langflow community**. The journey so far has been amazing, and we are thrilled to have you with us.
We have some exciting news to share with you. Langflow is evolving, and we want to tell you all about it!
## What's new? {#ecad059e8f8249c598404c0b2bab36fa}
---
In the past year, we learned a lot from the community and our users. We saw the potential of Langflow and the need for a visual, interactive platform for building conversational AI applications (and beyond). You thought us the importance of a platform that is easy to use, but also powerful and controllable, and that made clear to us how Langflow's transparency could be improved.
Below are some of the new features we included to make that happen!
### Same Component, Multiple Outputs {#85986f3ae303444fb69d9ea1baa2eca8}
Components can now have more than a single output, allowing for unique flexibility in creating complex flows. The game-changer is output routing — it allows for so many new capabilities its almost silly to describe!
1. Branch to one or more subsequent components;
2. Apply logic operations like if/else and exploit decision-making;
3. Create classification models that choose between paths;
4. Enable the development of agent architectures from scratch;
5. Build an orchestrator that routes between agents.
### Flow + Composition {#12d86f91b5af4abc9f8e885c5f828df4}
One key change you'll notice is that projects now require you to define **Inputs** and **Outputs**. They allow you to define the structure of your conversation and how data flows through it. This change comes with a new way of visualizing your projects.
Before 1.0 you would connect components to ultimately build one final component that was processed behind the scenes. Now, each step of the process is defined by you, is visible on the workspace, and can be monitored and controlled.
This makes it so that composition is now just **another way** of building in Langflow and **data flows through your project more transparently**. This means that the easy stuff is _really_ easy and the complex parts are still possible!
- **Flow:** Data is processed by one component and then passed to the next component in line for immediate execution.
- **Composition**: Allows components to not only forward data but also share states for modular building.
For example, a flow can sequentially process text, and after a few steps, trigger an agent. It can access functions that wait to be called or to respond. This blend of flow and composition brings an unprecedented level of flexibility and control to data workflows in LLM-based apps and agents that use multiple models and APIs working together to achieve tasks.
### Memory Management {#a9e352272f4a44499f52fae65b663118}
Langflow 1.0 natively allows every chat message to be stored, and a single flow can have multiple memory sessions. This enables you to create multiple “memories” for agents to store and recall specific information as needed.
You can edit and remove previous messages to inspect and validate a models response behavior. Control, explore, and manage conversation histories to get your models acting just right.
### Component Freeze 🥶 {#4912d08da5464ff2aff595d6b26fd809}
Component output freezing is back in Langflow, and its cooler than ever!
Once a component runs, you can now lock its previous output state to prevent it from re-running.
Avoid spending extra tokens and remove repetition when output should be constant — plus it's great for debugging and prototyping!
### Output Preview {#f56d4400b0214ef2ab1206add068dd99}
Each component now includes an output visualizer that opens a pop-up screen, allowing you to easily inspect and monitor transmissions between components. It provides instant feedback on your workflows, letting you see results as they are processed. 🔍
### Inputs and Outputs Handling {#2112c11dc496480c9bd681f04f8533ea}
Inputs and outputs finally make more sense to us, and hopefully to you too.
Were proposing Langflow-native types to keep things consistent, but not limited to use any Python type. For instance, a Chat Input component sends out what we call a Message object (text + metadata like date, time, and sender), but maybe you want to introduce external types from your favorite Python package? Go wild. Each native type will have their own visualization modes and will evolve according to new integrations added.
### Custom Endpoint Name {#bfeb7018e8bd46bf9dbef43ce2d3692b}
Now you can pick a custom name for your endpoint used to call your flow from the API.
### Logs & Monitoring {#c902ee43b4b24711b526352ae2451c48}
A new logs page has been added! Now, both component executions and message history from the chat can be inspected in an interactive table. This will make it easier to debug, inspect, and manage messages passing through components.
### Folders 📁 {#d01237fd83e4467994fed6fa7a8ee4f4}
We introduced folders on the home page to help categorize flows and components. Create, remove and edit them to keep your work organized.
### Playground {#27649918dcb64a0ebae83db767bfe2eb}
By having a clear definition of Inputs and Outputs, we could build the experience around that, which led us to create the Playground.
When building a project, testing and debugging are crucial. The Playground is an interface that changes dynamically based on the Inputs and Outputs you defined in your project.
For example, let's say you are building a simple RAG application. Generally, you have an Input, some references that come from a Vector Store Search, a Prompt, and the answer. Now, you could plug the output of your Prompt into a Text Output, rename that to "Prompt Result," and see the output of your Prompt in the Playground. We have many planned features for the Playground, and we're excited to see how you'll explore it!
### Multi-Modal {#b7753bc9d72f40c49c4074a8d0e51344}
Langflow is now multi-modal! It can now handle images and more soon!
Weve also improved project organization, global variables and overall settings, added Python 3.12 compatibility, keyboard shortcuts and a lot of new and fun experimental components!
## An Easier Start {#c6bf434c0d35482bbf2ef0bceff902f0}
---
The experience for first-time users is something we wanted to improve. For that we created a couple of Starter Projects. It's now much easier to start a new project, and you can choose from a list of starter projects to get you going.
For now, we have:
- **Basic Prompting (Hello, World)**: Learn the basics of a Prompt Component.
- **Vector Store RAG**: Ingest data into a Vector Store and then use it to run a RAG application.
- **Memory Chatbot**: Create a simple chatbot that can remember things about the user.
- **Document QA**: Build a simple flow that helps you get answers about a document.
- **Blog Writer**: Expand on the Prompt variables and be creative about what inputs you add to it.
Please let us know what other starter projects you would like to see in the future!
## What's Next? {#21004578890d4397bc291b43eb140640}
---
Langflow has gone through a big change, and we are excited to see how you use it and what you think of it. We plan to add more types of Input and Output like Image and Audio, and we also plan to add more Components to help you build more complex projects.
We are excited to see the community embracing Langflow as their number one AI builder and eagerly wait to see what new inspiring projects will come out of this release! A big thanks to everyone who's supporting or being part of this community in any way. ✨
Sincerely,
**The Langflow Team 🚀**

View file

@ -82,6 +82,14 @@ const config = {
'@docusaurus/plugin-client-redirects',
{
redirects: [
{
to: '/',
from: ['/whats-new-a-new-chapter-langflow', '/👋 Welcome-to-Langflow'],
},
{
to: '/getting-started-installation',
from: '/getting-started-common-installation-issues',
},
{
to: '/workspace-overview',
from: ['/365085a8-a90a-43f9-a779-f8769ec7eca1', '/My-Collection', '/workspace', '/settings-project-general-settings'],