From 9b88eab828c9fc03d08cccd3ce180a301a17a3f6 Mon Sep 17 00:00:00 2001 From: Lucas Oliveira Date: Mon, 24 Jun 2024 08:31:18 -0300 Subject: [PATCH] Added warning of outdated information to all components --- docs/docs/administration/api.mdx | 4 ++++ docs/docs/administration/chat-widget.mdx | 4 ++++ docs/docs/administration/cli.mdx | 6 ++++++ docs/docs/administration/collections-projects.mdx | 4 ++++ docs/docs/administration/global-env.mdx | 4 ++++ docs/docs/administration/login.mdx | 4 ++++ docs/docs/administration/logs.mdx | 4 ++++ docs/docs/administration/memories.mdx | 4 ++++ docs/docs/administration/playground.mdx | 4 ++++ docs/docs/administration/prompt-customization.mdx | 4 ++++ docs/docs/administration/settings.mdx | 6 ++++++ docs/docs/components/agents.mdx | 4 ++++ docs/docs/components/chains.mdx | 4 ++++ docs/docs/components/custom.mdx | 4 ++++ docs/docs/components/data.mdx | 4 ++++ docs/docs/components/embeddings.mdx | 6 ++++++ docs/docs/components/experimental.mdx | 4 ++++ docs/docs/components/helpers.mdx | 4 ++++ docs/docs/components/inputs-and-outputs.mdx | 4 ++++ docs/docs/components/loaders.mdx | 4 ++++ docs/docs/components/memories.mdx | 4 ++++ docs/docs/components/model_specs.mdx | 4 ++++ docs/docs/components/models.mdx | 4 ++++ docs/docs/components/retrievers.mdx | 4 ++++ docs/docs/components/text-and-record.mdx | 6 ++++++ docs/docs/components/text-splitters.mdx | 4 ++++ docs/docs/components/toolkits.mdx | 4 ++++ docs/docs/components/tools.mdx | 4 ++++ docs/docs/components/utilities.mdx | 4 ++++ docs/docs/components/vector-stores.mdx | 4 ++++ docs/docs/contributing/{community.md => community.mdx} | 6 ++++++ .../{contribute-component.md => contribute-component.mdx} | 5 +++++ .../contributing/{github-issues.md => github-issues.mdx} | 6 ++++++ .../contributing/{how-contribute.md => how-contribute.mdx} | 6 ++++++ docs/docs/deployment/{backend-only.md => backend-only.mdx} | 6 ++++++ docs/docs/deployment/{docker.md => docker.mdx} | 6 ++++++ .../deployment/{gcp-deployment.md => gcp-deployment.mdx} | 6 ++++++ docs/docs/examples/chat-memory.mdx | 4 ++++ docs/docs/examples/combine-text.mdx | 4 ++++ docs/docs/examples/create-record.mdx | 4 ++++ docs/docs/examples/pass.mdx | 4 ++++ docs/docs/examples/store-message.mdx | 4 ++++ docs/docs/examples/sub-flow.mdx | 4 ++++ docs/docs/examples/text-operator.mdx | 4 ++++ docs/docs/getting-started/install-langflow.mdx | 4 ++++ docs/docs/getting-started/quickstart.mdx | 4 ++++ docs/docs/getting-started/rag-with-astradb.mdx | 4 ++++ docs/docs/getting-started/workspace.mdx | 4 ++++ docs/docs/integrations/langsmith/intro.mdx | 4 ++++ docs/docs/integrations/notion/add-content-to-page.md | 4 ++++ docs/docs/integrations/notion/intro.md | 4 ++++ docs/docs/integrations/notion/list-database-properties.md | 4 ++++ docs/docs/integrations/notion/list-pages.md | 4 ++++ docs/docs/integrations/notion/list-users.md | 4 ++++ docs/docs/integrations/notion/page-content-viewer.md | 4 ++++ docs/docs/integrations/notion/page-create.md | 4 ++++ docs/docs/integrations/notion/page-update.md | 4 ++++ docs/docs/integrations/notion/search.md | 4 ++++ docs/docs/integrations/notion/setup.md | 4 ++++ docs/docs/migration/compatibility.mdx | 4 ++++ docs/docs/migration/migrating-to-one-point-zero.mdx | 4 ++++ docs/docs/starter-projects/basic-prompting.mdx | 4 ++++ docs/docs/starter-projects/blog-writer.mdx | 4 ++++ docs/docs/starter-projects/document-qa.mdx | 4 ++++ docs/docs/starter-projects/memory-chatbot.mdx | 4 ++++ docs/docs/starter-projects/vector-store-rag.mdx | 4 ++++ docs/docs/tutorials/chatprompttemplate_guide.mdx | 5 +++++ docs/docs/tutorials/custom_components.mdx | 4 ++++ docs/docs/tutorials/loading_document.mdx | 5 +++++ docs/docs/tutorials/rag-with-astradb.mdx | 4 ++++ 70 files changed, 303 insertions(+) rename docs/docs/contributing/{community.md => community.mdx} (85%) rename docs/docs/contributing/{contribute-component.md => contribute-component.mdx} (94%) rename docs/docs/contributing/{github-issues.md => github-issues.mdx} (88%) rename docs/docs/contributing/{how-contribute.md => how-contribute.mdx} (92%) rename docs/docs/deployment/{backend-only.md => backend-only.mdx} (96%) rename docs/docs/deployment/{docker.md => docker.mdx} (90%) rename docs/docs/deployment/{gcp-deployment.md => gcp-deployment.mdx} (93%) diff --git a/docs/docs/administration/api.mdx b/docs/docs/administration/api.mdx index db74fa506..737213cfd 100644 --- a/docs/docs/administration/api.mdx +++ b/docs/docs/administration/api.mdx @@ -4,6 +4,10 @@ import Admonition from "@theme/Admonition"; # API Keys + +This page may contain outdated information. It will be updated as soon as possible. + + 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 or query parameter to authenticate API calls. This documentation outlines how to generate, use, and manage API keys in Langflow. diff --git a/docs/docs/administration/chat-widget.mdx b/docs/docs/administration/chat-widget.mdx index 0a6669cdd..e4d744a40 100644 --- a/docs/docs/administration/chat-widget.mdx +++ b/docs/docs/administration/chat-widget.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Chat Widget + +This page may contain outdated information. It will be updated as soon as possible. + +
The Langflow Chat Widget is a powerful web component that enables communication with a Langflow project. This widget allows for a chat interface diff --git a/docs/docs/administration/cli.mdx b/docs/docs/administration/cli.mdx index 4f11cc721..2a54c1fca 100644 --- a/docs/docs/administration/cli.mdx +++ b/docs/docs/administration/cli.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Command Line Interface (CLI) + +This page may contain outdated information. It will be updated as soon as possible. + + Langflow's Command Line Interface (CLI) is a powerful tool that allows you to interact with the Langflow server from the command line. The CLI provides a wide range of commands to help you shape Langflow to your needs. The available commands are below. Navigate to their individual sections of this page to see the parameters. diff --git a/docs/docs/administration/collections-projects.mdx b/docs/docs/administration/collections-projects.mdx index d289b5d71..f0ef70ee4 100644 --- a/docs/docs/administration/collections-projects.mdx +++ b/docs/docs/administration/collections-projects.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Collections and Projects + +This page may contain outdated information. It will be updated as soon as possible. + + My Collection is a space in Langflow where users can manage, organize, and access their flows and components. Flows and components are displayed as individual cards that provide relevant information. diff --git a/docs/docs/administration/global-env.mdx b/docs/docs/administration/global-env.mdx index 06ef488a8..fa8f7ff5d 100644 --- a/docs/docs/administration/global-env.mdx +++ b/docs/docs/administration/global-env.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Global Variables + +This page may contain outdated information. It will be updated as soon as possible. + + Global Variables are a useful feature of Langflow, allowing you to define reusable variables accessed from any Text field in your project. **TL;DR** diff --git a/docs/docs/administration/login.mdx b/docs/docs/administration/login.mdx index 9f3c12cf9..65ed2c178 100644 --- a/docs/docs/administration/login.mdx +++ b/docs/docs/administration/login.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Sign Up and Sign In + +This page may contain outdated information. It will be updated as soon as possible. + + The login functionality in Langflow serves to authenticate users and protect sensitive routes in the application. Starting from version 0.5, Langflow introduces an enhanced login mechanism that is governed by a few environment variables. This allows new secure features. ## Environment variables diff --git a/docs/docs/administration/logs.mdx b/docs/docs/administration/logs.mdx index 8f26d2f8a..85c1497be 100644 --- a/docs/docs/administration/logs.mdx +++ b/docs/docs/administration/logs.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Logs + +This page may contain outdated information. It will be updated as soon as possible. + + To view logs, go to **Project Options** > **Logs**. The **Logs** page provides a detailed record of all component executions within a workspace. diff --git a/docs/docs/administration/memories.mdx b/docs/docs/administration/memories.mdx index e0679afc7..5946590ec 100644 --- a/docs/docs/administration/memories.mdx +++ b/docs/docs/administration/memories.mdx @@ -5,6 +5,10 @@ import Admonition from "@theme/Admonition"; # Chat Memory + +This page may contain outdated information. It will be updated as soon as possible. + + Langflow 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 model’s response behavior. Control, explore, and manage conversation histories to get your models acting just right. The **Chat Memory** component retrieves message histories by session ID. Users can change the session ID in the advanced settings, with the default session ID set to match the flow ID. These memories are accessible and manageable directly from the Playground; modifications to them directly affect the behavior of chatbot responses. Users can remove or edit previous messages to manipulate and explore model responses further. diff --git a/docs/docs/administration/playground.mdx b/docs/docs/administration/playground.mdx index dec2225c8..1ef59e08b 100644 --- a/docs/docs/administration/playground.mdx +++ b/docs/docs/administration/playground.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Playground + +This page may contain outdated information. It will be updated as soon as possible. + + From the **My Collection** page, click the Playground button in one of your flow cards. It will directly open up a window with that project's Playground, without even showing the flow (this also works for flows hosted on the Langflow Store!). diff --git a/docs/docs/administration/prompt-customization.mdx b/docs/docs/administration/prompt-customization.mdx index 2a1b1f210..661610611 100644 --- a/docs/docs/administration/prompt-customization.mdx +++ b/docs/docs/administration/prompt-customization.mdx @@ -5,6 +5,10 @@ import ReactPlayer from "react-player"; # Prompt Customization + +This page may contain outdated information. It will be updated as soon as possible. + + The prompt template allows users to create prompts and define variables that provide control over instructing the model. {" "} diff --git a/docs/docs/administration/settings.mdx b/docs/docs/administration/settings.mdx index 3599e967e..dba6da78b 100644 --- a/docs/docs/administration/settings.mdx +++ b/docs/docs/administration/settings.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Settings + +This page may contain outdated information. It will be updated as soon as possible. + + Change the **Project Settings** or **General Settings** for Langflow. ## Project Settings diff --git a/docs/docs/components/agents.mdx b/docs/docs/components/agents.mdx index 00d597804..4482c0637 100644 --- a/docs/docs/components/agents.mdx +++ b/docs/docs/components/agents.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Agents + +This page may contain outdated information. It will be updated as soon as possible. + + Agents are components that use reasoning to make decisions and take actions, designed to autonomously perform tasks or provide services with some degree of agency. LLM chains can only perform hardcoded sequences of actions, while agents use LLMs to reason through which actions to take, and in which order. --- diff --git a/docs/docs/components/chains.mdx b/docs/docs/components/chains.mdx index a57f442e3..3d4b60b6a 100644 --- a/docs/docs/components/chains.mdx +++ b/docs/docs/components/chains.mdx @@ -5,6 +5,10 @@ import Admonition from "@theme/Admonition"; # Chains + +This page may contain outdated information. It will be updated as soon as possible. + + Chains, in the context of language models, refer to a series of calls made to a language model. This approach allows for using the output of one call as the input for another. Different chain types facilitate varying complexity levels, making them useful for creating pipelines and executing specific scenarios. --- diff --git a/docs/docs/components/custom.mdx b/docs/docs/components/custom.mdx index f8af904b0..2d8ac9d87 100644 --- a/docs/docs/components/custom.mdx +++ b/docs/docs/components/custom.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Custom Components + +This page may contain outdated information. It will be updated as soon as possible. + + Build custom components in Langflow for various data processing and transformation tasks. This guide provides a comprehensive overview of how to create custom components using Langflow. diff --git a/docs/docs/components/data.mdx b/docs/docs/components/data.mdx index d7f525d7d..2c62b2664 100644 --- a/docs/docs/components/data.mdx +++ b/docs/docs/components/data.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Data + +This page may contain outdated information. It will be updated as soon as possible. + + ## API Request This component sends HTTP requests to the specified URLs. diff --git a/docs/docs/components/embeddings.mdx b/docs/docs/components/embeddings.mdx index 24743ec1c..9a224b048 100644 --- a/docs/docs/components/embeddings.mdx +++ b/docs/docs/components/embeddings.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Embeddings + +This page may contain outdated information. It will be updated as soon as possible. + + ## Amazon Bedrock Embeddings Used to load embedding models from [Amazon Bedrock](https://aws.amazon.com/bedrock/). diff --git a/docs/docs/components/experimental.mdx b/docs/docs/components/experimental.mdx index a6f35d024..5abee146d 100644 --- a/docs/docs/components/experimental.mdx +++ b/docs/docs/components/experimental.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Experimental + +This page may contain outdated information. It will be updated as soon as possible. + + Components in the experimental phase are currently in beta. They have been initially developed and tested but haven't yet achieved a stable or fully supported status. We encourage users to explore these components, provide feedback, and report any issues encountered. --- diff --git a/docs/docs/components/helpers.mdx b/docs/docs/components/helpers.mdx index 59fb63564..c30315a42 100644 --- a/docs/docs/components/helpers.mdx +++ b/docs/docs/components/helpers.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Helpers + +This page may contain outdated information. It will be updated as soon as possible. + + ### Chat memory This component retrieves stored chat messages based on a specific session ID. diff --git a/docs/docs/components/inputs-and-outputs.mdx b/docs/docs/components/inputs-and-outputs.mdx index f5592e7fd..8b78d8567 100644 --- a/docs/docs/components/inputs-and-outputs.mdx +++ b/docs/docs/components/inputs-and-outputs.mdx @@ -4,6 +4,10 @@ import useBaseUrl from "@docusaurus/useBaseUrl"; # Inputs and Outputs + +This page may contain outdated information. It will be updated as soon as possible. + + Inputs and Outputs are a category of components that are used to define where data comes in and out of your flow. They also dynamically change the Playground and can be renamed to facilitate building and maintaining your flows. diff --git a/docs/docs/components/loaders.mdx b/docs/docs/components/loaders.mdx index b7f2d11fb..66c0c3a31 100644 --- a/docs/docs/components/loaders.mdx +++ b/docs/docs/components/loaders.mdx @@ -2,6 +2,10 @@ import Admonition from '@theme/Admonition'; # Loaders + +This page may contain outdated information. It will be updated as soon as possible. + +

