o hT[@sddlmZddlmZmZmZddlmZddlm Z ddl m Z m Z m Z mZmZddlmZmZddlmZddlmZmZdd lmZdd lmZmZmZdd lmZdd l m!Z!m"Z"m#Z#m$Z$m%Z%dd l&m'Z'ddl(m)Z*ddl+m,Z-ddl.m/Z0ddl.m1Z2ddl3m4Z4ddl5m6Z6ddl7m8Z8ddl9m:Z:m;Z;mm?Z?m@Z@ddlAmBZBmCZCe rddlDmEZEeGdddeeFe fZ/GdddeFe ZGd/d#d$ZHd0d(d)ZIeGd*d+d+ZJGd,d-d-ZKd.S)1) annotations)IteratorMutableMappingSequence) dataclass)Enum) TYPE_CHECKINGAnyLiteralcastoverload)configruntime)get_dg_singleton_instance)enforce_filename_restrictionnormalize_upload_file_type) is_in_form) AtomicImage WidthBehavior image_to_url)check_widget_policies)Keycompute_and_register_element_id&get_chat_input_accept_file_proto_valuesave_for_app_testingto_key)StreamlitAPIException)Block) ChatInput)ChatInputValue)FileUploaderState) RootContainer)gather_metrics)get_script_run_ctx) WidgetArgsWidgetCallback WidgetKwargsregister_widget) DeletedFile UploadedFile)is_emojivalidate_material_icon)DeltaGeneratorc@sZeZdZUded<ded<dddZdd d ZdddZdddZd ddZd!ddZ dS)"rstrtextlist[UploadedFile]filesreturnintcC tt|SN)lenvarsselfr9S/var/www/vscode/kcb/lib/python3.10/site-packages/streamlit/elements/widgets/chat.py__len__F zChatInputValue.__len__ Iterator[str]cCr3r4)iterr6r7r9r9r:__iter__Ir<zChatInputValue.__iter__itemstr | list[UploadedFile]cCs,zt||WStytd|dwNz Invalid key: )getattrAttributeErrorKeyError)r8r@r9r9r: __getitem__Ls   zChatInputValue.__getitem__keyvaluer NonecCst|||dSr4)setattr)r8rGrHr9r9r: __setitem__RszChatInputValue.__setitem__cCs0zt||WdStytd|dwrB)delattrrDrE)r8rGr9r9r: __delitem__Us  zChatInputValue.__delitem__#dict[str, str | list[UploadedFile]]cCst|Sr4)r6r7r9r9r:to_dict[szChatInputValue.to_dictN)r1r2)r1r=)r@r-r1rA)rGr-rHr r1rI)rGr-r1rI)r1rN) __name__ __module__ __qualname____annotations__r;r?rFrKrMrOr9r9r9r:rAs      rc@seZdZdZdZdZdZdS) PresetNamesuser assistantaihumanN)rPrQrRUSER ASSISTANTAIHUMANr9r9r9r:rT_s rTavatarstr | AtomicImage | None delta_pathr-r17tuple[BlockProto.ChatMessage.AvatarType.ValueType, str]c Cstjj}|dur |jdfSt|tr+|ddtDvr+|j|tjtjfvr(dfSdfSt|tr9t |r9|j |fSt|trJ| drJ|jt |fSz|j t|tjdd d |d fWStyj}ztd |d}~ww) aDetects the avatar type and prepares the avatar data for the frontend. Parameters ---------- avatar : The avatar that was provided by the user. delta_path : str The delta path is used as media ID when a local image is served via the media file manager. Returns ------- Tuple[AvatarType, str] The detected avatar type and the prepared avatar data. NcSh|]}|jqSr9rH.0r@r9r9r: |z(_process_avatar_input..rVrUz :materialFRGBauto)widthclampchannels output_formatimage_idz5Failed to load the provided avatar value as an image.) BlockProto ChatMessage AvatarTypeICON isinstancer-rTr[rZr*EMOJI startswithr+IMAGErrORIGINAL Exceptionr)r]r_rqexr9r9r:_process_avatar_inputfs>   rz files_valueFileUploaderStateProto | Noner/c Cs|durgSt}|durgS|j}t|dkrgS|jj|jdd|Dd}dd|D}g}|D]'}||j}|durZt||j }| |t |jdrZ|jj |j|jdq3|S) NrcSsg|]}|jqSr9file_idrefr9r9r: rgz%_pop_upload_files..) session_idfile_idscSsi|]}|j|qSr9r}rr9r9r: sz%_pop_upload_files.. remove_file)rr~) r#uploaded_file_infor5uploaded_file_mgr get_filesrgetr~r) file_urlsappendhasattrr) r{ctxrfile_recs_list file_recscollected_filesrmaybe_file_rec uploaded_filer9r9r:_pop_upload_filess4      rc@s>eZdZUdZded<dZded< ddddZdddZdS)ChatInputSerdeFbool accept_filesNzSequence[str] | None allowed_typesraui_valueChatInputValueProto | None widget_idr-r1str | ChatInputValue | NonecCsb|dus |ds dS|js|jSt|j}|D]}|jr)t|ts)t|j |jqt |j|dS)Ndata)r.r0) HasFieldrrrfile_uploader_staterrsr(rnamer)r8rruploaded_filesfiler9r9r: deserializes zChatInputSerde.deserializev str | NoneChatInputValueProtocCs t|dS)N)r)r)r8rr9r9r: serializes zChatInputSerde.serialize)ra)rrrr-r1r)rrr1r)rPrQrRrrSrrrr9r9r9r:rs   rc @seZdZedddd.d d Ze d/ddd dd ddddd0d"d#Ze d/dddd dddd$d1d'd#Zed( d/ddd dd ddddd2d+d#Zed3d,d-ZdS)4 ChatMixin chat_messageN)r]r1Literal['user', 'assistant', 'ai', 'human'] | strr]7Literal['user', 'assistant'] | str | AtomicImage | Noner1r,cCs|durtd|dur|ddtDvst|r|}t||j\}}t}||_ ||_ ||_ t}d|_ |j ||jj|dS)u Insert a chat message container. To add elements to the returned container, you can use ``with`` notation (preferred) or just call methods directly on the returned object. See the examples below. Parameters ---------- name : "user", "assistant", "ai", "human", or str The name of the message author. Can be "human"/"user" or "ai"/"assistant" to enable preset styling and avatars. Currently, the name is not shown in the UI but is only set as an accessibility label. For accessibility reasons, you should not use an empty string. avatar : Anything supported by st.image (except list), str, or None The avatar shown next to the message. If ``avatar`` is ``None`` (default), the icon will be determined from ``name`` as follows: - If ``name`` is ``"user"`` or ``"human"``, the message will have a default user icon. - If ``name`` is ``"ai"`` or ``"assistant"``, the message will have a default bot icon. - For all other values of ``name``, the message will show the first letter of the name. In addition to the types supported by |st.image|_ (except list), the following strings are valid: - A single-character emoji. For example, you can set ``avatar="🧑‍💻"`` or ``avatar="🦖"``. Emoji short codes are not supported. - An icon from the Material Symbols library (rounded style) in the format ``":material/icon_name:"`` where "icon_name" is the name of the icon in snake case. For example, ``icon=":material/thumb_up:"`` will display the Thumb Up icon. Find additional icons in the `Material Symbols `_ font library. .. |st.image| replace:: ``st.image`` .. _st.image: https://docs.streamlit.io/develop/api-reference/media/st.image Returns ------- Container A single container that can hold multiple elements. Examples -------- You can use ``with`` notation to insert any element into an expander >>> import streamlit as st >>> import numpy as np >>> >>> with st.chat_message("user"): ... st.write("Hello 👋") ... st.line_chart(np.random.randn(30, 3)) .. output :: https://doc-chat-message-user.streamlit.app/ height: 450px Or you can just call methods directly in the returned objects: >>> import streamlit as st >>> import numpy as np >>> >>> message = st.chat_message("assistant") >>> message.write("Hello human") >>> message.bar_chart(np.random.randn(30, 3)) .. output :: https://doc-chat-message-user1.streamlit.app/ height: 450px NzWThe author name is required for a chat message, please set it via the parameter `name`.cSrbr9rcrdr9r9r:rf?rgz)ChatMixin.chat_message..T) block_proto)rlowerrTr*rzdg_get_delta_path_strrorprr] avatar_type allow_emptyrCopyFrom_block)r8rr]rconverted_avatarmessage_container_protorr9r9r:rs$Z  zChatMixin.chat_message Your messageF)rG max_chars accept_file file_typedisabled on_submitargskwargs placeholderr-rG Key | Noner int | NonerLiteral[False]rstr | Sequence[str] | NonerrrWidgetCallback | NonerWidgetArgs | NonerWidgetKwargs | Nonerc CdSr4r9 r8rrGrrrrrrrr9r9r: chat_inputQ zChatMixin.chat_input)rGrrrrrrLiteral[True, 'multiple']ChatInputValue | Nonec Crr4r9rr9r9r:r`rrbool | Literal['multiple']rc Csd} t|}t|j||| dd|dvrtdt} td|d||||d} |r,t|}tr9t |jr9td t |jj j } |jj j tjkrM| sMd }nd }t}| |_t||_|dura||_| |_t||_|duro|ng|jdd<td |_tt||d }t|j||| |j|j | dd}||_!|j"r|j#dur|j#|_#d|_$| rt%| | |j#|d krt&j'(d|n|j(d||j"s|j#SdS)aDisplay a chat input widget. Parameters ---------- placeholder : str A placeholder text shown when the chat input is empty. This defaults to ``"Your message"``. For accessibility reasons, you should not use an empty string. key : str or int An optional string or integer to use as the unique key for the widget. If this is omitted, a key will be generated for the widget based on its content. No two widgets may have the same key. max_chars : int or None The maximum number of characters that can be entered. If this is ``None`` (default), there will be no maximum. accept_file : bool or str Whether the chat input should accept files. This can be one of the following values: - ``False`` (default): No files are accepted and the user can only submit a message. - ``True``: The user can add a single file to their submission. - ``"multiple"``: The user can add multiple files to their submission. When the widget is configured to accept files, the accepted file types can be configured with the ``file_type`` parameter. By default, uploaded files are limited to 200 MB each. You can configure this using the ``server.maxUploadSize`` config option. For more information on how to set config options, see |config.toml|_. .. |config.toml| replace:: ``config.toml`` .. _config.toml: https://docs.streamlit.io/develop/api-reference/configuration/config.toml file_type : str, Sequence[str], or None The allowed file extension(s) for uploaded files. This can be one of the following types: - ``None`` (default): All file extensions are allowed. - A string: A single file extension is allowed. For example, to only accept CSV files, use ``"csv"``. - A sequence of strings: Multiple file extensions are allowed. For example, to only accept JPG/JPEG and PNG files, use ``["jpg", "jpeg", "png"]``. disabled : bool Whether the chat input should be disabled. This defaults to ``False``. on_submit : callable An optional callback invoked when the chat input's value is submitted. args : tuple An optional tuple of args to pass to the callback. kwargs : dict An optional dict of kwargs to pass to the callback. Returns ------- None, str, or dict-like The user's submission. This is one of the following types: - ``None``: If the user didn't submit a message or file in the last rerun, the widget returns ``None``. - A string: When the widget is not configured to accept files and the user submitted a message in the last rerun, the widget returns the user's message as a string. - A dict-like object: When the widget is configured to accept files and the user submitted a message and/or file(s) in the last rerun, the widget returns a dict-like object with two attributes, ``text`` and ``files``. When the widget is configured to accept files and the user submits something in the last rerun, you can access the user's submission with key or attribute notation from the dict-like object. This is shown in Example 3 below. The ``text`` attribute holds a string, which is the user's message. This is an empty string if the user only submitted one or more files. The ``files`` attribute holds a list of UploadedFile objects. The list is empty if the user only submitted a message. Unlike ``st.file_uploader``, this attribute always returns a list, even when the widget is configured to accept only one file at a time. The UploadedFile class is a subclass of BytesIO, and therefore is "file-like". This means you can pass an instance of it anywhere a file is expected. Examples -------- **Example 1: Pin the the chat input widget to the bottom of your app** When ``st.chat_input`` is used in the main body of an app, it will be pinned to the bottom of the page. >>> import streamlit as st >>> >>> prompt = st.chat_input("Say something") >>> if prompt: ... st.write(f"User has sent the following prompt: {prompt}") .. output :: https://doc-chat-input.streamlit.app/ height: 350px **Example 2: Use the chat input widget inline** The chat input can also be used inline by nesting it inside any layout container (container, columns, tabs, sidebar, etc) or fragment. Create chat interfaces embedded next to other content, or have multiple chatbots! >>> import streamlit as st >>> >>> with st.sidebar: >>> messages = st.container(height=300) >>> if prompt := st.chat_input("Say something"): >>> messages.chat_message("user").write(prompt) >>> messages.chat_message("assistant").write(f"Echo: {prompt}") .. output :: https://doc-chat-input-inline.streamlit.app/ height: 350px **Example 3: Let users upload files** When you configure your chat input widget to allow file attachments, it will return a dict-like object when the user sends a submission. You can access the user's message through the ``text`` attribute of this dictionary. You can access a list of the user's submitted file(s) through the ``files`` attribute. Similar to ``st.session_state``, you can use key or attribute notation. >>> import streamlit as st >>> >>> prompt = st.chat_input( >>> "Say something and/or attach an image", >>> accept_file=True, >>> file_type=["jpg", "jpeg", "png"], >>> ) >>> if prompt and prompt.text: >>> st.markdown(prompt.text) >>> if prompt and prompt["files"]: >>> st.image(prompt["files"][0]) .. output :: https://doc-chat-input-file-uploader.streamlit.app/ height: 350px raF) default_valuewrites_allowed>FTmultiplezsB                 5&