remove-gerunds-in-titles

This commit is contained in:
Mendon Kissling 2024-06-07 15:43:53 -04:00
commit 36e298a7df
6 changed files with 37 additions and 19 deletions

View file

@ -14,9 +14,9 @@ The default values are `langflow` and `langflow`, respectively.
</Admonition>
## Generating an API Key
## Generate an API Key
### Through Langflow UI
### With Langflow UI
<ZoomableImage
alt="Docusaurus themed image"
@ -33,9 +33,27 @@ The default values are `langflow` and `langflow`, respectively.
4. Click on "Create secret key".
5. Copy the API key and store it in a secure location.
## Using the API Key
### With Langflow CLI
### Using the `x-api-key` Header
```bash
langflow api-key
# or
python -m langflow api-key
╭─────────────────────────────────────────────────────────────────────╮
│ API Key Created Successfully: │
│ │
│ sk-O0elzoWID1izAH8RUKrnnvyyMwIzHi2Wk-uXWoNJ2Ro │
│ │
│ This is the only time the API key will be displayed. │
│ Make sure to store it in a secure location. │
│ │
│ The API key has been copied to your clipboard. Cmd + V to paste it. │
╰──────────────────────────────
```
## Use the API Key
### Use the `x-api-key` Header
Include the `x-api-key` in the HTTP header when making API requests:
@ -90,7 +108,7 @@ api_key = "<your api key>"
print(run_flow(inputs, flow_id=FLOW_ID, tweaks=TWEAKS, apiKey=api_key))
```
### Using the Query Parameter
### Use the Query Parameter
Include the API key as a query parameter in the URL:
@ -101,7 +119,7 @@ curl -X POST \
-d '{"inputs": {"text":""}, "tweaks": {}}'
```
Or with Python:
With Python using `requests`:
```python
import requests
@ -148,6 +166,6 @@ print(run_flow(inputs, flow_id=FLOW_ID, tweaks=TWEAKS, apiKey=api_key))
- **Visibility**: For security reasons, the API key cannot be retrieved again through the UI.
- **Scope**: The key allows access only to the flows and components of the specific user to whom it was issued.
## Revoking an API Key
## Revoke an API Key
To revoke an API key, delete it from the UI. This action immediately invalidates the key and prevents it from being used again.

View file

@ -17,7 +17,7 @@ Global Variables are a useful feature of Langflow, allowing you to define reusab
- All Credential Global Variables are encrypted and accessible only by you.
- Set _`LANGFLOW_STORE_ENVIRONMENT_VARIABLES`_ to _`true`_ in your `.env` file to add all variables in _`LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT`_ to your user's Global Variables.
## Creating and Adding a Global Variable
## Create and Add a Global Variable
To create and add a global variable, click the 🌐 button in a Text field, and then click **+ Add New Variable**.
@ -59,7 +59,7 @@ For more on variables in HuggingFace Spaces, see [Managing Secrets](https://hugg
All Credential Global Variables are encrypted and accessible only by you.
</Admonition>
## Configuring Environment Variables in your .env file
## Configure Environment Variables in your .env file
Setting `LANGFLOW_STORE_ENVIRONMENT_VARIABLES` to `true` in your `.env` file (default) adds all variables in `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` to your user's Global Variables.

View file

@ -7,7 +7,7 @@ This guide will help you get LangFlow up and running using Docker and Docker Com
- Docker
- Docker Compose
## Steps
## Clone repo and build Docker container
1. Clone the LangFlow repository:
@ -29,11 +29,11 @@ This guide will help you get LangFlow up and running using Docker and Docker Com
LangFlow will now be accessible at [http://localhost:7860/](http://localhost:7860/).
## Docker Compose Configuration
## Docker Compose configuration
The Docker Compose configuration spins up two services: `langflow` and `postgres`.
### LangFlow Service
### LangFlow service
The `langflow` service uses the `langflowai/langflow:latest` Docker image and exposes port 7860. It depends on the `postgres` service.
@ -46,7 +46,7 @@ Volumes:
- `langflow-data`: This volume is mapped to `/var/lib/langflow` in the container.
### PostgreSQL Service
### PostgreSQL service
The `postgres` service uses the `postgres:16` Docker image and exposes port 5432.
@ -60,6 +60,6 @@ Volumes:
- `langflow-postgres`: This volume is mapped to `/var/lib/postgresql/data` in the container.
## Switching to a Specific LangFlow Version
## Switch to a specific LangFlow version
If you want to use a specific version of LangFlow, you can modify the `image` field under the `langflow` service in the Docker Compose file. For example, to use version 1.0-alpha, change `langflowai/langflow:latest` to `langflowai/langflow:1.0-alpha`.

View file

@ -3,7 +3,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
import ZoomableImage from "/src/theme/ZoomableImage.js";
import ReactPlayer from "react-player";
# Building Chatbots with System Message
# Build Chatbots with the System Message Component
## Overview

View file

@ -355,7 +355,7 @@ All done! This is what our script and brand-new custom component look like:
---
## Loading Custom Components
## Load Custom Components
For advanced customization, Langflow offers the option to create and load custom components outside of the standard interface. This process involves creating the desired components using a text editor and loading them using the Langflow CLI.
@ -380,7 +380,7 @@ Your structure should look something like this:
└── ...
```
### Loading Custom Components
### Load Custom Components
The recommended way to load custom components is to set the _`LANGFLOW_COMPONENTS_PATH`_ environment variable to the path of your custom components directory. Then, run the Langflow CLI as usual.
@ -397,7 +397,7 @@ langflow run --components-path /path/to/components
Langflow will attempt to load all of the components found in the specified directory. If a component fails to load due to errors in the component's code, Langflow will print an error message to the console but will continue loading the rest of the components.
### Interacting with Custom Components
### Interact with Custom Components
Once your custom components have been loaded successfully, they will appear in Langflow's sidebar. From there, you can add them to your Langflow canvas for use. However, please note that components with errors will not be available for addition to the canvas. Always ensure your code is error-free before attempting to load components.

View file

@ -3,7 +3,7 @@ import useBaseUrl from "@docusaurus/useBaseUrl";
import ZoomableImage from "/src/theme/ZoomableImage.js";
import ReactPlayer from "react-player";
# Integrating Documents with Prompt Variables
# Integrate Documents with Prompt Variables
## Overview