We appreciate your understanding as we polish our documentation – it may contain some rough edges. Share your feedback or report issues to help us improve! 🛠️📝 diff --git a/docs/docs/components/memories.mdx b/docs/docs/components/memories.mdx index a133c6a6a..3fdf61066 100644 --- a/docs/docs/components/memories.mdx +++ b/docs/docs/components/memories.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Memories + +This page may contain outdated information. It will be updated as soon as possible. + +

Thanks for your patience as we improve our documentation—it might have some diff --git a/docs/docs/components/model_specs.mdx b/docs/docs/components/model_specs.mdx index 21ee1849b..d5835e9d7 100644 --- a/docs/docs/components/model_specs.mdx +++ b/docs/docs/components/model_specs.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Large Language Models (LLMs) + +This page may contain outdated information. It will be updated as soon as possible. + + A Large Language Model (LLM) is a foundational component of Langflow. It provides a uniform interface for interacting with LLMs from various providers, including OpenAI, Cohere, and HuggingFace. Langflow extensively uses LLMs across its chains and agents, employing them to generate text based on specific prompts or inputs. --- diff --git a/docs/docs/components/models.mdx b/docs/docs/components/models.mdx index f02c1654b..4d739b59e 100644 --- a/docs/docs/components/models.mdx +++ b/docs/docs/components/models.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Models + +This page may contain outdated information. It will be updated as soon as possible. + + ## Amazon Bedrock This component facilitates the generation of text using the LLM (Large Language Model) model from Amazon Bedrock. diff --git a/docs/docs/components/retrievers.mdx b/docs/docs/components/retrievers.mdx index 792b9e20b..e13ed2d89 100644 --- a/docs/docs/components/retrievers.mdx +++ b/docs/docs/components/retrievers.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Retrievers + +This page may contain outdated information. It will be updated as soon as possible. + + A retriever is an interface that returns documents in response to an unstructured query. It's broader than a vector store because it doesn't need to store documents; it only needs to retrieve them. --- diff --git a/docs/docs/components/text-and-record.mdx b/docs/docs/components/text-and-record.mdx index e1ece5069..ab3f9302f 100644 --- a/docs/docs/components/text-and-record.mdx +++ b/docs/docs/components/text-and-record.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Text and Data + +This page may contain outdated information. It will be updated as soon as possible. + + There are two main input and output types: `Text` and `Data`. `Text` is a simple string input and output type, while `Data` is a structure very similar to a dictionary in Python. It is a key-value pair data structure. diff --git a/docs/docs/components/text-splitters.mdx b/docs/docs/components/text-splitters.mdx index 02e7a311b..b438d9c21 100644 --- a/docs/docs/components/text-splitters.mdx +++ b/docs/docs/components/text-splitters.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Text Splitters + +This page may contain outdated information. It will be updated as soon as possible. + + A text splitter is a tool that divides a document or text into smaller chunks or segments. This helps make large texts more manageable for analysis or processing. --- diff --git a/docs/docs/components/toolkits.mdx b/docs/docs/components/toolkits.mdx index 3ba7ed7c7..f4b2004ba 100644 --- a/docs/docs/components/toolkits.mdx +++ b/docs/docs/components/toolkits.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Toolkits + +This page may contain outdated information. It will be updated as soon as possible. + +

