;3hdZddlmZddlZddlZddlZddlZddlZddlZddl m Z m Z m Z m Z ddlmZddlmZmZmZmZddlZddlmZddlmZdd lmZdd lmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'dd l(m)Z)m*Z*m+Z+m,Z,m-Z-dd l.m/Z/m0Z0dd l1m2Z2ddl3m4Z4m5Z5m6Z6ddl7m8Z8ddl9m:Z;ddl9mm?Z?ddl@mAZAmBZBmCZCmDZDddlEmFZFddlGmHZIeGddeZJy)z\ This file defines a useful high-level abstraction to build Gradio chatbots: ChatInterface. ) annotationsN)AsyncGeneratorCallable GeneratorSequence)Path)AnyLiteralUnioncast)document)utils)Blocks) JSON BrowserStateButtonChatbot ComponentDatasetMarkdownMultimodalTextboxStateTextboxget_component_instance) ChatMessageExampleMessageMessage MessageDict TupleFormat)MultimodalPostprocessMultimodalValue)get_blocks_context) DependencyEditData SelectData) ChatCSVLogger)create_examples) special_argsupdate)I18nData) AccordionColumnGroupRow)Request) ThemeClassc&eZdZdZdddddddddddddddddddddddddddddddddddd dd % d*fd Zd Zd Z d+dZdZ d, d-dZ d.dZ e d/dZ d0dZ d1dZdZ d2dZd3dZ d4dZ d5dZe d6dZe d7dZ d8 d9dZ d:dZ d;dZ dd!Zd>d"Z d?d#Z d@d$Z dAd%Z dBd&Z dCd'Z! dDd(Z"dEfd) Z#xZ$S)F ChatInterfaceaA ChatInterface is Gradio's high-level abstraction for creating chatbot UIs, and allows you to create a web-based demo around a chatbot model in a few lines of code. Only one parameter is required: fn, which takes a function that governs the response of the chatbot based on the user input and chat history. Additional parameters can be used to control the appearance and behavior of the demo. Example: import gradio as gr def echo(message, history): return message demo = gr.ChatInterface(fn=echo, type="messages", examples=[{"text": "hello", "text": "hola", "text": "merhaba"}], title="Echo Bot") demo.launch() Demos: chatinterface_random_response, chatinterface_streaming_echo, chatinterface_artifacts Guides: creating-a-chatbot-fast, sharing-your-app FNT)LikeDislikez.gradio/flaggeddefaultminimalchat)% multimodaltypechatbottextboxadditional_inputsadditional_inputs_accordionadditional_outputseditableexamplesexample_labels example_iconsrun_examples_on_clickcache_examples cache_modetitle descriptiontheme flagging_modeflagging_options flagging_dircss css_pathsjshead head_pathsanalytics_enabled autofocus autoscroll submit_btnstop_btnconcurrency_limit delete_cache show_progress fill_height fill_widthapi_name save_historyc% t+||d|xsd|||||||#|$|! |%|_||_||_| |_t |tr|j|_n||_tj|jxstj|j|_ tj|jxstj|j|_|du|_| |_|j#| | | |_| |_||_||_| |_|#|_||_||_||_||_|"|_|&r|dk(s t;d|&|_t?j@|D'cgc] }'tC|'c}'|_"t?j@||_#| ddd |_$npt |tJr d |i|_$nVt |tLr%|jO|jQ|_$n!t;d tSj|d|_*|jDrj|j ^|j D]O}(t |(tVs t;d tY|(D]\})}*|* |)d kDsd|_*n|jTsOn|t[j\dd}|dvr||_/n t;d||_0||_1t |tdtffr|jit |tjr|ji|5tmgd|jn|_8tsd|_:ts|_;ts|_<t{5|j}|j<r_td5|jt{d5|j|||||jddddddn$|j|||||jddd|jdddycc}'w#1swY\xYw#1swY;xYw#1swY?xYw#1swYyxYw)a( Parameters: fn: the function to wrap the chat interface around. Normally (assuming `type` is set to "messages"), the function should accept two parameters: a `str` representing the input message and `list` of openai-style dictionaries: {"role": "user" | "assistant", "content": `str` | {"path": `str`} | `gr.Component`} representing the chat history. The function should return/yield a `str` (for a simple message), a supported Gradio component (e.g. gr.Image to return an image), a `dict` (for a complete openai-style message response), or a `list` of such messages. multimodal: if True, the chat interface will use a `gr.MultimodalTextbox` component for the input, which allows for the uploading of multimedia files. If False, the chat interface will use a gr.Textbox component for the input. If this is True, the first argument of `fn` should accept not a `str` message but a `dict` message with keys "text" and "files" type: The format of the messages passed into the chat history parameter of `fn`. If "messages", passes the history as a list of dictionaries with openai-style "role" and "content" keys. The "content" key's value should be one of the following - (1) strings in valid Markdown (2) a dictionary with a "path" key and value corresponding to the file to display or (3) an instance of a Gradio component: at the moment gr.Image, gr.Plot, gr.Video, gr.Gallery, gr.Audio, and gr.HTML are supported. The "role" key should be one of 'user' or 'assistant'. Any other roles will not be displayed in the output. If this parameter is 'tuples' (deprecated), passes the chat history as a `list[list[str | None | tuple]]`, i.e. a list of lists. The inner list should have 2 elements: the user message and the response message. chatbot: an instance of the gr.Chatbot component to use for the chat interface, if you would like to customize the chatbot properties. If not provided, a default gr.Chatbot component will be created. textbox: an instance of the gr.Textbox or gr.MultimodalTextbox component to use for the chat interface, if you would like to customize the textbox properties. If not provided, a default gr.Textbox or gr.MultimodalTextbox component will be created. editable: if True, users can edit past messages to regenerate responses. additional_inputs: an instance or list of instances of gradio components (or their string shortcuts) to use as additional inputs to the chatbot. If the components are not already rendered in a surrounding Blocks, then the components will be displayed under the chatbot, in an accordion. The values of these components will be passed into `fn` as arguments in order after the chat history. additional_inputs_accordion: if a string is provided, this is the label of the `gr.Accordion` to use to contain additional inputs. A `gr.Accordion` object can be provided as well to configure other properties of the container holding the additional inputs. Defaults to a `gr.Accordion(label="Additional Inputs", open=False)`. This parameter is only used if `additional_inputs` is provided. additional_outputs: an instance or list of instances of gradio components to use as additional outputs from the chat function. These must be components that are already defined in the same Blocks scope. If provided, the chat function should return additional values for these components. See $demo/chatinterface_artifacts. examples: sample inputs for the function; if provided, appear within the chatbot and can be clicked to populate the chatbot input. Should be a list of strings representing text-only examples, or a list of dictionaries (with keys `text` and `files`) representing multimodal examples. If `additional_inputs` are provided, the examples must be a list of lists, where the first element of each inner list is the string or dictionary example message and the remaining elements are the example values for the additional inputs -- in this case, the examples will appear under the chatbot. example_labels: labels for the examples, to be displayed instead of the examples themselves. If provided, should be a list of strings with the same length as the examples list. Only applies when examples are displayed within the chatbot (i.e. when `additional_inputs` is not provided). example_icons: icons for the examples, to be displayed above the examples. If provided, should be a list of string URLs or local paths with the same length as the examples list. Only applies when examples are displayed within the chatbot (i.e. when `additional_inputs` is not provided). cache_examples: if True, caches examples in the server for fast runtime in examples. The default option in HuggingFace Spaces is True. The default option elsewhere is False. cache_mode: if "eager", all examples are cached at app launch. If "lazy", examples are cached for all users after the first use by any user of the app. If None, will use the GRADIO_CACHE_MODE environment variable if defined, or default to "eager". run_examples_on_click: if True, clicking on an example will run the example through the chatbot fn and the response will be displayed in the chatbot. If False, clicking on an example will only populate the chatbot input with the example message. Has no effect if `cache_examples` is True title: a title for the interface; if provided, appears above chatbot in large font. Also used as the tab title when opened in a browser window. description: a description for the interface; if provided, appears above the chatbot and beneath the title in regular font. Accepts Markdown and HTML content. theme: a Theme object or a string representing a theme. If a string, will look for a built-in theme with that name (e.g. "soft" or "default"), or will attempt to load a theme from the Hugging Face Hub (e.g. "gradio/monochrome"). If None, will use the Default theme. flagging_mode: one of "never", "manual". If "never", users will not see a button to flag an input and output. If "manual", users will see a button to flag. flagging_options: a list of strings representing the options that users can choose from when flagging a message. Defaults to ["Like", "Dislike"]. These two case-sensitive strings will render as "thumbs up" and "thumbs down" icon respectively next to each bot message, but any other strings appear under a separate flag icon. flagging_dir: path to the the directory where flagged data is stored. If the directory does not exist, it will be created. css: Custom css as a code string. This css will be included in the demo webpage. css_paths: Custom css as a pathlib.Path to a css file or a list of such paths. This css files will be read, concatenated, and included in the demo webpage. If the `css` parameter is also set, the css from `css` will be included first. js: Custom js as a code string. The custom js should be in the form of a single js function. This function will automatically be executed when the page loads. For more flexibility, use the head parameter to insert js inside