Add new components for inputs and outputs

This commit is contained in:
Gabriel Luiz Freitas Almeida 2024-03-06 19:17:33 -03:00
commit eda347633b
8 changed files with 47 additions and 37 deletions

View file

View file

View file

View file

@ -1,6 +1,6 @@
import Admonition from "@theme/Admonition";
import Admonition from '@theme/Admonition';
# I/O
# Inputs
### ChatInput
@ -22,27 +22,6 @@ This component is designed to get user input from the chat.
</p>
</Admonition>
### ChatOutput
This component is designed to send a message to the chat.
**Params**
- **Sender Type:** specifies the sender type. Defaults to _`"Machine"`_. Options are _`"Machine"`_ and _`"User"`_.
- **Sender Name:** specifies the name of the sender. Defaults to _`"AI"`_.
- **Session ID:** specifies the session ID of the chat history. If provided, the message will be saved in the Message History.
- **Message:** specifies the message text.
<Admonition type="note" title="Note">
<p>
If _`As Record`_ is _`true`_ and the _`Message`_ is a _`Record`_, the data of the _`Record`_ will be updated with the _`Sender`_, _`Sender Name`_, and _`Session ID`_.
</p>
</Admonition>
### TextInput
This component is designed for simple text input, allowing users to pass textual data to subsequent components in the workflow. It's particularly useful for scenarios where a brief user input is required to initiate or influence the flow.
@ -58,16 +37,3 @@ This component is designed for simple text input, allowing users to pass textual
</p>
</Admonition>
### TextOutput
This component is designed to display text data to the user. It's particularly useful for scenarios where you don't want to send the text data to the chat, but still want to display it.
**Params**
- **Value:** Specifies the text data to be displayed. This is where the text data to be displayed is provided. If no value is provided, it defaults to an empty string.
<Admonition type="note" title="Note">
<p>
The `TextOutput` component serves as a straightforward means for displaying text data. It ensures that textual data can be seamlessly observed in the chat window throughout your flow.
</p>
</Admonition>

View file

View file

@ -0,0 +1,37 @@
import Admonition from '@theme/Admonition';
# Outputs
### ChatOutput
This component is designed to send a message to the chat.
**Params**
- **Sender Type:** specifies the sender type. Defaults to _`"Machine"`_. Options are _`"Machine"`_ and _`"User"`_.
- **Sender Name:** specifies the name of the sender. Defaults to _`"AI"`_.
- **Session ID:** specifies the session ID of the chat history. If provided, the message will be saved in the Message History.
- **Message:** specifies the message text.
<Admonition type="note" title="Note">
<p>
If _`As Record`_ is _`true`_ and the _`Message`_ is a _`Record`_, the data of the _`Record`_ will be updated with the _`Sender`_, _`Sender Name`_, and _`Session ID`_.
</p>
</Admonition>
### TextOutput
This component is designed to display text data to the user. It's particularly useful for scenarios where you don't want to send the text data to the chat, but still want to display it.
**Params**
- **Value:** Specifies the text data to be displayed. This is where the text data to be displayed is provided. If no value is provided, it defaults to an empty string.
<Admonition type="note" title="Note">
<p>
The `TextOutput` component serves as a straightforward means for displaying text data. It ensures that textual data can be seamlessly observed in the chat window throughout your flow.
</p>
</Admonition>

View file

@ -33,12 +33,19 @@ module.exports = {
label: "Component Reference",
collapsed: false,
items: [
"components/inputs",
"components/outputs",
"components/data",
"components/prompts",
"components/models",
"components/helpers",
"components/experimental",
"components/agents",
"components/chains",
"components/custom",
"components/embeddings",
"components/io",
"components/llms",
"components/model_specs",
"components/loaders",
"components/memories",
"components/prompts",