jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: update docs from notion (#2747)

Browse source 
Update docs from Notion

Co-authored-by: ogabrielluiz <ogabrielluiz@users.noreply.github.com>
This commit is contained in:
github-actions[bot] 2024-07-17 21:11:21 +00:00 • committed by GitHub
commit 868e22c6c3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 54 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/docs/Configuration/configuration-authentication.md
View file

@ -44,9 +44,14 @@ langflow run --env-file .env
```
> ℹ︎ INFO
> It is critical not to expose these environment variables in your code repository. Always set them securely in your deployment environment, for example, using Docker secrets, Kubernetes ConfigMaps/Secrets, or dedicated secure environment configuration systems like AWS Secrets Manager.
>
:::caution
It is critical not to expose these environment variables in your code repository. Always set them securely in your deployment environment, for example, using Docker secrets, Kubernetes ConfigMaps/Secrets, or dedicated secure environment configuration systems like AWS Secrets Manager.
:::
### _`LANGFLOW_AUTO_LOGIN`_ {#8b10059e0fbc44f3bc8ce63fe7692e7e}

BIN
docs/docs/Integrations/1503538843.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 149 KiB

BIN
docs/docs/Integrations/505849097.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 156 KiB

42
docs/docs/Integrations/integrations-langwatch.md Normal file
View file

@ -0,0 +1,42 @@
---
title: LangWatch
sidebar_position: 1
slug: /integrations-langwatch
---
# LangWatch {#938674091aac4d9d9aa4aa6eb5c215b4}
LangWatch is an all-in-one LLMOps platform for monitoring, observability, analytics, evaluations and alerting for getting user insights and improve your LLM workflows.
To integrate with Langflow, just add your LangWatch API as a Langflow environment variable and you are good to go!
## Step-by-step Configuration {#6f1d56ff6063417491d100d522dfcf1a}
1. Obtain your LangWatch API key from [https://app.langwatch.com/](https://app.langwatch.com/)
2. Add the following key to Langflow .env file:
```shell
LANGWATCH_API_KEY="your-api-key"
```
or export it in your terminal:
```shell
export LANGWATCH_API_KEY="your-api-key"
```
1. Restart Langflow using `langflow run --env-file .env`
2. Run any project and check the LangWatch dashboard for monitoring and observability.
![](./505849097.png)
![](./1503538843.png)

46
docs/docs/Integrations/integrations-langwatch.mdx
View file

@ -1,46 +0,0 @@
import Admonition from "@theme/Admonition";
import ThemedImage from "@theme/ThemedImage";
import useBaseUrl from "@docusaurus/useBaseUrl";
import ZoomableImage from "/src/theme/ZoomableImage.js";
# LangWatch
LangWatch is an all-in-one LLMOps platform for monitoring, observability, analytics, evaluations and alerting for getting user insights and improve your LLM workflows.
To integrate with Langflow, just add your LangWatch API as a Langflow environment variable and you are good to go!
## Step-by-step Configuration
1. Obtain your LangWatch API key from https://app.langwatch.com/
2. Add the following key to Langflow .env file:
```bash
LANGWATCH_API_KEY="your-api-key"
```
or export it in your terminal:
```bash
export LANGWATCH_API_KEY="your-api-key"
```
3. Restart Langflow using `langflow run --env-file .env`
4. Run any project and check the LangWatch dashboard for monitoring and observability.
<ZoomableImage
alt="LangWatch Flow Example"
sources={{
light: useBaseUrl("img/langwatch-flow.png"),
dark: useBaseUrl("img/langwatch-flow.png"),
}}
style={{ width: "100%", margin: "20px auto", boxShadow: "rgba(50, 50, 93, 0.2) 0px 0px 27px" }}
/>
<ZoomableImage
alt="LangSmith Trace"
sources={{
light: useBaseUrl("img/langwatch-trace.png"),
dark: useBaseUrl("img/langwatch-trace.png"),
}}
style={{ width: "100%", margin: "20px auto", background: "red", boxShadow: "rgba(50, 50, 93, 0.2) 0px 0px 27px" }}
/>

2
docs/docs/Settings/settings-global-variables.md
View file

@ -112,5 +112,5 @@ The default list of variables includes the ones below and more:
- VECTARA_CORPUS_ID
- VECTARA_API_KEY
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/7030d3ff-3ecd-44db-8640-9c2295b4e3bc/langflow_global_variables.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240712%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240712T232240Z&X-Amz-Expires=3600&X-Amz-Signature=463a0203fa466f5efc5812f6c991821c996ea46f0bcf0ba84177cab56d604621&X-Amz-SignedHeaders=host&x-id=GetObject" />
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/7030d3ff-3ecd-44db-8640-9c2295b4e3bc/langflow_global_variables.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240717%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240717T013013Z&X-Amz-Expires=3600&X-Amz-Signature=a4e71525118033ce6e84c7938703b0656c42333b0788afe460cc8343441e7f24&X-Amz-SignedHeaders=host&x-id=GetObject" />

4
docs/docs/Workspace/workspace-api.md
View file

@ -36,7 +36,7 @@ The **Python Code** tab displays code to interact with your flow's `.json` f
The **Tweaks** tab displays the available parameters for your flow. Modifying the parameters changes the code parameters across all windows. For example, changing the **Chat Input** component's `input_value` will change that value across all API calls.
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/d4b5f648-d99f-47cc-9ac6-986e1c32a71d/langflow_api.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240712%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240712T232153Z&X-Amz-Expires=3600&X-Amz-Signature=bd499e71c606d6c2e3adf576abbfb5ce39105a0166bd9f7fdaa1e1a63529c64b&X-Amz-SignedHeaders=host&x-id=GetObject" />
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/d4b5f648-d99f-47cc-9ac6-986e1c32a71d/langflow_api.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240717%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240717T012917Z&X-Amz-Expires=3600&X-Amz-Signature=3b839bb021b03c6cc7ef005430c31e49c29a980bd2f2e1e8818fefb281b98e02&X-Amz-SignedHeaders=host&x-id=GetObject" />
## Chat Widget {#48f121a6cb3243979a341753da0c2700}
@ -66,7 +66,7 @@ Clicking the Chat Widget HTML tab, you'll get the code to be inserted. Read belo
The Chat Widget can be embedded into any HTML page, inside a `<body>` tag, as demonstrated in the video below.
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/01200476-f343-41e1-8be7-059250e0ce5e/langflow_widget.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240712%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240712T232153Z&X-Amz-Expires=3600&X-Amz-Signature=e0430a3c60852de518287b6dbb8e3437663b880dee6d5d0016e21a257c21a6c8&X-Amz-SignedHeaders=host&x-id=GetObject" />
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/01200476-f343-41e1-8be7-059250e0ce5e/langflow_widget.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240717%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240717T012917Z&X-Amz-Expires=3600&X-Amz-Signature=914e7a1e2f6b3cf8cac473e7e101d7647d8e3d135d520a8845b0be14b2cc08f2&X-Amz-SignedHeaders=host&x-id=GetObject" />
### Embed your flow with React {#fe5d3b1c42e74e4c84ebc9d1799b7665}

2
docs/docs/Workspace/workspace-playground.md
View file

@ -27,7 +27,7 @@ Notice how the **Playground's** window arrangement changes depending on what com
You can also open a flow's **Playground** without entering its workspace. From **My Collections** or **Langflow Store**, click the **Playground** in one of the projects card.
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/80ac6543-5548-4751-94fd-ddca60c23e62/langflow_playground.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240712%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240712T232151Z&X-Amz-Expires=3600&X-Amz-Signature=368f36f4aeb440a76c48960cc542c28dfc4f536686a32d8338b1dc66414b1588&X-Amz-SignedHeaders=host&x-id=GetObject" />
<ReactPlayer controls url="https://prod-files-secure.s3.us-west-2.amazonaws.com/09f11537-5a5b-4f56-9e8d-de8ebcfae549/80ac6543-5548-4751-94fd-ddca60c23e62/langflow_playground.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=AKIAT73L2G45HZZMZUHI%2F20240717%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-Date=20240717T012916Z&X-Amz-Expires=3600&X-Amz-Signature=cb34d17f448ff4e4d41960a509139004e4c67a2325e43eb84b2d0bbbd8cb9dbc&X-Amz-SignedHeaders=host&x-id=GetObject" />
## Memory Management {#821a5ee2a8a44d35b49943cba630511c}