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

fix: change input display name of Webhook component to "Payload" (#4507)

Browse source 
* change input display name of webhook component to payload

* [autofix.ci] apply automated fixes

* 📝 (docs): update formatting and alignment of tables in components-data.md to improve readability and consistency across the document

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
This commit is contained in:
Cristhian Zanforlin Lousa 2024-11-11 17:51:44 -03:00 • committed by GitHub
commit 133a8aec5c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 67 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

135
docs/docs/Components/components-data.md
View file

@ -14,14 +14,14 @@ Use this component to interact with external APIs or services and retrieve data.
#### Inputs #### Inputs
| Name | Display Name | Info | | Name | Display Name | Info |
|----------|----------------|-------------------------------------------------------------| | ------- | ------------ | -------------------------------------------------------------------------- |
| URLs | URLs | The URLs to target | | URLs | URLs | The URLs to target |
| curl | curl | Paste a curl command to fill in the dictionary fields for headers and body | | curl | curl | Paste a curl command to fill in the dictionary fields for headers and body |
| Method | HTTP Method | The HTTP method to use, such as GET or POST | | Method | HTTP Method | The HTTP method to use, such as GET or POST |
| Headers | Headers | The headers to include with the request | | Headers | Headers | The headers to include with the request |
| Body | Request Body | The data to send with the request (for methods like POST, PATCH, PUT) | | Body | Request Body | The data to send with the request (for methods like POST, PATCH, PUT) |
| Timeout | Timeout | The maximum time to wait for a response | | Timeout | Timeout | The maximum time to wait for a response |
## Directory ## Directory
@ -29,20 +29,20 @@ This component recursively loads files from a directory, with options for file t
### Parameters ### Parameters
| Input | Type | Description | | Input | Type | Description |
|-------|------|-------------| | ------------------ | ---------------- | -------------------------------------------------- |
| path | MessageTextInput | Path to the directory to load files from | | path | MessageTextInput | Path to the directory to load files from |
| types | MessageTextInput | File types to load (leave empty to load all types) | | types | MessageTextInput | File types to load (leave empty to load all types) |
| depth | IntInput | Depth to search for files | | depth | IntInput | Depth to search for files |
| max_concurrency | IntInput | Maximum concurrency for loading files | | max_concurrency | IntInput | Maximum concurrency for loading files |
| load_hidden | BoolInput | If true, hidden files will be loaded | | load_hidden | BoolInput | If true, hidden files will be loaded |
| recursive | BoolInput | If true, the search will be recursive | | recursive | BoolInput | If true, the search will be recursive |
| silent_errors | BoolInput | If true, errors will not raise an exception | | silent_errors | BoolInput | If true, errors will not raise an exception |
| use_multithreading | BoolInput | If true, multithreading will be used | | use_multithreading | BoolInput | If true, multithreading will be used |
| Output | Type | Description | | Output | Type | Description |
|--------|------|-------------| | ------ | ---------- | ----------------------------------- |
| data | List[Data] | Loaded file data from the directory | | data | List[Data] | Loaded file data from the directory |
## File ## File
@ -52,18 +52,17 @@ The FileComponent is a class that loads and parses text files of various support
#### Inputs #### Inputs
| Name | Display Name | Info | | Name | Display Name | Info |
|----------------|----------------|----------------------------------------------| | ------------- | ------------- | -------------------------------------------- |
| path | Path | File path to load. | | path | Path | File path to load. |
| silent_errors | Silent Errors | If true, errors will not raise an exception. | | silent_errors | Silent Errors | If true, errors will not raise an exception. |
#### Outputs #### Outputs
| Name | Display Name | Info | | Name | Display Name | Info |
|------|--------------|-------------------------------------------| | ---- | ------------ | -------------------------------------------- |
| data | Data | Parsed content of the file as a Data object. | | data | Data | Parsed content of the file as a Data object. |
## URL ## URL
The URLComponent is a class that fetches content from one or more URLs, processes the content, and returns it as a list of Data objects. It ensures that the provided URLs are valid and uses WebBaseLoader to fetch the content. The URLComponent is a class that fetches content from one or more URLs, processes the content, and returns it as a list of Data objects. It ensures that the provided URLs are valid and uses WebBaseLoader to fetch the content.
@ -72,16 +71,15 @@ The URLComponent is a class that fetches content from one or more URLs, processe
#### Inputs #### Inputs
| Name | Display Name | Info | | Name | Display Name | Info |
|------|--------------|-------------------------| | ---- | ------------ | ---------------------- |
| urls | URLs | Enter one or more URLs | | urls | URLs | Enter one or more URLs |
#### Outputs #### Outputs
| Name | Display Name | Info | | Name | Display Name | Info |
|------|--------------|----------------------------------------------------------------| | ---- | ------------ | ------------------------------------------------------------ |
| data | Data | List of Data objects containing fetched content and metadata | | data | Data | List of Data objects containing fetched content and metadata |
## Gmail Loader ## Gmail Loader
@ -91,15 +89,15 @@ For more on creating a service account JSON, see [Service Account JSON](https://
### Parameters ### Parameters
| Input | Type | Description | | Input | Type | Description |
|-------|------|-------------| | ----------- | ---------------- | ------------------------------------------------------------------------------------ |
| json_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | | json_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access |
| label_ids | MessageTextInput | Comma-separated list of label IDs to filter emails | | label_ids | MessageTextInput | Comma-separated list of label IDs to filter emails |
| max_results | MessageTextInput | Maximum number of emails to load | | max_results | MessageTextInput | Maximum number of emails to load |
| Output | Type | Description | | Output | Type | Description |
|--------|------|-------------| | ------ | ---- | ----------------- |
| data | Data | Loaded email data | | data | Data | Loaded email data |
## Google Drive Loader ## Google Drive Loader
@ -109,14 +107,14 @@ For more on creating a service account JSON, see [Service Account JSON](https://
### Parameters ### Parameters
| Input | Type | Description | | Input | Type | Description |
|-------|------|-------------| | ----------- | ---------------- | ------------------------------------------------------------------------------------ |
| json_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | | json_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access |
| document_id | MessageTextInput | Single Google Drive document ID | | document_id | MessageTextInput | Single Google Drive document ID |
| Output | Type | Description | | Output | Type | Description |
|--------|------|-------------| | ------ | ---- | -------------------- |
| docs | Data | Loaded document data | | docs | Data | Loaded document data |
## Google Drive Search ## Google Drive Search
@ -126,22 +124,22 @@ For more on creating a service account JSON, see [Service Account JSON](https://
### Parameters ### Parameters
| Input | Type | Description | | Input | Type | Description |
|-------|------|-------------| | -------------- | ---------------- | ------------------------------------------------------------------------------------ |
| token_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | | token_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access |
| query_item | DropdownInput | The field to query | | query_item | DropdownInput | The field to query |
| valid_operator | DropdownInput | Operator to use in the query | | valid_operator | DropdownInput | Operator to use in the query |
| search_term | MessageTextInput | The value to search for in the specified query item | | search_term | MessageTextInput | The value to search for in the specified query item |
| query_string | MessageTextInput | The query string used for searching (can be edited manually) | | query_string | MessageTextInput | The query string used for searching (can be edited manually) |
| Output | Type | Description | | Output | Type | Description |
|--------|------|-------------| | ---------- | --------- | ----------------------------------------------- |
| doc_urls | List[str] | URLs of the found documents | | doc_urls | List[str] | URLs of the found documents |
| doc_ids | List[str] | IDs of the found documents | | doc_ids | List[str] | IDs of the found documents |
| doc_titles | List[str] | Titles of the found documents | | doc_titles | List[str] | Titles of the found documents |
| Data | Data | Document titles and URLs in a structured format | | Data | Data | Document titles and URLs in a structured format |
## Webhook Input ## Webhook
This component defines a webhook input for the flow. The flow can be triggered by an external HTTP POST request (webhook) sending a JSON payload. This component defines a webhook input for the flow. The flow can be triggered by an external HTTP POST request (webhook) sending a JSON payload.
@ -151,13 +149,12 @@ If the input is not valid JSON, the component will wrap it in a "payload" field.
#### Inputs #### Inputs
| Name | Type | Description | | Name | Type | Description |
|------|--------|-----------------------------------------------| | ---- | ------ | ---------------------------------------------- |
| data | String | JSON payload for testing the webhook component | | data | String | JSON payload for testing the webhook component |
#### Outputs #### Outputs
| Name | Type | Description | | Name | Type | Description |
|-------------|------|----------------------------------------| | ----------- | ---- | ------------------------------------- |
| output_data | Data | Processed data from the webhook input | | output_data | Data | Processed data from the webhook input |

2
src/backend/base/langflow/components/data/webhook.py
View file

@ -13,7 +13,7 @@ class WebhookComponent(Component):
inputs = [ inputs = [
MultilineInput( MultilineInput(
name="data", name="data",
display_name="JSON Payload", display_name="Payload",
info="Use this field to quickly test the webhook component by providing a JSON payload.", info="Use this field to quickly test the webhook component by providing a JSON payload.",
) )
] ]