docs: processing components #6099
Open
+76
−83
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
mendonk
commented
Feb 3, 2025
mendonk
commented
- Address components that were renamed
- Link to Data and Message objects for more context
- Consistent headings
dosubot
bot
added
size:L
github-actions
bot
added
documentation
KimberlyFields
approved these changes
Feb 4, 2025
|
|
||
| ### Inputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | input_value | Input | Objects to which Metadata should be added | | ||
| | text_in | User Text | Text input; value will be in 'text' attribute of Data object. Empty text entries are ignored. | | ||
| | text_in | User Text | Text input; value will be in 'text' attribute of [Data](/concepts-objects#data-object) object. Empty text entries are ignored. | |
There was a problem hiding this comment.
Suggested change
| | text_in | User Text | Text input; value will be in 'text' attribute of [Data](/concepts-objects#data-object) object. Empty text entries are ignored. | | |
| | text_in | User Text | Text input; the value will be in the 'text' attribute of the [Data](/concepts-objects#data-object) object. Empty text entries are ignored. | |
Comment on lines
+137
to
+138
| | filter_key | Filter Key | The key to filter on (for example, 'route'). | | ||
| | filter_value | Filter Value | The value to filter by (for example, 'CMIP'). | |
There was a problem hiding this comment.
Suggested change
| | filter_key | Filter Key | The key to filter on (for example, 'route'). | | |
| | filter_value | Filter Value | The value to filter by (for example, 'CMIP'). | | |
| | filter_key | Filter Key | The key to filter on, for example, 'route'. | | |
| | filter_value | Filter Value | The value to filter by, for example, 'CMIP'. | |
|
|
||
| ### Inputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | data_inputs | Data Inputs | Data to combine (minimum 2 inputs required) | | ||
| | operation | Operation Type | Operation to perform (Concatenate/Append/Merge/Join) | | ||
| | data | Data | A list of data objects to be merged | |
There was a problem hiding this comment.
Suggested change
| | data | Data | A list of data objects to be merged | | |
| | data | Data | A list of data objects to be merged. | |
|
|
||
| ### Outputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | combined_data | DataFrame | The combined data result | | ||
| | merged_data | Merged Data | A single [Data](/concepts-objects#data-object) object containing the combined information from all input data objects | |
There was a problem hiding this comment.
Suggested change
| | merged_data | Merged Data | A single [Data](/concepts-objects#data-object) object containing the combined information from all input data objects | | |
| | merged_data | Merged Data | A single [Data](/concepts-objects#data-object) object containing the combined information from all input data objects. | |
|
|
||
| ### Inputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | message | Message | The Message object to convert to a Data object | | ||
| | message | Message | The [Message](/concepts-objects#message-object) object to convert to a [Data](/concepts-objects#data-object) object | |
There was a problem hiding this comment.
Suggested change
| | message | Message | The [Message](/concepts-objects#message-object) object to convert to a [Data](/concepts-objects#data-object) object | | |
| | message | Message | The [Message](/concepts-objects#message-object) object to convert to a [Data](/concepts-objects#data-object) object. | |
|
|
||
| This component converts and extracts JSON fields using JQ queries. | ||
|
|
||
| ### Inputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | input_value | Input | Data object to filter (Message or Data) | | ||
| | input_value | Input | Data object to filter ([Message](/concepts-objects#message-object) or [Data](/concepts-objects#data-object)) | |
There was a problem hiding this comment.
Suggested change
| | input_value | Input | Data object to filter ([Message](/concepts-objects#message-object) or [Data](/concepts-objects#data-object)) | | |
| | input_value | Input | Data object to filter ([Message](/concepts-objects#message-object) or [Data](/concepts-objects#data-object)). | |
| | query | JQ Query | JQ Query to filter the data | | ||
|
|
||
| ### Outputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | filtered_data | Filtered Data | Filtered data as list of Data objects | | ||
| | filtered_data | Filtered Data | Filtered data as list of [Data](/concepts-objects#data-object) objects | |
There was a problem hiding this comment.
Suggested change
| | filtered_data | Filtered Data | Filtered data as list of [Data](/concepts-objects#data-object) objects | | |
| | filtered_data | Filtered Data | Filtered data as list of [Data](/concepts-objects#data-object) objects. | |
| @@ -295,9 +288,9 @@ This component selects a single data item from a list. | |||
|
|
|||
| | Name | Display Name | Info | | |||
| |------|--------------|------| | |||
| | selected_data | Selected Data | The selected Data object | | |||
| | selected_data | Selected Data | The selected [Data](/concepts-objects#data-object) object | | |||
There was a problem hiding this comment.
Suggested change
| | selected_data | Selected Data | The selected [Data](/concepts-objects#data-object) object | | |
| | selected_data | Selected Data | The selected [Data](/concepts-objects#data-object) object. | |
| @@ -314,10 +307,10 @@ This component splits text into chunks based on specified criteria. | |||
|
|
|||
| | Name | Display Name | Info | | |||
| |------|--------------|------| | |||
| | chunks | Chunks | List of split text chunks as Data objects | | |||
| | chunks | Chunks | List of split text chunks as [Data](/concepts-objects#data-object) objects | | |||
There was a problem hiding this comment.
Suggested change
| | chunks | Chunks | List of split text chunks as [Data](/concepts-objects#data-object) objects | | |
| | chunks | Chunks | List of split text chunks as [Data](/concepts-objects#data-object) objects. | |
| @@ -334,4 +327,4 @@ This component dynamically updates or appends data with specified fields. | |||
|
|
|||
| | Name | Display Name | Info | | |||
| |------|--------------|------| | |||
| | data | Data | Updated Data objects | | |||
| | data | Data | Updated [Data](/concepts-objects#data-object) objects | | |||
There was a problem hiding this comment.
Suggested change
| | data | Data | Updated [Data](/concepts-objects#data-object) objects | | |
| | data | Data | Updated [Data](/concepts-objects#data-object) objects. | |
github-actions
bot
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.