From 133a8aec5c97d008667f992b7a7b82e1f445e81f Mon Sep 17 00:00:00 2001 From: Cristhian Zanforlin Lousa Date: Mon, 11 Nov 2024 17:51:44 -0300 Subject: [PATCH] fix: change input display name of Webhook component to "Payload" (#4507) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 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> --- docs/docs/Components/components-data.md | 135 +++++++++--------- .../base/langflow/components/data/webhook.py | 2 +- 2 files changed, 67 insertions(+), 70 deletions(-) diff --git a/docs/docs/Components/components-data.md b/docs/docs/Components/components-data.md index 7f43be54d..87ea75ac7 100644 --- a/docs/docs/Components/components-data.md +++ b/docs/docs/Components/components-data.md @@ -14,14 +14,14 @@ Use this component to interact with external APIs or services and retrieve data. #### Inputs -| Name | Display Name | Info | -|----------|----------------|-------------------------------------------------------------| -| URLs | URLs | The URLs to target | -| 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 | -| 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) | -| Timeout | Timeout | The maximum time to wait for a response | +| Name | Display Name | Info | +| ------- | ------------ | -------------------------------------------------------------------------- | +| URLs | URLs | The URLs to target | +| 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 | +| 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) | +| Timeout | Timeout | The maximum time to wait for a response | ## Directory @@ -29,20 +29,20 @@ This component recursively loads files from a directory, with options for file t ### Parameters -| Input | Type | Description | -|-------|------|-------------| -| path | MessageTextInput | Path to the directory to load files from | -| types | MessageTextInput | File types to load (leave empty to load all types) | -| depth | IntInput | Depth to search for files | -| max_concurrency | IntInput | Maximum concurrency for loading files | -| load_hidden | BoolInput | If true, hidden files will be loaded | -| recursive | BoolInput | If true, the search will be recursive | -| silent_errors | BoolInput | If true, errors will not raise an exception | -| use_multithreading | BoolInput | If true, multithreading will be used | +| Input | Type | Description | +| ------------------ | ---------------- | -------------------------------------------------- | +| path | MessageTextInput | Path to the directory to load files from | +| types | MessageTextInput | File types to load (leave empty to load all types) | +| depth | IntInput | Depth to search for files | +| max_concurrency | IntInput | Maximum concurrency for loading files | +| load_hidden | BoolInput | If true, hidden files will be loaded | +| recursive | BoolInput | If true, the search will be recursive | +| silent_errors | BoolInput | If true, errors will not raise an exception | +| use_multithreading | BoolInput | If true, multithreading will be used | -| Output | Type | Description | -|--------|------|-------------| -| data | List[Data] | Loaded file data from the directory | +| Output | Type | Description | +| ------ | ---------- | ----------------------------------- | +| data | List[Data] | Loaded file data from the directory | ## File @@ -52,18 +52,17 @@ The FileComponent is a class that loads and parses text files of various support #### Inputs -| Name | Display Name | Info | -|----------------|----------------|----------------------------------------------| -| path | Path | File path to load. | -| silent_errors | Silent Errors | If true, errors will not raise an exception. | +| Name | Display Name | Info | +| ------------- | ------------- | -------------------------------------------- | +| path | Path | File path to load. | +| silent_errors | Silent Errors | If true, errors will not raise an exception. | #### Outputs -| Name | Display Name | Info | -|------|--------------|-------------------------------------------| +| Name | Display Name | Info | +| ---- | ------------ | -------------------------------------------- | | data | Data | Parsed content of the file as a Data object. | - ## 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. @@ -72,16 +71,15 @@ The URLComponent is a class that fetches content from one or more URLs, processe #### Inputs -| Name | Display Name | Info | -|------|--------------|-------------------------| -| urls | URLs | Enter one or more URLs | +| Name | Display Name | Info | +| ---- | ------------ | ---------------------- | +| urls | URLs | Enter one or more URLs | #### Outputs -| Name | Display Name | Info | -|------|--------------|----------------------------------------------------------------| -| data | Data | List of Data objects containing fetched content and metadata | - +| Name | Display Name | Info | +| ---- | ------------ | ------------------------------------------------------------ | +| data | Data | List of Data objects containing fetched content and metadata | ## Gmail Loader @@ -91,15 +89,15 @@ For more on creating a service account JSON, see [Service Account JSON](https:// ### Parameters -| Input | Type | Description | -|-------|------|-------------| -| 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 | -| max_results | MessageTextInput | Maximum number of emails to load | +| Input | Type | Description | +| ----------- | ---------------- | ------------------------------------------------------------------------------------ | +| 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 | +| max_results | MessageTextInput | Maximum number of emails to load | -| Output | Type | Description | -|--------|------|-------------| -| data | Data | Loaded email data | +| Output | Type | Description | +| ------ | ---- | ----------------- | +| data | Data | Loaded email data | ## Google Drive Loader @@ -109,14 +107,14 @@ For more on creating a service account JSON, see [Service Account JSON](https:// ### Parameters -| Input | Type | Description | -|-------|------|-------------| -| json_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | -| document_id | MessageTextInput | Single Google Drive document ID | +| Input | Type | Description | +| ----------- | ---------------- | ------------------------------------------------------------------------------------ | +| json_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | +| document_id | MessageTextInput | Single Google Drive document ID | -| Output | Type | Description | -|--------|------|-------------| -| docs | Data | Loaded document data | +| Output | Type | Description | +| ------ | ---- | -------------------- | +| docs | Data | Loaded document data | ## Google Drive Search @@ -126,22 +124,22 @@ For more on creating a service account JSON, see [Service Account JSON](https:// ### Parameters -| Input | Type | Description | -|-------|------|-------------| -| token_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | -| query_item | DropdownInput | The field to query | -| valid_operator | DropdownInput | Operator to use in the query | -| 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) | +| Input | Type | Description | +| -------------- | ---------------- | ------------------------------------------------------------------------------------ | +| token_string | SecretStrInput | JSON string containing OAuth 2.0 access token information for service account access | +| query_item | DropdownInput | The field to query | +| valid_operator | DropdownInput | Operator to use in the query | +| 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) | -| Output | Type | Description | -|--------|------|-------------| -| doc_urls | List[str] | URLs of the found documents | -| doc_ids | List[str] | IDs of the found documents | -| doc_titles | List[str] | Titles of the found documents | -| Data | Data | Document titles and URLs in a structured format | +| Output | Type | Description | +| ---------- | --------- | ----------------------------------------------- | +| doc_urls | List[str] | URLs of the found documents | +| doc_ids | List[str] | IDs of the found documents | +| doc_titles | List[str] | Titles of the found documents | +| 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. @@ -151,13 +149,12 @@ If the input is not valid JSON, the component will wrap it in a "payload" field. #### Inputs -| Name | Type | Description | -|------|--------|-----------------------------------------------| +| Name | Type | Description | +| ---- | ------ | ---------------------------------------------- | | data | String | JSON payload for testing the webhook component | #### Outputs -| Name | Type | Description | -|-------------|------|----------------------------------------| +| Name | Type | Description | +| ----------- | ---- | ------------------------------------- | | output_data | Data | Processed data from the webhook input | - diff --git a/src/backend/base/langflow/components/data/webhook.py b/src/backend/base/langflow/components/data/webhook.py index b41d24ac0..88eb1e82b 100644 --- a/src/backend/base/langflow/components/data/webhook.py +++ b/src/backend/base/langflow/components/data/webhook.py @@ -13,7 +13,7 @@ class WebhookComponent(Component): inputs = [ MultilineInput( name="data", - display_name="JSON Payload", + display_name="Payload", info="Use this field to quickly test the webhook component by providing a JSON payload.", ) ]