a
pDfP~ @ s> d Z ddlmZ ddlZddlZddlmZ ddlmZm Z m
Z
m Z m Z m
Z
ddlmZ ddlmZmZmZmZmZmZmZ ddlZdd lmZ dd
lm Z dd l m Z m Z dd l m!Z! dd
l"m#Z# ddl$m%Z% ddl&m'Z' erddl(m)Z) ddl*m+Z+ ddl,m-Z- dZ.G dd deZ/G dd de0Z1G dd de Z2dS )z}
The feed module provides a high-level API for interacting
with a list of `ChatMessage` objects through the backend methods.
) annotationsN)Enum)
isasyncgenisasyncgenfunction isawaitableiscoroutinefunction isgeneratorisgeneratorfunction)BytesIO)
TYPE_CHECKINGAnyCallableClassVarDictListLiteral )Margin)CDN_DIST)Feed ListPanel)Card)VSpacer)SVG ) ChatMessage)Document)Model)Comma
c @ s e Zd ZdZdZdZdZdZdS )
CallbackStateZidleZrunningZ
generatingZstoppingstoppedN)__name__
__module__ __qualname__IDLERUNNING
GENERATINGSTOPPINGSTOPPED r) r) \/nfs/NAS7/SABIOD/METHODE/ermites/ermites_venv/lib/python3.9/site-packages/panel/chat/feed.pyr . s
r c @ s e Zd ZdS ) StopCallbackN)r! r" r# r) r) r) r* r+ 6 s r+ c sh e Zd ZU dZejddddZejdddZej d g d
d d Z
ej d
ddZ ej
i ddZejddddZejdddZej
i ddZejddZedddZejg ddZej dd dZej dd dZej
d i ddd d dZej d!dd"dZ ej d#dZ ejd$dd%dZ ejd&dd'dZ!ejdd(dZ"ejdd)dZ#ej$e%dd*d+Z&ej e'e(d,d-Z)ej*d.dZ+ejd/dZ,e- d0gZ.d1e/d2< fd3d4Z0dd6d7d7d8d9d:d;d<Z1d=d>d9d9d6d8d?d@dAdBZ2dd7d?dC fdDdE
Z3ej4dFdGdHddIdJdK Z5ej4dLddIdMdN Z6ej4dOdPdddQdRdS Z7ddTd?dUdVdWZ8ddXdYdZdTd[d\d]Z9dd^dTdTd_d`daZ:dbd^dUdcddZ;d^dTdedfdgZdodpdqdrZ?d?dsdtduZ@dvdw ZAddxdYdZdydTdzd{d|ZBdd}dYdZdTdydTd~ddZCdd ZDdydsddZEddiddddZFddsddZGddddYdddddZHddddddddZIdddZJ ZKS )ChatFeedu
A widget to display a list of `ChatMessage` objects and interact with them.
This widget provides methods to:
- Send (append) messages to the chat log.
- Stream tokens to the latest `ChatMessage` in the chat log.
- Execute callbacks when a user sends a message.
- Undo a number of sent `ChatMessage` objects.
- Clear the chat log of all `ChatMessage` objects.
Reference: https://panel.holoviz.org/reference/chat/ChatFeed.html
:Example:
>>> async def say_welcome(contents, user, instance):
>>> yield "Welcome!"
>>> yield "Glad you're here!"
>>> chat_feed = ChatFeed(callback=say_welcome, header="Welcome Feed")
>>> chat_feed.send("Hello World!", user="New User", avatar="😊")
)r Nz
Max pixel distance from the latest object in the Column to
activate automatic scrolling upon update. Setting to 0
disables auto-scrolling.)defaultZboundsdocFz
Callback to execute when a user sends a message or
when `respond` is called. The signature must include
the previous message value `contents`, the previous `user` name,
and the component `instance`.)
allow_refsr/ summary)raiser1 verboseignorea/
How to handle exceptions raised by the callback.
If "raise", the exception will be raised.
If "summary", a summary will be sent to the chat feed.
If "verbose", the full traceback will be sent to the chat feed.
If "ignore", the exception will be ignored.
)r. objectsr/ Z AssistantzO
The default user name to use for the message provided by the callback.)r. r/ zY
Params to pass to Card, like `header`, `header_background`, `header_color`, etc.Tz?
Whether the Card should be expandable and collapsible.)r. readonlyr/ z%
Whether the feed is disabled.z
Params to pass to each ChatMessage, like `reaction_icons`, `timestamp_format`,
`show_avatar`, `show_user`, and `show_timestamp`. Params passed
that are not ChatFeed params will be forwarded into `message_params`.zl
The header of the chat feed; commonly used for the title.
Can be a string, pane, or widget.)r/ z
Allows to create additional space around the component. May
be specified as a two-tuple of the form (vertical, horizontal)
or a four-tuple (top, right, bottom, left).z;
The list of child objects that make up the layout. a
If provided, initializes a chat message in the chat log
using the provided help text as the message object and
`help` as the user. This is useful for providing instructions,
and will not be included in the `serialize` method by default.z:
The text to display next to the placeholder icon. )userZreaction_iconsZshow_copy_iconZshow_timestampz
Params to pass to the placeholder ChatMessage, like `reaction_icons`,
`timestamp_format`, `show_avatar`, `show_user`, `show_timestamp`.
r z
Min duration in seconds of buffering before displaying the placeholder.
If 0, the placeholder will be disabled.a)
A callable or list of callables that accept the value and return a
Panel object to render the value. If a list is provided, will
attempt to use the first renderer that does not raise an
exception. If None, will attempt to infer the renderer
from the value.2 z
The number of objects loaded on each side of the visible objects.
When scrolled halfway into the buffer, the feed will automatically
load additional objects while unloading objects on the opposite side.d z
Min pixel distance from the latest object in the Column to
display the scroll button. Setting to 0
disables the scroll button.zj
Whether to show an activity dot on the ChatMessage while
streaming the callback response.zu
Whether to scroll to the latest object on init. If not
enabled the view will be on the first object.z~
The placeholder wrapped in a ChatMessage object;
primarily to prevent recursion error in _update_placeholder.)class_r0 r/ z+
The current state of the callback.)r5 r/ z!Triggers the callback to respond.z1
The previous disabled state of the feed.zcss/chat_feed.csszClassVar[List[str]] _stylesheetsc s d | _ |dr,t|d ts,|d g|d< |dd u rP|dd u rPd|d< |di }| D ]&}|| jvrd|tjv rd||||< qd||d< t j |i | | j
rt| j
ddg| j | _ t | jj
| jj| jj| jj| jj| jjd}t| j | j| j| j| jd g| jd
|| _d | j_| }| j| jj | jj d g }|j | jj | jj | jj!| jj| jj! j "d d
dg| jj# dg| jj$| jj%dgddi|d
| j }|d d | | | j&| jddd t'| jt( fi || _)| j*| j+d d S )N rendererswidth sizing_modeZ
stretch_widthmessage_paramsZHelp)r: )designrA r@ max_width min_widthvisiblez
chat-feed-log) load_bufferauto_scroll_limitscroll_button_threshold view_latest css_classes stylesheetsrL )Nr8 Fz chat-feedzchat-feed-headerzchat-feed-titlepaddingZ0px)
marginalignheaderheightZ hide_header collapsiblerK Zheader_css_classes
max_height
min_heightZtitle_css_classesZstylesrL r5 T)r5
bidirectional_callback_trigger),_callback_futureget
isinstancelistcopyparamr popsuper__init__ help_textr5 dictrC rA r@ rD rE rF r rG rH rI rJ r> _chat_logrQ rL rx card_paramsupdaterN rO rP Zin_rK rS rT linkr r _cardwatch_prepare_response) selfr5 paramsrB Z param_keyZ
linked_paramsrd Zcard_stylesheetsZcard_overrides __class__r) r* r_ s
zChatFeed.__init__Nr z Model | Nonez Comm | Noner )r/ rootparentcommreturnc C s2 | j ||||}|p|jd }||f| j|< |S )Nid)rg
_get_modelrefZ_models)rj r/ rn ro rp modelrt r) r) r* rs
s zChatFeed._get_modelz$Dict[str, param.parameterized.Event]zDict[str, Any]None)eventsmsgrn ru r/ rp rq c C s d S Nr) )rj rw rx rn ru r/ rp r) r) r*
_update_model s zChatFeed._update_model)rn rq c s | j | t | d S ry )rg _cleanupr^ )rj rn rl r) r* r{ s zChatFeed._cleanuprG rH rI )rh c C s" | j | j_ | j| j_| j| j_d S ry )rG rb rH rI rj r) r) r* _update_chat_log_params s
z ChatFeed._update_chat_log_paramsrd c C s. | j }|dd | jjjf i | d S )NrL )rd r[ r] rg r\ re )rj rd r) r) r* _update_card_params# s
z ChatFeed._update_card_paramsplaceholder_textplaceholder_params)rh Zon_initc C s6 t tddddgd}t| jf|dgd| j| _d S )Nfixed# zrotating-placeholder)rA r@ rQ rK message)avatarrK )r PLACEHOLDER_SVGr r r _placeholder)rj Zloading_avatarr) r) r* _update_placeholder) s z ChatFeed._update_placeholderzChatMessage | None)r rq c C sf t j| F |dur | | z| | j W n tyB Y n0 W d n1 sX0 Y dS )z
Replace the placeholder from the chat log with the message
if placeholder, otherwise simply append the message.
Replacing helps lessen the chat log jumping around.
N)r\
parameterizedbatch_call_watchersappendremover
ValueError)rj r r) r) r* _replace_placeholder6 s
z ChatFeed._replace_placeholderra z
str | Nonez str | bytes | BytesIO | None)valuer: r rq c C s d|v r d|v r t d|n.d|v r8|d|d< nd|vrNt d|t|fd| ji| j}|rr||d< |r~||d< | jrt| jd |d < tf i |}|S )
z6
Builds a ChatMessage from the value.
r objectz4Cannot pass both 'value' and 'object' together; got z[If 'value' is a dict, it must contain an 'object' key, e.g. {'object': 'Hello World'}; got r? r: r P r@ )r r] ra r? rB r@ intr )rj r r: r rB r r) r) r* _build_messageE s& zChatFeed._build_messager )r r rq c C s | j tjk}| jduo | j }|du r,dS |s4|r.safe_next)r r to_thread)rj r r r r) r r*
_to_async_gen s zChatFeed._to_async_genzasyncio.BaseEventLoop)loopc s | |}t| jr&| j| I d H }nLt| jr<| j| }n6t| jrX| | j| }ntj| jg|R I d H }| |I d H d S ry ) r r callbackr r r r r r )rj r r
callback_argsr r) r) r* _handle_callback s
zChatFeed._handle_callback)rq c
s | j du rdS | j| j zztj| d| _tj| _ W d n1 sR0 Y | j
d }t |t sW W |
I dH dS t| j
}t }|| ||}|| _t| |||I dH W n ty tj| _ Y n ty } ztddd}| jdkr*| jd|d fi | nZ| jd
krV| jd t d fi | n.| jd
krW Y d}~W |
I dH dS |W Y d}~n
d}~0 0 W |
I dH n|
I dH 0 dS )zi
Prepares the response by scheduling the placeholder and
executing the callback.
NT ExceptionF)r: respondr1 z
Encountered `z@`. Set `callback_exception='verbose'` to see the full traceback.r3 z
```python
z
```r4 ) r _disabled_stackr disabledr\ r r r r% r rb rY r _cleanup_responser r r Z create_taskr rW Zgatherr r+ r( r ra callback_exceptionsend traceback
format_exc)rj _r r r futuree send_kwargsr) r) r* ri sJ
&
zChatFeed._prepare_responsec sX t j| 8 | d tj| _| jr0| j nd| _ W d n1 sJ0 Y dS )zF
Events to always execute after the callback is done.
NF)
r\ r r r r r$ r r r] r r| r) r) r* r s
zChatFeed._cleanup_responsezChatMessage | dict | Anybool)r r: r r rq c C sd t |tr(|dus|dur"td|}n"t |ts:d|i}| j|||d}| | |r`| |S )a
Sends a value and creates a new message in the chat log.
If `respond` is `True`, additionally executes the callback, if provided.
Arguments
---------
value : ChatMessage | dict | Any
The message contents to send.
user : str | None
The user to send as; overrides the message message's user if provided.
avatar : str | bytes | BytesIO | None
The avatar to use; overrides the message message's avatar if provided.
respond : bool
Whether to execute the callback.
Returns
-------
The message that was created.
NzfCannot set user or avatar when explicitly sending a ChatMessage. Set them directly on the ChatMessage.r r )rY r r ra r r r )rj r r: r r r r) r) r* r s
z
ChatFeed.sendzstr | dict | ChatMessage)r r: r r replacerq c C s | j dur | j r tdt|tr@|dus6|dur@tdnJ|rt|ttfrv|j||d |rj||_ |r||_
n|j |||d |S t|tr|}n"t|tsd|i}| j |||d}|
| |S )a
Streams a token and updates the provided message, if provided.
Otherwise creates a new message in the chat log, so be sure the
returned message is passed back into the method, e.g.
`message = chat.stream(token, message=message)`.
This method is primarily for outputs that are not generators--
notably LangChain. For most cases, use the send method instead.
Arguments
---------
value : str | dict | ChatMessage
The new token value to stream.
user : str | None
The user to stream as; overrides the message's user if provided.
avatar : str | bytes | BytesIO | None
The avatar to use; overrides the message's avatar if provided.
message : ChatMessage | None
The message to update.
replace : bool
Whether to replace the existing text when streaming a string or dict.
Returns
-------
The message that was updated.
Nr zhCannot set user or avatar when explicitly streaming a ChatMessage. Set them directly on the ChatMessage.)r r r )rW r r+ rY r r strra streamr: r re r r )rj r r: r r r r) r) r* r K s, "
zChatFeed.streamc C s | j d dS )zP
Executes the callback with the latest message in the chat log.
rV N)r\ triggerr| r) r) r* r s zChatFeed.respondc C s\ | j du rd}n$| jtjkr*tj| _d}n
| j }|rX| jrH| j nd| _| d |S )z
Cancels the current callback task if possible.
Returns
-------
Whether the task was successfully stopped or done.
NFT)
rW r r r& r' cancelr r] r r )rj r r) r) r* stop s
z
ChatFeed.stopz List[Any])countrq c C s8 |dkr g S | j j}|| d }|d| | j _|S )a,
Removes the last `count` of messages from the chat log and returns them.
Parameters
----------
count : int
The number of messages to remove, starting from the last message.
Returns
-------
The messages that were removed.
r N)rb r5 )rj r messagesZundone_entriesr) r) r* undo s
z
ChatFeed.undoc C s | j j}| j |S )z
Clears the chat log and returns the messages that were cleared.
Returns
-------
The messages that were cleared.
)rb r5 clear)rj Zcleared_entriesr) r) r* r s
zChatFeed.clear assistantzList[ChatMessage]z!Dict[str, str | List[str]] | Noner
zList[Dict[str, Any]])r
role_names default_rolecustom_serializerrq c
C s |du rdg| j gd}i }| D ].\}}t|tr<|g}|D ]}||| < q@q$g } |D ]}
|
j } | |vr|std|
jd|d|| |}|r||
j} t| tstdt | dnt|
} |
|| d q\| S )
zA
Exports the chat log for use with transformers.
Nr: )r: r zUser z not found in role_names; got .zCThe provided custom_serializer must return a string; it returned a z type)rolecontent) r itemsrY r lowerr: r rX r typer )
rj r r r r Z
names_roler namesnameZserialized_messagesr Zlowercase_namer r) r) r* _serialize_for_transformers s>
z$ChatFeed._serialize_for_transformers transformerszList[str] | NonezCallable | NonezLiteral['transformers'])
exclude_users filter_byformatr c sx du rdg ndd D fddj jD }|durF||}|dkrdj|fd|i|S td|d dS )
a
Exports the chat log.
Arguments
---------
format : str
The format to export the chat log as; currently only
supports "transformers".
exclude_users : list(str) | None
A list of user (case insensitive names) to exclude from serialization.
If not provided, defaults to ["help"]. This will be executed before `filter_by`.
filter_by : callable
A function to filter the chat log by.
The function must accept and return a list of ChatMessage objects.
custom_serializer : callable
A custom function to format the ChatMessage's object. The function must
accept one positional argument, the ChatMessage object, and return a string.
If not provided, uses the serialize method on ChatMessage.
**serialize_kwargs
Additional keyword arguments to use for the specified format.
- format="transformers"
role_names : dict(str, str | list(str)) | None
A dictionary mapping the role to the ChatMessage's user name.
Defaults to `{"user": ["user"], "assistant": [self.callback_user]}`
if not set. The keys and values are case insensitive as the strings
will all be lowercased. The values can be a string or a list of strings,
e.g. `{"user": "user", "assistant": ["executor", "langchain"]}`.
default_role : str
The default role to use if the user name is not found in role_names.
If this is set to None, raises a ValueError if the user name is not found.
Returns
-------
The chat log serialized in the specified format.
Nhelpc S s g | ] }| qS r) )r ).0r: r) r) r*
( z&ChatFeed.serialize..c s( g | ] }|j vr|jur|qS r) )r: r r )r r r rj r) r* r * s
r r zFormat z is not supported.)rb r5 r NotImplementedError)rj r r r r Zserialize_kwargsr r) r r* serialize s" , zChatFeed.serializec C sT g }|du s:t |tr t | |s:t|rDt |tsD|| rD|| || j| S )a
Iterates over the ChatInterface and any potential children in the
applying the selector.
Arguments
---------
selector: type or callable or None
The selector allows selecting a subset of Viewables by
declaring a type or callable function to filter by.
Returns
-------
viewables: list(Viewable)
N)rY r callabler rg select)rj selectorselectedr) r) r* r 9 s
zChatFeed.select)NNN)N)N)NN)N)NNT)NNNF)r )Nr N)NNr N)N)Lr! r" r# __doc__r\ ZIntegerrH r
r ZObjectSelectorr Stringr r rd BooleanrR r rB ParameterrP r rN r r5 r` r r Numberr ZHookListr? rG rI r rJ Z
ClassSelectorr r rZ r r EventrV r r r> __annotations__r_ rs rz r{ dependsr} r~ r r r r r r r r r ri r r r r r r r r r r
__classcell__r) r) rl r* r, : s
M
+
- . > 4 @r, )3r
__future__r r r enumr inspectr r r r r r ior
typingr r r
r r r r r\ Z_paramr Z io.resourcesr Zlayoutr r Z layout.cardr Z
layout.spacerr Z
pane.imager r r Zbokeh.documentr Z bokeh.modelr Z pyviz_commsr r r r r+ r, r) r) r) r* s. $