docs: updates for release #6762
Open
+127
−75
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
dosubot
bot
added
size:L
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
removed
the
documentation
github-actions
bot
added
the
documentation
edwinjosechittilappilly
requested changes
Feb 25, 2025
Co-authored-by: Edwin Jose <[email protected]>
github-actions
bot
added
documentation
github-actions
bot
added
documentation
…w-ai/langflow into docs-updates-for-release
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
github-actions
bot
added
documentation
KimberlyFields
approved these changes
Feb 25, 2025
| * **Name**: The name of the output field. | ||
| * **Description**: The purpose of the output field. | ||
| * **Type**: The data type of the output field. The available types are `str`, `int`, `float`, `bool`, `list`, or `dict`. The default is `text`. | ||
| * **Multiple**: Deprecated feature, currently by default, it is set to `True` if you expect multiple values for a single field. For example, a `list` of `features` is set to `true` to contain multiple values, such as `["waterproof", "durable", "lightweight"]`. Default: `True`. |
There was a problem hiding this comment.
Suggested change
| * **Multiple**: Deprecated feature, currently by default, it is set to `True` if you expect multiple values for a single field. For example, a `list` of `features` is set to `true` to contain multiple values, such as `["waterproof", "durable", "lightweight"]`. Default: `True`. | |
| * **Multiple**: This feature is deprecated. Currently, it is set to `True` by default if you expect multiple values for a single field. For example, a `list` of `features` is set to `True` to contain multiple values, such as `["waterproof", "durable", "lightweight"]`. Default: `True`. |
| * **Name**: The name of the output field. | ||
| * **Description**: The purpose of the output field. | ||
| * **Type**: The data type of the output field. The available types are `str`, `int`, `float`, `bool`, `list`, or `dict`. The default is `text`. | ||
| * **Multiple**: Deprecated feature, currently by default, it is set to `True` if you expect multiple values for a single field. For example, a `list` of `features` is set to `true` to contain multiple values, such as `["waterproof", "durable", "lightweight"]`. Default: `True`. |
There was a problem hiding this comment.
Is there a replacement for this deprecated option? What happens if a user used this option in the past?
|
|
||
| The **Parse DataFrame** component parses the structured output into a template for orderly presentation in chat output. The template receives the values from the `output_schema` table with curly braces. | ||
|
|
||
| For example, the template `EBITIDA: {EBITIDA} , Net Income: {NET_INCOME} , GROSS_PROFIT: {GROSS_PROFIT}` presents the extracted values in the **Playground** as `EBITIDA: 900 million , Net Income: 500 million , GROSS_PROFIT: 1.2 billion`. |
There was a problem hiding this comment.
Should this be "EBITDA"?
| | system_prompt | Format Instructions | Instructions to the language model for formatting the output. | | ||
| | schema_name | Schema Name | The name for the output data schema. | | ||
| | output_schema | Output Schema | Defines the structure and data types for the model's output.| | ||
| | multiple | Generate Multiple | [Deprecated] Always set to `True`. | |
There was a problem hiding this comment.
Is there a replacement for the deprecated option? What happens if a user used this option in a previous release?
| |should_store_message|Store Messages|Store the message in the history.| | ||
| |sender|Sender Type|The type of sender.| | ||
| |sender_name|Sender Name|The name of the sender.| | ||
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter will be used.| |
There was a problem hiding this comment.
Suggested change
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter will be used.| | |
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter is used.| |
| |should_store_message|Store Messages|The flag to store the message in the history.| | ||
| |sender|Sender Type|The type of sender.| | ||
| |sender_name|Sender Name|The name of the sender.| | ||
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter will be used.| |
There was a problem hiding this comment.
Suggested change
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter will be used.| | |
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter is used.| |
| |sender|Sender Type|The type of sender.| | ||
| |sender_name|Sender Name|The name of the sender.| | ||
| |session_id|Session ID|The session ID of the chat. If empty, the current session ID parameter will be used.| | ||
| |data_template|Data Template|The template to convert Data to Text. If left empty, it will be dynamically set to the Data's text key.| |
There was a problem hiding this comment.
Suggested change
| |data_template|Data Template|The template to convert Data to Text. If left empty, it will be dynamically set to the Data's text key.| | |
| |data_template|Data Template|The template to convert Data to Text. If the option is left empty, it is dynamically set to the Data's text key.| |
|
|
||
| ### Outputs | ||
|
|
||
| | Name | Display Name | Info | | ||
| |------|--------------|------| | ||
| | data | Data | List of search results as Data objects | | ||
| | data | Data | List of search results as Data objects containing snippets and full content. | |
There was a problem hiding this comment.
Why is data capitalized in the Info column?
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.
This pull request includes significant updates to the documentation for various components.
The most important changes include updates to the
Structured Outputcomponent, theChat InputandChat Outputcomponents, and theText Splittercomponent. Additionally, there is an update to the installation prerequisites for Langflow.Documentation Updates:
docs/docs/Components/components-helpers.md: Enhanced theStructured Outputcomponent documentation by adding an example, updating theoutput_schematable, and providing more detailed descriptions of its parameters.docs/docs/Components/components-io.md: Updated theChat Inputcomponent to list the accepted input types and revised theinput_valueparameter description. Similar updates were made to theChat Outputcomponent to list accepted input types. [1] [2]docs/docs/Components/components-processing.md: Improved theText Splittercomponent documentation by updating parameter descriptions, specifying default values, and adding a newtext_keyparameter.Installation Prerequisites:
docs/docs/Get-Started/get-started-installation.md: Updated the Python version requirement to include Python 3.13.