value |
```python
list[
list[
str
| tuple[str]
| tuple[str | pathlib.Path, str]
| None
]
]
| Callable
| None
```
|
None |
Default value to show in chatbot. If callable, the function will be called whenever the app loads to set the initial value of the component. |
label |
```python
str | None
```
|
None |
The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to. |
every |
```python
float | None
```
|
None |
If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute. |
show_label |
```python
bool | None
```
|
None |
if True, will display label. |
container |
```python
bool
```
|
True |
If True, will place the component in a container - providing some extra padding around the border. |
scale |
```python
int | None
```
|
None |
relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer. |
min_width |
```python
int
```
|
160 |
minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first. |
visible |
```python
bool
```
|
True |
If False, component will be hidden. |
elem_id |
```python
str | None
```
|
None |
An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles. |
elem_classes |
```python
list[str] | str | None
```
|
None |
An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles. |
render |
```python
bool
```
|
True |
If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later. |
height |
```python
int | None
```
|
None |
height of the component in pixels. |
latex_delimiters |
```python
list[dict[str, str | bool]] | None
```
|
None |
A list of dicts of the form {"left": open delimiter (str), "right": close delimiter (str), "display": whether to display in newline (bool)} that will be used to render LaTeX expressions. If not provided, `latex_delimiters` is set to `[{ "left": "$$", "right": "$$", "display": True }]`, so only expressions enclosed in $$ delimiters will be rendered as LaTeX, and in a new line. Pass in an empty list to disable LaTeX rendering. For more information, see the [KaTeX documentation](https://katex.org/docs/autorender.html). |
rtl |
```python
bool
```
|
False |
If True, sets the direction of the rendered text to right-to-left. Default is False, which renders text left-to-right. |
show_share_button |
```python
bool | None
```
|
None |
If True, will show a share icon in the corner of the component that allows user to share outputs to Hugging Face Spaces Discussions. If False, icon does not appear. If set to None (default behavior), then the icon appears if this Gradio app is launched on Spaces, but not otherwise. |
show_copy_button |
```python
bool
```
|
False |
If True, will show a copy button for each chatbot message. |
avatar_images |
```python
tuple[
str | pathlib.Path | None, str | pathlib.Path | None
]
| None
```
|
None |
Tuple of two avatar image paths or URLs for user and bot (in that order). Pass None for either the user or bot image to skip. Must be within the working directory of the Gradio app or an external URL. |
sanitize_html |
```python
bool
```
|
True |
If False, will disable HTML sanitization for chatbot messages. This is not recommended, as it can lead to security vulnerabilities. |
render_markdown |
```python
bool
```
|
True |
If False, will disable Markdown rendering for chatbot messages. |
bubble_full_width |
```python
bool
```
|
True |
If False, the chat bubble will fit to the content of the message. If True (default), the chat bubble will be the full width of the component. |
line_breaks |
```python
bool
```
|
True |
If True (default), will enable Github-flavored Markdown line breaks in chatbot messages. If False, single new lines will be ignored. Only applies if `render_markdown` is True. |
likeable |
```python
bool
```
|
False |
Whether the chat messages display a like or dislike button. Set automatically by the .like method but has to be present in the signature for it to show up in the config. |
layout |
```python
"panel" | "bubble" | None
```
|
None |
If "panel", will display the chatbot in a llm style layout. If "bubble", will display the chatbot with message bubbles, with the user and bot messages on alterating sides. Will default to "bubble". |
Display text and media files (audio, video, images) in the same chat message bubble.
## Installation
```bash
pip install gradio_multimodalchatbot
```
## Usage
```python
import gradio as gr
from gradio_multimodalchatbot import MultimodalChatbot
from gradio.data_classes import FileData
user_msg1 = {"text": "Hello, what is in this image?",
"files": [{"file": FileData(path="https://gradio-builds.s3.amazonaws.com/diffusion_image/cute_dog.jpg")}]
}
bot_msg1 = {"text": "It is a very cute dog",
"files": []}
user_msg2 = {"text": "Describe this audio clip please.",
"files": [{"file": FileData(path="cantina.wav")}]}
bot_msg2 = {"text": "It is the cantina song from Star Wars",
"files": []}
user_msg3 = {"text": "Give me a video clip please.",
"files": []}
bot_msg3 = {"text": "Here is a video clip of the world",
"files": [{"file": FileData(path="world.mp4")},
{"file": FileData(path="cantina.wav")}]}
conversation = [[user_msg1, bot_msg1], [user_msg2, bot_msg2], [user_msg3, bot_msg3]]
with gr.Blocks() as demo:
MultimodalChatbot(value=conversation, height=800)
if __name__ == "__main__":
demo.launch()
```
## `MultimodalChatbot`
### Initialization