We appreciate your understanding as we polish our documentation - it may diff --git a/docs/docs/components/tools.mdx b/docs/docs/components/tools.mdx index 6460db860..a7daae919 100644 --- a/docs/docs/components/tools.mdx +++ b/docs/docs/components/tools.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Tools + +This page may contain outdated information. It will be updated as soon as possible. + + ## SearchApi SearchApi offers a real-time search engine results API that returns structured JSON data, including answer boxes, knowledge graphs, organic results, and more. diff --git a/docs/docs/components/utilities.mdx b/docs/docs/components/utilities.mdx index 44263f583..e0e95aa78 100644 --- a/docs/docs/components/utilities.mdx +++ b/docs/docs/components/utilities.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Utilities + +This page may contain outdated information. It will be updated as soon as possible. + + Utilities are a set of actions that can be used to perform common tasks in a flow. They are available in the **Utilities** section in the sidebar. --- diff --git a/docs/docs/components/vector-stores.mdx b/docs/docs/components/vector-stores.mdx index 56e4e094a..cf4dc1668 100644 --- a/docs/docs/components/vector-stores.mdx +++ b/docs/docs/components/vector-stores.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Vector Stores + +This page may contain outdated information. It will be updated as soon as possible. + + ### Astra DB The `Astra DB` initializes a vector store using Astra DB from Data. It creates Astra DB-based vector indexes to efficiently store and retrieve documents. diff --git a/docs/docs/contributing/community.md b/docs/docs/contributing/community.mdx similarity index 85% rename from docs/docs/contributing/community.md rename to docs/docs/contributing/community.mdx index 5c95718ec..964abf277 100644 --- a/docs/docs/contributing/community.md +++ b/docs/docs/contributing/community.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Community + +This page may contain outdated information. It will be updated as soon as possible. + + ## 🤖 Join **Langflow** Discord server Join us to ask questions and showcase your projects. diff --git a/docs/docs/contributing/contribute-component.md b/docs/docs/contributing/contribute-component.mdx similarity index 94% rename from docs/docs/contributing/contribute-component.md rename to docs/docs/contributing/contribute-component.mdx index 7f628623b..4ad8072f3 100644 --- a/docs/docs/contributing/contribute-component.md +++ b/docs/docs/contributing/contribute-component.mdx @@ -1,7 +1,12 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; +import Admonition from "@theme/Admonition"; # How to Contribute Components? + +This page may contain outdated information. It will be updated as soon as possible. + + New components are added as objects of the [CustomComponent](https://github.com/langflow-ai/langflow/blob/dev/src/backend/base/langflow/interface/custom/custom_component/custom_component.py) class and any dependencies are added to the [pyproject.toml](https://github.com/langflow-ai/langflow/blob/dev/pyproject.toml#L27) file. ## Add an example component diff --git a/docs/docs/contributing/github-issues.md b/docs/docs/contributing/github-issues.mdx similarity index 88% rename from docs/docs/contributing/github-issues.md rename to docs/docs/contributing/github-issues.mdx index 269c976cd..84d049849 100644 --- a/docs/docs/contributing/github-issues.md +++ b/docs/docs/contributing/github-issues.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # GitHub Issues + +This page may contain outdated information. It will be updated as soon as possible. + + Our [issues](https://github.com/langflow-ai/langflow/issues) page 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. diff --git a/docs/docs/contributing/how-contribute.md b/docs/docs/contributing/how-contribute.mdx similarity index 92% rename from docs/docs/contributing/how-contribute.md rename to docs/docs/contributing/how-contribute.mdx index ff0df55a6..6776be0b1 100644 --- a/docs/docs/contributing/how-contribute.md +++ b/docs/docs/contributing/how-contribute.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # How to Contribute? + +This page may contain outdated information. It will be updated as soon as possible. + + 👋 Hello there! We welcome contributions from developers of all levels to our open-source project on [GitHub](https://github.com/langflow-ai/langflow). If you'd like to contribute, please check our contributing guidelines and help make Langflow more accessible. As an open-source project in a rapidly developing field, we are extremely open diff --git a/docs/docs/deployment/backend-only.md b/docs/docs/deployment/backend-only.mdx similarity index 96% rename from docs/docs/deployment/backend-only.md rename to docs/docs/deployment/backend-only.mdx index 4122373f3..1fc16de2f 100644 --- a/docs/docs/deployment/backend-only.md +++ b/docs/docs/deployment/backend-only.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Backend-only + +This page may contain outdated information. It will be updated as soon as possible. + + You can run Langflow in `--backend-only` mode to expose your Langflow app as an API, without running the frontend UI. Start langflow in backend-only mode with `python3 -m langflow run --backend-only`. diff --git a/docs/docs/deployment/docker.md b/docs/docs/deployment/docker.mdx similarity index 90% rename from docs/docs/deployment/docker.md rename to docs/docs/deployment/docker.mdx index a8864db55..e734d6210 100644 --- a/docs/docs/deployment/docker.md +++ b/docs/docs/deployment/docker.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Docker + +This page may contain outdated information. It will be updated as soon as possible. + + This guide will help you get LangFlow up and running using Docker and Docker Compose. ## Prerequisites diff --git a/docs/docs/deployment/gcp-deployment.md b/docs/docs/deployment/gcp-deployment.mdx similarity index 93% rename from docs/docs/deployment/gcp-deployment.md rename to docs/docs/deployment/gcp-deployment.mdx index e126e785c..e2abace6b 100644 --- a/docs/docs/deployment/gcp-deployment.md +++ b/docs/docs/deployment/gcp-deployment.mdx @@ -1,5 +1,11 @@ +import Admonition from "@theme/Admonition"; + # Deploy on Google Cloud Platform + +This page may contain outdated information. It will be updated as soon as possible. + + ## Run Langflow from a New Google Cloud Project This guide will help you set up a Langflow development VM in a Google Cloud Platform project using Google Cloud Shell. diff --git a/docs/docs/examples/chat-memory.mdx b/docs/docs/examples/chat-memory.mdx index 174711ce8..4fa2775aa 100644 --- a/docs/docs/examples/chat-memory.mdx +++ b/docs/docs/examples/chat-memory.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Chat Memory + +This page may contain outdated information. It will be updated as soon as possible. + + The **Chat Memory** component restores previous messages given a Session ID, which can be any string. This component is available under the **Helpers** tab of the Langflow sidebar. diff --git a/docs/docs/examples/combine-text.mdx b/docs/docs/examples/combine-text.mdx index 6fb46555f..10c2e8900 100644 --- a/docs/docs/examples/combine-text.mdx +++ b/docs/docs/examples/combine-text.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Combine Text + +This page may contain outdated information. It will be updated as soon as possible. + + With LLM pipelines, combining text from different sources may be as important as splitting text. The **Combine Text** component concatenates two text inputs into a single chunk using a specified delimiter, such as whitespace or a newline. diff --git a/docs/docs/examples/create-record.mdx b/docs/docs/examples/create-record.mdx index 7858ca783..9e681699c 100644 --- a/docs/docs/examples/create-record.mdx +++ b/docs/docs/examples/create-record.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Create Data + +This page may contain outdated information. It will be updated as soon as possible. + + In Langflow, a `Data` has a structure very similar to a Python dictionary. It is a key-value pair data structure. The **Create Data** component allows you to dynamically create a `Data` from a specified number of inputs. You can add as many key-value pairs as you want (as long as it is less than 15 😅). Once you've chosen the number of `Data`, add keys and fill up values, or pass on values from other components to the component using the input handles. diff --git a/docs/docs/examples/pass.mdx b/docs/docs/examples/pass.mdx index ddfe35cca..5f75adac1 100644 --- a/docs/docs/examples/pass.mdx +++ b/docs/docs/examples/pass.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Pass + +This page may contain outdated information. It will be updated as soon as possible. + + Sometimes all you need to do is… nothing! The **Pass** component enables you to ignore one input and move forward with another one. This is super helpful to swap routes for A/B testing! diff --git a/docs/docs/examples/store-message.mdx b/docs/docs/examples/store-message.mdx index 75ff0bd46..df2cb3c39 100644 --- a/docs/docs/examples/store-message.mdx +++ b/docs/docs/examples/store-message.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Store Message + +This page may contain outdated information. It will be updated as soon as possible. + + The **Store Message** component allows you to save information under a specified Session ID and sender type. The **Message History** component can then be used to retrieve stored messages. diff --git a/docs/docs/examples/sub-flow.mdx b/docs/docs/examples/sub-flow.mdx index d2b9674ad..31cc7448e 100644 --- a/docs/docs/examples/sub-flow.mdx +++ b/docs/docs/examples/sub-flow.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Sub Flow + +This page may contain outdated information. It will be updated as soon as possible. + + The **Sub Flow** component enables a user to select a previously built flow and dynamically generate a component out of it.

