Helpers
load_chat

New to Gradio? Start here: Getting Started

To install Gradio from main, run the following command:

pip install https://gradio-builds.s3.amazonaws.com/9dec325a1ca78ca3c2754e5f0bf2db47962bfedb/gradio-5.20.1-py3-none-any.whl

*Note: Setting share=True in launch() will not work.

←

load

→

load_chat

gradio.load_chat(···)

Description

Load a chat interface from an OpenAI API chat compatible endpoint.

Example Usage

import gradio as gr
demo = gr.load_chat("http://localhost:11434/v1", model="deepseek-r1")
demo.launch()

Initialization

🔗

base_url: str

The base URL of the endpoint, e.g. "http://localhost:11434/v1/"

🔗

model: str

The name of the model you are loading, e.g. "llama3.2"

🔗

token: str | None

default = None

The API token or a placeholder string if you are using a local model, e.g. "ollama"

🔗

file_types: Literal['text_encoded', 'image'] | list[Literal['text_encoded', 'image']] | None

default = "text_encoded"

The file types allowed to be uploaded by the user. "text_encoded" allows uploading any text-encoded file (which is simply appended to the prompt), and "image" adds image upload support. Set to None to disable file uploads.

🔗

system_message: str | None

default = None

The system message to use for the conversation, if any.

🔗

streaming: bool

default = True

Whether the response should be streamed.

🔗

kwargs: <class 'inspect._empty'>

Additional keyword arguments to pass into ChatInterface for customization.

←

load

→