37 lines
No EOL
1.4 KiB
Text
37 lines
No EOL
1.4 KiB
Text
import Admonition from '@theme/Admonition';
|
|
|
|
# Outputs
|
|
|
|
### Chat Output
|
|
|
|
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>
|
|
|
|
### Text Output
|
|
|
|
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> |