From 37867ee5f23058d94505c412d85fa7f7a27555e9 Mon Sep 17 00:00:00 2001 From: Mendon Kissling <59585235+mendonk@users.noreply.github.com> Date: Fri, 7 Jun 2024 13:44:50 -0400 Subject: [PATCH] cleanup-images-and-some-text --- docs/docs/administration/chat-widget.mdx | 6 +- docs/docs/administration/login.mdx | 11 ++-- docs/docs/administration/playground.mdx | 2 +- docs/docs/components/agents.mdx | 6 -- docs/docs/components/chains.mdx | 14 +---- docs/docs/components/custom.mdx | 2 +- docs/docs/components/experimental.mdx | 24 ++++---- docs/docs/components/inputs-and-outputs.mdx | 56 +++++++++---------- docs/docs/components/model_specs.mdx | 22 +++----- docs/docs/components/models.mdx | 22 ++++---- docs/docs/components/retrievers.mdx | 8 +-- docs/docs/components/text-splitters.mdx | 14 +---- docs/docs/components/tools.mdx | 36 +++++------- docs/docs/components/utilities.mdx | 14 ++--- docs/docs/getting-started/canvas.mdx | 19 ++----- .../docs/getting-started/install-langflow.mdx | 2 +- docs/docs/starter-projects/document-qa.mdx | 2 +- 17 files changed, 103 insertions(+), 157 deletions(-) diff --git a/docs/docs/administration/chat-widget.mdx b/docs/docs/administration/chat-widget.mdx index 6d47e123b..b2a97d30e 100644 --- a/docs/docs/administration/chat-widget.mdx +++ b/docs/docs/administration/chat-widget.mdx @@ -184,8 +184,9 @@ Use the widget API to customize your Chat Widget: format {"key":"value"}. + | Prop | Type | Required | Description | -| --------------------- | ------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +|-----------------------|---------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------| | bot_message_style | JSON | No | Applies custom formatting to bot messages. | | chat_input_field | String | Yes | Defines the type of the input field for chat messages. | | chat_inputs | JSON | Yes | Determines the chat input elements and their respective values. | @@ -208,4 +209,5 @@ Use the widget API to customize your Chat Widget: | tweaks | JSON | No | Applies additional custom adjustments for the associated flow. | | user_message_style | JSON | No | Determines the formatting for user messages in the chat window. | | width | Number | No | Sets the width of the chat window in pixels. | -| window_title | String | No | Sets the title displayed in the chat window's header or title bar. | import ThemedImage from "@theme/ThemedImage"; | +| window_title | String | No | Sets the title displayed in the chat window's header or title bar. | + diff --git a/docs/docs/administration/login.mdx b/docs/docs/administration/login.mdx index d5d7c1989..f89f3a5ee 100644 --- a/docs/docs/administration/login.mdx +++ b/docs/docs/administration/login.mdx @@ -88,12 +88,12 @@ With _`LANGFLOW_AUTO_LOGIN`_ set to _`False`_, Langflow requires users to sign u light: useBaseUrl("img/sign-up.png"), dark: useBaseUrl("img/sign-up.png"), }} - style={{ width: "50%", maxWidth: "600px", margin: "0 auto" }} + style={{ width: "40%", margin: "20px auto" }} /> ## Profile settings -Users can change their profile settings by clicking on the profile icon in the top right corner of the application. This opens a dropdown menu with the following options: +You can change your profile settings by clicking on the profile icon in the top right corner of the Langflow dashboard. This opens a dropdown menu with the following options: - **Admin Page**: Opens the admin page, which is only accessible to the superuser. - **Profile Settings**: Opens the profile settings page. @@ -105,10 +105,10 @@ Users can change their profile settings by clicking on the profile icon in the t light: useBaseUrl("img/my-account.png"), dark: useBaseUrl("img/my-account.png"), }} - style={{ width: "50%", maxWidth: "600px", margin: "20px auto" }} + style={{ maxWidth: "600px", margin: "20px auto" }} /> -By clicking on **Profile Settings**, the user is taken to the profile settings page, where they can change their password and their profile picture. +Select **Profile Settings** to change your password and your profile picture. -By clicking on **Admin Page**, the superuser is taken to the admin page, where they -can manage users and groups. +Select **Admin Page** to manage users and groups as the superuser. 2. Chat with your bot as you normally would, all without having to open the editor. diff --git a/docs/docs/components/agents.mdx b/docs/docs/components/agents.mdx index f8917e4e2..51ada9f2f 100644 --- a/docs/docs/components/agents.mdx +++ b/docs/docs/components/agents.mdx @@ -2,12 +2,6 @@ import Admonition from '@theme/Admonition'; # Agents - -

