Spaces:
Running
Running
File size: 16,125 Bytes
2e77168 e08e97a 2e77168 f5c4c58 2e77168 e08e97a 2e77168 e08e97a 2e77168 f5c4c58 2e77168 f5c4c58 2e77168 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
# Chatbot
A chatbot component based on [Ant Design X](https://x.ant.design).
## Examples
### Basic
Supports:
- Two roles: user and assistant.
- Four message types: text, file, tool, and suggestion.
<demo name="basic" position="bottom" collapsible="true"></demo>
### Chatbot Config
Supports configuration options:
- `markdown_config`: Rendering configuration for Markdown text in the Chatbot.
- `welcome_config`: Welcome interface configuration displayed when the Chatbot is empty.
- `bot_config`: Display configuration for bot messages.
- `user_config`: Display configuration for user messages.
<demo name="chatbot_config" position="bottom" collapsible="true"></demo>
### Message Config
The `message` object includes all configurations from `bot_config` and `user_config`, allowing users to customize the display of individual messages.
<demo name="message_config" position="bottom" collapsible="true"></demo>
### Multimodal
<demo name="multimodal" position="bottom" collapsible="true"></demo>
### Thinking
<demo name="thinking" position="bottom" collapsible="true"></demo>
## API
### Props
| Attribute | Type | Default Value | Description |
| ------------------------------ | ----------------------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| value | `list[dict \| ChatbotDataMessage] \| ChatbotDataMessages \| None` | None | Default list of messages to show in chatbot, where each message is of the format `ChatbotDataMessage`. |
| welcome_config | `ChatbotWelcomeConfig \| dict \| None` | None | Configuration of the welcome interface. If the `value` is empty, the welcome interface will be displayed. |
| markdown_config | `ChatbotMarkdownConfig \| dict \| None` | None | Markdown configuration for all messages. |
| user_config | `ChatbotUserConfig \| dict \| None` | None | User configuration, will be applied when the message role is 'user'. |
| bot_config | `ChatbotBotConfig \| dict \| None` | None | Bot configuration, will be applied when the message role is 'assistant'. |
| auto_scroll | `bool` | True | If `True`, will automatically scroll to the bottom of the textbox when the value changes, unless the user scrolls up. If False, will not scroll to the bottom of the textbox when the value changes. |
| show_scroll_to_bottom_button | `bool` | True | If `True`, the `Scroll To Bottom` button will be shown when the scrollbar is up a certain distance. |
| scroll_to_bottom_button_offset | `int \| float` | 200 | The offset from the bottom where the `Scroll To Bottom` button appears. |
| height | `int \| float \| str` | 400 | The height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. If messages exceed the height, the component will scroll. |
| max_height | `int \| float \| str \| None` | None | The maximum height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. |
| min_height | `int \| float \| str \| None` | None | The minimum height of the component, specified in pixels if a number is passed, or in CSS units if a string is passed. |
### Events
| Event | Description |
| -------------------------------------------- | ------------------------------------------------------- |
| `pro.Chatbot.change(fn, ···)` | Triggered when the Chatbot value changed. |
| `pro.Chatbot.copy(fn, ···)` | Triggered when the copy button is clicked. |
| `pro.Chatbot.edit(fn, ···)` | Triggered when user edit a message. |
| `pro.Chatbot.delete(fn, ···)` | Triggered when user delete a message. |
| `pro.Chatbot.like(fn, ···)` | Triggered when the like/dislike button is clicked |
| `pro.Chatbot.retry(fn, ···)` | Triggered when the retry button is clicked |
| `pro.Chatbot.suggestion_select(fn, ···)` | Triggered when the suggestion message item is selected. |
| `pro.Chatbot.welcome_prompt_select(fn, ···)` | Triggered when the welcome prompt item is selected. |
### Slots
```python
SLOTS=["roles"]
```
Additionally, if the role style does not meet your expectations, you can also use `ms.Slot("roles")` to customize it, just like the `Bubble` component of `Ant Design X`.
### Types
```python
# Ant Design X prompt props: https://x.ant.design/components/prompts#promptprops
class ChatbotPromptConfig(GradioModel):
disabled: Optional[bool] = None
description: Optional[str] = None
label: Optional[str] = None
icon: Optional[str] = None
key: Optional[str] = None
children: Optional[List[Union[
dict,
]]] = None
# Ant Design X prompts props: https://x.ant.design/components/prompts
class ChatbotPromptsConfig(GradioModel):
title: Optional[str] = None
vertical: Optional[bool] = False
wrap: Optional[bool] = False
styles: Optional[dict] = None
class_names: Optional[dict] = None
elem_style: Optional[dict] = None
elem_classes: Optional[Union[str, List[str]]] = None
items: Optional[List[Union[ChatbotPromptConfig, dict]]] = None
# Ant Design X welcome props: https://x.ant.design/components/welcome
class ChatbotWelcomeConfig(GradioModel):
variant: Optional[Literal['borderless', 'filled']] = 'borderless'
icon: Optional[Union[str, Path]] = None
title: Optional[str] = None
description: Optional[str] = None
extra: Optional[str] = None
elem_style: Optional[dict] = None
elem_classes: Optional[Union[str, List[str]]] = None
styles: Optional[dict] = None
class_names: Optional[dict] = None
prompts: Optional[Union[ChatbotPromptsConfig, dict]] = None
class ChatbotMarkdownConfig(GradioModel):
render_markdown: Optional[bool] = True
latex_delimiters: Optional[list[dict[str, str | bool]]] = field(
default_factory=lambda: [
{
"left": "$$",
"right": "$$",
"display": True
},
{
"left": "$",
"right": "$",
"display": False
},
{
"left": "\\(",
"right": "\\)",
"display": False
},
{
"left": "\\begin{equation}",
"right": "\\end{equation}",
"display": True
},
{
"left": "\\begin{align}",
"right": "\\end{align}",
"display": True
},
{
"left": "\\begin{alignat}",
"right": "\\end{alignat}",
"display": True
},
{
"left": "\\begin{gather}",
"right": "\\end{gather}",
"display": True
},
{
"left": "\\begin{CD}",
"right": "\\end{CD}",
"display": True
},
{
"left": "\\[",
"right": "\\]",
"display": True
},
])
sanitize_html: Optional[bool] = True
line_breaks: Optional[bool] = True
rtl: Optional[bool] = False
allow_tags: Optional[Union[List[str], bool]] = False
class ChatbotActionConfig(GradioModel):
action: Literal['copy', 'like', 'dislike', 'retry', 'edit', 'delete']
disabled: Optional[bool] = None
# Ant Design tooltip: https://ant.design/components/tooltip
tooltip: Optional[Union[str, dict]] = None
# Ant Design popconfirm props: https://ant.design/components/popconfirm
popconfirm: Optional[Union[str, dict]] = None
class ChatbotUserConfig(GradioModel):
# Action buttons for user message
actions: Optional[List[Union[Literal[
'copy',
'edit',
'delete',
], ChatbotActionConfig, dict]]] = field(default_factory=lambda: [
"copy"
# 'edit',
# ChatbotActionConfig(
# action='delete',
# popconfirm=dict(title="Delete the message",
# description="Are you sure to delete this message?",
# okButtonProps=dict(danger=True)))
])
disabled_actions: Optional[List[Union[Literal[
'copy',
'edit',
'delete',
]]]] = None
header: Optional[str] = None
footer: Optional[str] = None
# Ant Design avatar props: https://ant.design/components/avatar
avatar: Optional[Union[str, Path, dict, None]] = None
variant: Optional[Literal['filled', 'borderless', 'outlined',
'shadow']] = None
shape: Optional[Literal['round', 'corner']] = None
placement: Optional[Literal['start', 'end']] = 'end'
loading: Optional[bool] = None
typing: Optional[Union[bool, dict]] = None
elem_style: Optional[dict] = None
elem_classes: Optional[Union[str, List[str]]] = None
styles: Optional[dict] = None
class_names: Optional[dict] = None
class ChatbotBotConfig(ChatbotUserConfig):
# Action buttons for bot message
actions: Optional[List[Union[Literal[
'copy',
'like',
'dislike',
'retry',
'edit',
'delete',
], ChatbotActionConfig, dict]]] = field(default_factory=lambda: [
'copy',
# 'like', 'dislike', 'retry', 'edit',
# ChatbotActionConfig(
# action='delete',
# popconfirm=dict(title="Delete the message",
# description="Are you sure to delete this message?",
# okButtonProps=dict(danger=True)))
])
disabled_actions: Optional[List[Union[Literal[
'copy',
'like',
'dislike',
'retry',
'edit',
'delete',
]]]] = None
placement: Optional[Literal['start', 'end']] = 'start'
class ChatbotDataTextContentOptions(ChatbotMarkdownConfig):
pass
class ChatbotDataToolContentOptions(ChatbotDataTextContentOptions):
"""
title: tool message title.
status: tool message status, if status is 'done', the message will be collapsed.
"""
title: Optional[str] = None
status: Optional[Literal['pending', 'done']] = None
# Ant Design flex props: https://ant.design/components/flex
class ChatbotDataFileContentOptions(GradioModel):
vertical: Union[bool] = False
wrap: Optional[Union[Literal['nowrap', 'wrap', 'wrap-reverse'],
bool]] = True
justify: Optional[Literal['normal', 'start', 'end', 'flex-start',
'flex-end', 'center', 'left', 'right',
'space-between', 'space-around', 'space-evenly',
'stretch', 'safe', 'unsafe']] = "normal"
align: Optional[Literal['normal', 'start', 'end', 'flex-start', 'flex-end',
'center', 'self-start', 'self-end', 'baseline',
'unsafe', 'stretch']] = "normal"
flex: Optional[str] = "normal"
gap: Optional[Union[Literal["small", "middle", "large"], str, int,
float]] = "small"
image_props: Optional[dict] = None
# Ant Design X prompts props: https://x.ant.design/components/prompts
class ChatbotDataSuggestionContentOptions(ChatbotPromptsConfig):
pass
# Ant Design X prompt props: https://x.ant.design/components/prompts#promptprops
class ChatbotDataSuggestionContentItem(ChatbotPromptConfig):
pass
class ChatbotDataMeta(GradioModel):
feedback: Optional[Literal['like', 'dislike', None]] = None
class ChatbotDataMessageContent(GradioModel):
"""
type: Content type, support 'text', 'tool', 'file', 'suggestion'.
content: Content value.
options: Content options, each content type has different options.
copyable: Whether the content can be copied via the 'copy' button.
editable: Whether the content can be edited via the 'edit' button. Only available for content type 'text' and 'tool'.
"""
type: Optional[Literal['text', 'tool', 'file', 'suggestion']] = 'text'
copyable: Optional[bool] = True
editable: Optional[bool] = True
content: Optional[Union[str, List[Union[FileData,
ChatbotDataSuggestionContentItem,
dict, str]]]] = None
options: Optional[Union[dict, ChatbotDataTextContentOptions,
ChatbotDataFileContentOptions,
ChatbotDataToolContentOptions,
ChatbotDataSuggestionContentOptions]] = None
class ChatbotDataMessage(ChatbotBotConfig):
role: Union[Literal['user', 'assistant', 'system'], str] = None
key: Optional[Union[str, int, float]] = None
# If status is 'pending', the message will not render the footer area (including 'actions' and 'footer').
status: Optional[Literal['pending', 'done']] = None
content: Optional[Union[str, ChatbotDataMessageContent, dict,
List[ChatbotDataMessageContent],
List[dict]]] = None
placement: Optional[Literal['start', 'end']] = None
actions: Optional[List[Union[Literal[
'copy',
'like',
'dislike',
'retry',
'edit',
'delete',
], ChatbotActionConfig, dict]]] = None
disabled_actions: Optional[List[Union[Literal[
'copy',
'like',
'dislike',
'retry',
'edit',
'delete',
]]]] = None
meta: Optional[Union[ChatbotDataMeta, dict]] = None
class ChatbotDataMessages(GradioRootModel):
root: List[ChatbotDataMessage]
```
|