+This page may contain outdated information. It will be updated as soon as possible. + + The **Text Operator** component simplifies logic. It evaluates the results from another component (for example, if the input text exactly equals `Tuna`) and runs another component based on the results. Basically, the text operator is an if/else component for your flow.
+This page may contain outdated information. It will be updated as soon as possible. + + Langflow **requires** Python version 3.10 or greater and [pip](https://pypi.org/project/pip/) or diff --git a/docs/docs/getting-started/quickstart.mdx b/docs/docs/getting-started/quickstart.mdx index 7d4f15573..e6151c1eb 100644 --- a/docs/docs/getting-started/quickstart.mdx +++ b/docs/docs/getting-started/quickstart.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # ⚡️ Quickstart + +This page may contain outdated information. It will be updated as soon as possible. + + This guide demonstrates how to build a basic flow and modify the prompt for different outcomes. ## Prerequisites diff --git a/docs/docs/getting-started/rag-with-astradb.mdx b/docs/docs/getting-started/rag-with-astradb.mdx index c719d8d94..015f50f3d 100644 --- a/docs/docs/getting-started/rag-with-astradb.mdx +++ b/docs/docs/getting-started/rag-with-astradb.mdx @@ -5,6 +5,10 @@ import Admonition from "@theme/Admonition"; # 🌟 RAG with Astra DB + +This page may contain outdated information. It will be updated as soon as possible. + + This guide will walk you through how to build a RAG (Retrieval Augmented Generation) application using **Astra DB** and **Langflow**. [Astra DB](https://www.datastax.com/products/datastax-astra?utm_source=langflow-pre-release&utm_medium=referral&utm_campaign=langflow-announcement&utm_content=astradb) is a cloud-native database built on Apache Cassandra that is optimized for the cloud. It is a fully managed database-as-a-service that simplifies operations and reduces costs. Astra DB is built on the same technology that powers the largest Cassandra deployments in the world. diff --git a/docs/docs/getting-started/workspace.mdx b/docs/docs/getting-started/workspace.mdx index 374faca74..e6951a5e1 100644 --- a/docs/docs/getting-started/workspace.mdx +++ b/docs/docs/getting-started/workspace.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # 🎨 Langflow Workspace + +This page may contain outdated information. It will be updated as soon as possible. + + ## The Langflow Workspace Interface 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. diff --git a/docs/docs/integrations/langsmith/intro.mdx b/docs/docs/integrations/langsmith/intro.mdx index 68f28a891..02f474e67 100644 --- a/docs/docs/integrations/langsmith/intro.mdx +++ b/docs/docs/integrations/langsmith/intro.mdx @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # LangSmith + +This page may contain outdated information. It will be updated as soon as possible. + + 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! ## Step-by-step Configuration diff --git a/docs/docs/integrations/notion/add-content-to-page.md b/docs/docs/integrations/notion/add-content-to-page.md index ace43e103..197046922 100644 --- a/docs/docs/integrations/notion/add-content-to-page.md +++ b/docs/docs/integrations/notion/add-content-to-page.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Add Content To Page + +This page may contain outdated information. It will be updated as soon as possible. + + The `AddContentToPage` component converts markdown text to Notion blocks and appends them to a Notion page. [Notion Reference](https://developers.notion.com/reference/patch-block-children) diff --git a/docs/docs/integrations/notion/intro.md b/docs/docs/integrations/notion/intro.md index 293038d4f..77f09e5b6 100644 --- a/docs/docs/integrations/notion/intro.md +++ b/docs/docs/integrations/notion/intro.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Introduction to Notion in Langflow + +This page may contain outdated information. It will be updated as soon as possible. + + The Notion integration in Langflow enables seamless connectivity with Notion databases, pages, and users, facilitating automation and improving productivity. +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionDatabaseProperties` component retrieves properties of a Notion database. It provides a convenient way to integrate Notion database information into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/post-database-query) diff --git a/docs/docs/integrations/notion/list-pages.md b/docs/docs/integrations/notion/list-pages.md index e1f6603b3..a232a594f 100644 --- a/docs/docs/integrations/notion/list-pages.md +++ b/docs/docs/integrations/notion/list-pages.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # List Pages + +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionListPages` component queries a Notion database with filtering and sorting. It provides a convenient way to integrate Notion database querying capabilities into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/post-database-query) diff --git a/docs/docs/integrations/notion/list-users.md b/docs/docs/integrations/notion/list-users.md index 17352c0c2..c3cd6696b 100644 --- a/docs/docs/integrations/notion/list-users.md +++ b/docs/docs/integrations/notion/list-users.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # User List + +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionUserList` component retrieves users from Notion. It provides a convenient way to integrate Notion user data into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/get-users) diff --git a/docs/docs/integrations/notion/page-content-viewer.md b/docs/docs/integrations/notion/page-content-viewer.md index 070d71800..df3ebdf60 100644 --- a/docs/docs/integrations/notion/page-content-viewer.md +++ b/docs/docs/integrations/notion/page-content-viewer.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Page Content + +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionPageContent` component retrieves the content of a Notion page as plain text. It provides a convenient way to integrate Notion page content into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/get-page) diff --git a/docs/docs/integrations/notion/page-create.md b/docs/docs/integrations/notion/page-create.md index f942f257b..f2e7534d1 100644 --- a/docs/docs/integrations/notion/page-create.md +++ b/docs/docs/integrations/notion/page-create.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Page Create + +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionPageCreator` component creates pages in a Notion database. It provides a convenient way to integrate Notion page creation into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/patch-block-children) diff --git a/docs/docs/integrations/notion/page-update.md b/docs/docs/integrations/notion/page-update.md index ca88f547d..3f9709f0a 100644 --- a/docs/docs/integrations/notion/page-update.md +++ b/docs/docs/integrations/notion/page-update.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Page Update + +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionPageUpdate` component updates the properties of a Notion page. It provides a convenient way to integrate updating Notion page properties into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/patch-page) diff --git a/docs/docs/integrations/notion/search.md b/docs/docs/integrations/notion/search.md index 1e9b8c529..f7092fdb9 100644 --- a/docs/docs/integrations/notion/search.md +++ b/docs/docs/integrations/notion/search.md @@ -5,6 +5,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Notion Search + +This page may contain outdated information. It will be updated as soon as possible. + + The `NotionSearch` component is designed to search all pages and databases that have been shared with an integration in Notion. It provides a convenient way to integrate Notion search capabilities into your Langflow workflows. [Notion Reference](https://developers.notion.com/reference/search) diff --git a/docs/docs/integrations/notion/setup.md b/docs/docs/integrations/notion/setup.md index 72bb8f3b4..4ff81dd30 100644 --- a/docs/docs/integrations/notion/setup.md +++ b/docs/docs/integrations/notion/setup.md @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Setting up a Notion App + +This page may contain outdated information. It will be updated as soon as possible. + + 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. ## Prerequisites diff --git a/docs/docs/migration/compatibility.mdx b/docs/docs/migration/compatibility.mdx index 0e18e4900..268214c4b 100644 --- a/docs/docs/migration/compatibility.mdx +++ b/docs/docs/migration/compatibility.mdx @@ -3,6 +3,10 @@ import ZoomableImage from "/src/theme/ZoomableImage.js"; # Compatibility with Previous Versions + +This page may contain outdated information. It will be updated as soon as possible. + + ## TLDR; - You'll need to add a few components to your flow to make it compatible with the new version of Langflow. diff --git a/docs/docs/migration/migrating-to-one-point-zero.mdx b/docs/docs/migration/migrating-to-one-point-zero.mdx index c6afa8ab2..78ae6b608 100644 --- a/docs/docs/migration/migrating-to-one-point-zero.mdx +++ b/docs/docs/migration/migrating-to-one-point-zero.mdx @@ -2,6 +2,10 @@ import Admonition from "@theme/Admonition"; # Migrating to Langflow 1.0: A Guide + +This page may contain outdated information. It will be updated as soon as possible. + + Langflow 1.0 is a significant update that brings many exciting changes and improvements to the platform. This guide will walk you through the key improvements and help you migrate your existing projects to the new version. diff --git a/docs/docs/starter-projects/basic-prompting.mdx b/docs/docs/starter-projects/basic-prompting.mdx index 594990eb6..dc5fc8c0f 100644 --- a/docs/docs/starter-projects/basic-prompting.mdx +++ b/docs/docs/starter-projects/basic-prompting.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Basic Prompting + +This page may contain outdated information. It will be updated as soon as possible. + + Prompts serve as the inputs to a large language model (LLM), acting as the interface between human instructions and computational tasks. By submitting natural language requests in a prompt to an LLM, you can obtain answers, generate text, and solve problems. diff --git a/docs/docs/starter-projects/blog-writer.mdx b/docs/docs/starter-projects/blog-writer.mdx index 75f725d94..1fb1a52d0 100644 --- a/docs/docs/starter-projects/blog-writer.mdx +++ b/docs/docs/starter-projects/blog-writer.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Blog Writer + +This page may contain outdated information. It will be updated as soon as possible. + + Build a blog writer with OpenAI that uses URLs for reference content. ## Prerequisites diff --git a/docs/docs/starter-projects/document-qa.mdx b/docs/docs/starter-projects/document-qa.mdx index 2e452522e..25f5d1234 100644 --- a/docs/docs/starter-projects/document-qa.mdx +++ b/docs/docs/starter-projects/document-qa.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Document QA + +This page may contain outdated information. It will be updated as soon as possible. + + Build a question-and-answer chatbot with a document loaded from local memory. ## Prerequisites diff --git a/docs/docs/starter-projects/memory-chatbot.mdx b/docs/docs/starter-projects/memory-chatbot.mdx index bf5a428ca..a620dd714 100644 --- a/docs/docs/starter-projects/memory-chatbot.mdx +++ b/docs/docs/starter-projects/memory-chatbot.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Memory Chatbot + +This page may contain outdated information. It will be updated as soon as possible. + + This flow extends the [basic prompting flow](./basic-prompting) to include chat memory for unique SessionIDs. ## Prerequisites diff --git a/docs/docs/starter-projects/vector-store-rag.mdx b/docs/docs/starter-projects/vector-store-rag.mdx index 4354295d8..6fb514d9a 100644 --- a/docs/docs/starter-projects/vector-store-rag.mdx +++ b/docs/docs/starter-projects/vector-store-rag.mdx @@ -6,6 +6,10 @@ import Admonition from "@theme/Admonition"; # Vector Store RAG + +This page may contain outdated information. It will be updated as soon as possible. + + Retrieval Augmented Generation, or RAG, is a pattern for training LLMs on your data and querying it. RAG is backed by a **vector store**, a vector database which stores embeddings of the ingested data. diff --git a/docs/docs/tutorials/chatprompttemplate_guide.mdx b/docs/docs/tutorials/chatprompttemplate_guide.mdx index e19f95f4a..9fd6ca1ea 100644 --- a/docs/docs/tutorials/chatprompttemplate_guide.mdx +++ b/docs/docs/tutorials/chatprompttemplate_guide.mdx @@ -2,9 +2,14 @@ import ThemedImage from "@theme/ThemedImage"; import useBaseUrl from "@docusaurus/useBaseUrl"; import ZoomableImage from "/src/theme/ZoomableImage.js"; import ReactPlayer from "react-player"; +import Admonition from "@theme/Admonition"; # Build Chatbots with the System Message Component + +This page may contain outdated information. It will be updated as soon as possible. + + ## Overview In this guide, we will modify the "Basic Chat with Prompt and History" example, integrating the ChatPromptTemplate with the SystemMessagePromptTemplate and HumanMessagePromptTemplate components. By following these steps, you'll be able to build a personalized chatbot that can interpret and respond based on user-defined System messages. diff --git a/docs/docs/tutorials/custom_components.mdx b/docs/docs/tutorials/custom_components.mdx index 127337937..6996bea72 100644 --- a/docs/docs/tutorials/custom_components.mdx +++ b/docs/docs/tutorials/custom_components.mdx @@ -8,6 +8,10 @@ import Admonition from "@theme/Admonition"; # Custom Components + +This page may contain outdated information. It will be updated as soon as possible. + + In Langflow, a Custom Component is a special component type that allows users to extend the platform's functionality by creating their own reusable and configurable components. A Custom Component is created from a user-defined Python script that uses the _`CustomComponent`_ class provided by the Langflow library. These components can be as simple as a basic function that takes and returns a string or as complex as a combination of multiple sub-components and API calls. diff --git a/docs/docs/tutorials/loading_document.mdx b/docs/docs/tutorials/loading_document.mdx index 3b1eca436..592332eee 100644 --- a/docs/docs/tutorials/loading_document.mdx +++ b/docs/docs/tutorials/loading_document.mdx @@ -2,9 +2,14 @@ import ThemedImage from "@theme/ThemedImage"; import useBaseUrl from "@docusaurus/useBaseUrl"; import ZoomableImage from "/src/theme/ZoomableImage.js"; import ReactPlayer from "react-player"; +import Admonition from "@theme/Admonition"; # Integrate Documents with Prompt Variables + +This page may contain outdated information. It will be updated as soon as possible. + + ## Overview This guide takes you through the process of augmenting the "Basic Chat with Prompt and History" example. You'll learn how to embed documents as context into the PromptTemplate component utilizing a WebBaseLoader. diff --git a/docs/docs/tutorials/rag-with-astradb.mdx b/docs/docs/tutorials/rag-with-astradb.mdx index e3f4a3f1e..0aa0dafe8 100644 --- a/docs/docs/tutorials/rag-with-astradb.mdx +++ b/docs/docs/tutorials/rag-with-astradb.mdx @@ -5,6 +5,10 @@ import Admonition from "@theme/Admonition"; # 🌟 RAG with Astra DB + +This page may contain outdated information. It will be updated as soon as possible. + + This guide will walk you through how to build a RAG (Retrieval Augmented Generation) application using **Astra DB** and **Langflow**. [Astra DB](https://www.datastax.com/products/datastax-astra?utm_source=langflow-pre-release&utm_medium=referral&utm_campaign=langflow-announcement&utm_content=astradb) is a cloud-native database built on Apache Cassandra that is optimized for the cloud. It is a fully managed database-as-a-service that simplifies operations and reduces costs. Astra DB is built on the same technology that powers the largest Cassandra deployments in the world.