- 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! ๐Ÿ› ๏ธ๐Ÿ“ -

- - 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 fd3b5bd5d..a57f442e3 100644 --- a/docs/docs/components/chains.mdx +++ b/docs/docs/components/chains.mdx @@ -5,19 +5,11 @@ import Admonition from "@theme/Admonition"; # Chains - -

- Thank you for your patience while we enhance our documentation. It may - have some imperfections. Share your feedback or report issues to help us - improve! ๐Ÿ› ๏ธ๐Ÿ“ -

- - 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. --- -### CombineDocsChain +## CombineDocsChain `CombineDocsChain` includes methods to combine or aggregate loaded documents for question-answering functionality. @@ -34,7 +26,7 @@ Acts as a proxy for LangChainโ€™s [documents](https://python.langchain.com/docs/ --- -### ConversationChain +## ConversationChain `ConversationChain` facilitates dynamic, interactive conversations with a language model, ideal for chatbots or virtual assistants. @@ -48,7 +40,7 @@ Acts as a proxy for LangChainโ€™s [documents](https://python.langchain.com/docs/ --- -### ConversationalRetrievalChain +## ConversationalRetrievalChain `ConversationalRetrievalChain` combines document search with question-answering capabilities, extracting information and providing answers. diff --git a/docs/docs/components/custom.mdx b/docs/docs/components/custom.mdx index 1c039bd2a..e17b9db8d 100644 --- a/docs/docs/components/custom.mdx +++ b/docs/docs/components/custom.mdx @@ -3,7 +3,7 @@ import Admonition from "@theme/Admonition"; # Custom Components - Read the [Custom Component Guidelines](../administration/custom-component) for + Read the [Custom Component Tutorial](../tutorials/custom_components) for detailed information on custom components. diff --git a/docs/docs/components/experimental.mdx b/docs/docs/components/experimental.mdx index 8e503da06..5902b849e 100644 --- a/docs/docs/components/experimental.mdx +++ b/docs/docs/components/experimental.mdx @@ -4,7 +4,9 @@ import Admonition from '@theme/Admonition'; 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. -### Clear Message History Component +--- + +## Clear Message History Component This component clears the message history for a specified session ID. @@ -22,7 +24,7 @@ Provide the session ID to clear its message history. --- -### Extract Key From Record +## Extract Key From Record This component extracts specified keys from a record. @@ -47,7 +49,7 @@ Provide the record and specify the keys you want to extract. Optionally, enable --- -### Flow as Tool +## Flow as Tool This component turns a function running a flow into a Tool. @@ -79,7 +81,7 @@ Select a flow, name and describe the tool, and decide if you want to return the --- -### Listen +## Listen This component listens for a specified notification. @@ -95,7 +97,7 @@ Specify the notification to listen for. --- -### List Flows +## List Flows This component lists all available flows. @@ -105,7 +107,7 @@ Call this component without parameters to list all flows. --- -### Merge Records +## Merge Records This component merges a list of records. @@ -120,7 +122,7 @@ Provide the records you want to merge. --- -### Notify +## Notify This component generates a notification. @@ -144,7 +146,7 @@ Specify the notification name, provide a record if necessary, and indicate wheth --- -### Run Flow +## Run Flow This component runs a specified flow. @@ -170,7 +172,7 @@ Provide the input value, select the flow, and apply any tweaks. --- -### Runnable Executor +## Runnable Executor This component executes a specified runnable. @@ -198,7 +200,7 @@ Specify the input key, provide inputs, select the runnable, and optionally defin --- -### SQL Executor +## SQL Executor This component executes an SQL query. @@ -226,7 +228,7 @@ Provide the SQL query, specify the database URL, and configure settings for colu --- -### SubFlow +## SubFlow This component dynamically generates a tool from a flow. diff --git a/docs/docs/components/inputs-and-outputs.mdx b/docs/docs/components/inputs-and-outputs.mdx index 2a624221a..a923d1f55 100644 --- a/docs/docs/components/inputs-and-outputs.mdx +++ b/docs/docs/components/inputs-and-outputs.mdx @@ -20,6 +20,15 @@ You can find out more about Chat Input and other Inputs [here](#chat-input). This component collects user input from the chat. + + **Parameters** - **Sender Type:** Specifies the sender type. Defaults to `User`. Options are `Machine` and `User`. @@ -34,30 +43,30 @@ This component collects user input from the chat.

- - One significant capability of the Chat Input component is its ability to transform the Playground into a chat window. This feature is particularly valuable for scenarios requiring user input to initiate or influence the flow. ### Text Input The **Text Input** component adds an **Input** field on the Playground. This enables you to define parameters while running and testing your flow. + + **Parameters** - **Value:** Specifies the text input value. This is where the user inputs text data that will be passed to the next component in the sequence. If no value is provided, it defaults to an empty string. @@ -79,15 +88,6 @@ A template with `Name: {name}, Age: {age}` will convert the `Record` into a text If you pass more than one `Record`, the text will be concatenated with a new line separator. - - ## Outputs Outputs are components that are used to define where data comes out of your flow. They can be used to send data to the user, to the Playground, or to define how the data will be displayed in the Playground. @@ -135,10 +135,6 @@ A prompt is the input provided to a language model, consisting of multiple compo This component creates a prompt template with dynamic variables. This is useful for structuring prompts and passing dynamic data to a language model. -**Parameters** - -- **Template:** The template for the prompt. This field allows you to create other fields dynamically by using curly brackets `{}`. For example, if you have a template like `Hello {name}, how are you?`, a new field called `name` will be created. Prompt variables can be created with any name inside curly brackets, e.g. `{variable_name}`. - +**Parameters** + +- **Template:** The template for the prompt. This field allows you to create other fields dynamically by using curly brackets `{}`. For example, if you have a template like `Hello {name}, how are you?`, a new field called `name` will be created. Prompt variables can be created with any name inside curly brackets, e.g. `{variable_name}`. + ### PromptTemplate The `PromptTemplate` component enables users to create prompts and define variables that control how the model is instructed. Users can input a set of variables which the template uses to generate the prompt when a conversation starts. - - After defining a variable in the prompt template, it acts as its own component - input. See [Prompt Customization](../administration/prompt-customization) for - more details. - +After defining a variable in the prompt template, it acts as its own component input. See [Prompt Customization](../administration/prompt-customization) for more details. - **template:** The template used to format an individual request. diff --git a/docs/docs/components/model_specs.mdx b/docs/docs/components/model_specs.mdx index 3ed3d60ca..ad45edf45 100644 --- a/docs/docs/components/model_specs.mdx +++ b/docs/docs/components/model_specs.mdx @@ -2,17 +2,11 @@ import Admonition from '@theme/Admonition'; # Large Language Models (LLMs) - -

- Thank you for your patience as we refine our documentation. You might encounter some inconsistencies. Please help us improve by sharing your feedback or reporting any issues! ๐Ÿ› ๏ธ๐Ÿ“ -

- - 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. --- -### Anthropic +## Anthropic This is a wrapper for Anthropic's large language models. Learn more at [Anthropic](https://www.anthropic.com). @@ -22,7 +16,7 @@ This is a wrapper for Anthropic's large language models. Learn more at [Anthropi --- -### ChatAnthropic +## ChatAnthropic This is a wrapper for Anthropic's large language model designed for chat-based interactions. Learn more at [Anthropic](https://www.anthropic.com). @@ -32,7 +26,7 @@ This is a wrapper for Anthropic's large language model designed for chat-based i --- -### CTransformers +## CTransformers `CTransformers` provides access to Transformer models implemented in C/C++ using the [GGML](https://github.com/ggerganov/ggml) library. @@ -65,7 +59,7 @@ Ensure the `ctransformers` Python package is installed. Discover more about inst - **model_file**: The specific model file name within the repository or directory. - **model_type**: The type of transformer model used. For further information, visit [ctransformers](https://github.com/marella/ctransformers). -### ChatOpenAI Component +## ChatOpenAI Component This component interfaces with [OpenAI's](https://openai.com) large language models, supporting a variety of tasks such as chatbots, generative question-answering, and summarization. @@ -76,7 +70,7 @@ This component interfaces with [OpenAI's](https://openai.com) large language mod - **openai_api_key**: The API key required for authentication with the OpenAI API. - **temperature**: Adjusts the randomness level of the text generation. This should be a non-negative number, defaulting to `0.7`. -### Cohere Component +## Cohere Component A wrapper for accessing [Cohere's](https://cohere.com) large language models. @@ -84,7 +78,7 @@ A wrapper for accessing [Cohere's](https://cohere.com) large language models. - **max_tokens**: The limit on the number of tokens to generate per request, defaulting to `256`. - **temperature**: Adjusts the randomness level in text generations. This should be a non-negative number, defaulting to `0.75`. -### HuggingFaceHub Component +## HuggingFaceHub Component A component facilitating access to models hosted on the [HuggingFace Hub](https://www.huggingface.co/models). @@ -93,7 +87,7 @@ A component facilitating access to models hosted on the [HuggingFace Hub](https: - **repo_id**: Specifies the model repository, defaulting to `gpt2`. - **task**: The specific task to execute with the model, returning either `generated_text` or `summary_text`. -### LlamaCpp Component +## LlamaCpp Component This component provides access to `llama.cpp` models, ensuring high performance and flexibility. @@ -122,7 +116,7 @@ This component provides access to `llama.cpp` models, ensuring high performance - **verbose**: Controls the verbosity of output details. When enabled, it provides insights into internal states to aid debugging and understanding, defaulting to `False`. - **vocab_only**: Loads only the vocabulary without model weights, defaulting to `False`. -### VertexAI Component +## VertexAI Component This component integrates with [Google Vertex AI](https://cloud.google.com/vertex-ai) large language models to enhance AI capabilities. diff --git a/docs/docs/components/models.mdx b/docs/docs/components/models.mdx index fc6d7924e..f02c1654b 100644 --- a/docs/docs/components/models.mdx +++ b/docs/docs/components/models.mdx @@ -2,7 +2,7 @@ import Admonition from "@theme/Admonition"; # Models -### Amazon Bedrock +## Amazon Bedrock This component facilitates the generation of text using the LLM (Large Language Model) model from Amazon Bedrock. @@ -48,7 +48,7 @@ This component facilitates the generation of text using the LLM (Large Language --- -### Anthropic +## Anthropic This component allows the generation of text using Anthropic Chat&Completion large language models. @@ -79,7 +79,7 @@ For detailed documentation and integration guides, please refer to the [Anthropi --- -### Azure OpenAI +## Azure OpenAI This component allows the generation of text using the LLM (Large Language Model) model from Azure OpenAI. @@ -124,7 +124,7 @@ For detailed documentation and integration guides, please refer to the [Azure Op --- -### Cohere +## Cohere This component enables text generation using Cohere large language models. @@ -144,7 +144,7 @@ This component enables text generation using Cohere large language models. --- -### Google Generative AI +## Google Generative AI This component enables text generation using Google Generative AI. @@ -172,7 +172,7 @@ This component enables text generation using Google Generative AI. --- -### Hugging Face API +## Hugging Face API This component facilitates text generation using LLM models from the Hugging Face Inference API. @@ -194,7 +194,7 @@ This component facilitates text generation using LLM models from the Hugging Fac --- -### LiteLLM Model +## LiteLLM Model Generates text using the `LiteLLM` collection of large language models. @@ -217,7 +217,7 @@ Generates text using the `LiteLLM` collection of large language models. --- -### Ollama +## Ollama Generate text using Ollama Local LLMs. @@ -252,7 +252,7 @@ Generate text using Ollama Local LLMs. --- -### OpenAI +## OpenAI This component facilitates text generation using OpenAI's models. @@ -278,7 +278,7 @@ This component facilitates text generation using OpenAI's models. --- -### Qianfan +## Qianfan This component facilitates the generation of text using Baidu Qianfan chat models. @@ -317,7 +317,7 @@ This component facilitates the generation of text using Baidu Qianfan chat model --- -### Vertex AI +## Vertex AI The `ChatVertexAI` is a component for generating text using Vertex AI Chat large language models API. diff --git a/docs/docs/components/retrievers.mdx b/docs/docs/components/retrievers.mdx index 825842df7..baf8d6813 100644 --- a/docs/docs/components/retrievers.mdx +++ b/docs/docs/components/retrievers.mdx @@ -2,17 +2,11 @@ import Admonition from '@theme/Admonition'; # Retrievers - -

- We appreciate your patience as we enhance our documentation. It may have some imperfections. Please share your feedback or report issues to help us improve. ๐Ÿ› ๏ธ๐Ÿ“ -

- - 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. --- -### MultiQueryRetriever +## MultiQueryRetriever The `MultiQueryRetriever` automates generating multiple queries, retrieves relevant documents for each query, and aggregates the results. This method improves retrieval effectiveness and addresses the limitations of traditional distance-based methods. diff --git a/docs/docs/components/text-splitters.mdx b/docs/docs/components/text-splitters.mdx index 6e3925ee2..02e7a311b 100644 --- a/docs/docs/components/text-splitters.mdx +++ b/docs/docs/components/text-splitters.mdx @@ -2,19 +2,11 @@ import Admonition from "@theme/Admonition"; # Text Splitters - -

- Thank you for your patience as we enhance our documentation. It might - currently have some rough edges. Please share your feedback or report any - issues to assist us in improving! ๐Ÿ› ๏ธ๐Ÿ“ -

- - 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. --- -### CharacterTextSplitter +## CharacterTextSplitter The `CharacterTextSplitter` splits a long text into smaller chunks based on a specified character. It aims to keep paragraphs, sentences, and words intact as much as possible since these are semantically related elements of text. @@ -27,7 +19,7 @@ The `CharacterTextSplitter` splits a long text into smaller chunks based on a sp --- -### RecursiveCharacterTextSplitter +## RecursiveCharacterTextSplitter The `RecursiveCharacterTextSplitter` functions similarly to the `CharacterTextSplitter` by trying to keep paragraphs, sentences, and words together. It also recursively splits the text into smaller chunks if the initial chunk size exceeds a specified threshold. @@ -38,7 +30,7 @@ The `RecursiveCharacterTextSplitter` functions similarly to the `CharacterTextSp - **chunk_size:** The maximum number of characters in each chunk. - **separators:** A list of characters used to split the text into chunks. The splitter first tries to split text using the first character in the `separators` list. If any chunk exceeds the maximum size, it proceeds to the next character in the list and continues splitting. The defaults are ["\n\n", "\n", " ", ""]. -### LanguageRecursiveTextSplitter +## LanguageRecursiveTextSplitter The `LanguageRecursiveTextSplitter` divides text into smaller chunks based on the programming language of the text. diff --git a/docs/docs/components/tools.mdx b/docs/docs/components/tools.mdx index 940c304eb..251d3b016 100644 --- a/docs/docs/components/tools.mdx +++ b/docs/docs/components/tools.mdx @@ -2,70 +2,64 @@ import Admonition from '@theme/Admonition'; # Tools - -

- Thanks for your patience as we refine our documentation. It might have some rough edges currently. Please share your feedback or report issues to help us enhance it! ๐Ÿ› ๏ธ๐Ÿ“ -

- - -### SearchApi +## SearchApi SearchApi offers a real-time search engine results API that returns structured JSON data, including answer boxes, knowledge graphs, organic results, and more. -#### Parameters +### Parameters - **Api Key:** A unique identifier required for authentication with real-time search engines, obtainable through the [SearchApi dashboard](https://www.searchapi.io/). - **Engine:** Specifies the search engine used, such as Google, Google Scholar, Bing, YouTube, and YouTube transcripts. Refer to the [documentation](https://www.searchapi.io/docs/google) for a complete list of supported engines. - **Parameters:** Allows the selection of various parameters recognized by SearchApi. Some parameters are mandatory while others are optional. -#### Output +### Output - **Document:** The JSON response from the request. -### BingSearchRun +## BingSearchRun Bing Search, a web search engine by Microsoft, provides search results for various content types like web pages, images, videos, and news articles. It combines algorithms and human editors to deliver these results. -#### Parameters +### Parameters - **Api Wrapper:** A BingSearchAPIWrapper component that processes the search URL and subscription key. -### Calculator +## Calculator The calculator tool leverages an LLMMathChain to provide mathematical calculation capabilities, enabling the agent to perform computations as needed. -#### Parameters +### Parameters - **LLM:** The Language Model used for calculations. -### GoogleSearchResults +## GoogleSearchResults This is a wrapper around Google Search tailored for users who need precise control over the JSON data returned from the API. -#### Parameters +### Parameters - **Api Wrapper:** A GoogleSearchAPIWrapper equipped with a Google API key and CSE ID. -### GoogleSearchRun +## GoogleSearchRun This tool acts as a quick wrapper around Google Search, executing the search query and returning the snippet from the most relevant result. -#### Parameters +### Parameters - **Api Wrapper:** A GoogleSearchAPIWrapper equipped with a Google API key and CSE ID. -### GoogleSerperRun +## GoogleSerperRun A cost-effective Google Search API. -#### Parameters +### Parameters - **Api Wrapper:** A GoogleSerperAPIWrapper with the required API key and result keys. -### InfoSQLDatabaseTool +## InfoSQLDatabaseTool This tool retrieves metadata about SQL databases. It takes a comma-separated list of table names as input and outputs the schema and sample rows for those tables. -#### Parameters +### Parameters - **Db:** The SQL database to query. diff --git a/docs/docs/components/utilities.mdx b/docs/docs/components/utilities.mdx index 5f2a86d4d..99af76810 100644 --- a/docs/docs/components/utilities.mdx +++ b/docs/docs/components/utilities.mdx @@ -2,17 +2,11 @@ import Admonition from "@theme/Admonition"; # Utilities - - 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! ๐Ÿ› ๏ธ๐Ÿ“ - - 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. --- -### GET request +## GET request Make a GET request to the specified URL. @@ -27,7 +21,7 @@ Make a GET request to the specified URL. --- -### POST request +## POST request Make a POST request to the specified URL. @@ -43,7 +37,7 @@ Make a POST request to the specified URL. --- -### Update request +## Update request Make a PATCH or PUT request to the specified URL. @@ -60,7 +54,7 @@ Make a PATCH or PUT request to the specified URL. --- -### JSON document builder +## JSON document builder Build a document containing a JSON object using a key and another document page content. diff --git a/docs/docs/getting-started/canvas.mdx b/docs/docs/getting-started/canvas.mdx index 5974f245b..2f7d20cf3 100644 --- a/docs/docs/getting-started/canvas.mdx +++ b/docs/docs/getting-started/canvas.mdx @@ -11,15 +11,6 @@ The **Langflow canvas** is the central hub of Langflow, where you'll assemble ne To get a feel for the canvas, we'll examine a basic prompting flow. You can either build this flow yourself, or select **New Project** > **Basic prompting** to open a canvas with the flow pre-built. - - ## Flows, components, collections, and projects A [flow](#flow) is a pipeline of components connected together in the Langflow canvas. @@ -44,9 +35,10 @@ For example, the [Basic prompting](../starter-projects/basic-prompting.mdx) flow light: "img/basic-prompting.png", dark: "img/basic-prompting.png", }} - style={{ width: "80%", margin: "20px auto" }} + style={{ width: "100%", maxWidth: "800px", margin: "0 auto" }} /> + In this flow, the **OpenAI LLM component** receives input (left side) and produces output (right side) - in this case, receiving input from the **Chat Input** and **Prompt** components and producing output to the **Chat Output** component. ## Component @@ -77,7 +69,7 @@ Components are the building blocks of flows. They consist of inputs, outputs, an light: useBaseUrl("img/single-component.png"), dark: useBaseUrl("img/single-component.png"), }} - style={{ width: "50%", maxWidth: "800px", margin: "20px auto" }} + style={{ width: "40%", margin: "20px auto" }} />
@@ -112,7 +104,7 @@ The menu options are **Code**, **Save**, **Duplicate**, and **More**. light: "img/chat-input-with-menu.png", dark: "img/chat-input-with-menu.png", }} - style={{ width: "30%", margin: "20px auto" }} + style={{ width: "40%", margin: "20px auto" }} /> ### Code menu @@ -174,13 +166,14 @@ Modify the call's parameters in the **Tweaks** window, click the **Copy Code** o light: "img/api-window.png", dark: "img/api-window.png", }} - style={{ width: "50%", margin: "20px auto" }} + style={{ width: "60%", margin: "20px auto" }} /> ### curl 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. ```curl curl -X POST \ diff --git a/docs/docs/getting-started/install-langflow.mdx b/docs/docs/getting-started/install-langflow.mdx index 4beb5e362..e769aae01 100644 --- a/docs/docs/getting-started/install-langflow.mdx +++ b/docs/docs/getting-started/install-langflow.mdx @@ -89,7 +89,7 @@ You'll be presented with the following screen: light: "img/duplicate-space.png", dark: "img/duplicate-space.png", }} - style={{ width: "100%", margin: "20px auto" }} + style={{ width: "80%", maxWidth: "800px", margin: "0 auto" }} /> Name your Space, define the visibility (Public or Private), and click on **Duplicate Space** to start the installation process. When installation is finished, you'll be redirected to the Space's main page to start using Langflow right away! diff --git a/docs/docs/starter-projects/document-qa.mdx b/docs/docs/starter-projects/document-qa.mdx index ddbcd901a..b48e8c35d 100644 --- a/docs/docs/starter-projects/document-qa.mdx +++ b/docs/docs/starter-projects/document-qa.mdx @@ -33,7 +33,7 @@ Build a question-and-answer chatbot with a document loaded from local memory. light: "img/document-qa.png", dark: "img/document-qa.png", }} - style={{ width: "80%", margin: "20px auto" }} + style={{ width: "100%", maxWidth: "800px", margin: "0 auto" }} /> This flow creates a basic chatbot with the **Chat Input**, **Prompt**, **OpenAI**, and **Chat Output** components.