ExplorerUI#

class lumen.ai.ui.ExplorerUI(data: str | Path | Source | Pipeline | list[str | Path | Source | Pipeline] | None = None, **params)#

ExplorerUI provides a high-level entrypoint to start chatting with your data in split UI allowing users to load tables, explore them using Graphic Walker, and then interrogate the data via a chat interface.

This high-level wrapper allows providing the data sources you will be chatting with and then configures the assistant and agents.

Example:

import lumen.ai as lmai

lmai.ExplorerUI(data='~/data.csv').servable()

Parameters#

chat_ui_position

type: Any
default: 'left'
Possible values: 'left' | 'right'
The position of the chat interface panel relative to the exploration area.


Methods#

ExplorerUI.servable(title: str | None = None, **kwargs)#

Serves the object or adds it to the configured pn.state.template if in a panel serve context, writes to the DOM if in a pyodide context and returns the Panel object to allow it to display itself in a notebook context.

Parameters:
  • title (str) – A string title to give the Document (if served as an app)

  • location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

  • area (str (deprecated)) – The area of a template to add the component too. Only has an effect if pn.config.template has been set.

  • target (str) – Target area to write to. If a template has been configured on pn.config.template this refers to the target area in the template while in pyodide this refers to the ID of the DOM node to write to.

Return type:

The Panel object itself

ExplorerUI.show(**kwargs)#

Starts a Bokeh server and displays the Viewable in a new tab.

Parameters:
  • title (str | None) – A string title to give the Document (if served as an app)

  • port (int (optional, default=0)) – Allows specifying a specific port

  • address (str) – The address the server should listen on for HTTP requests.

  • websocket_origin (str or list(str) (optional)) – A list of hosts that can connect to the websocket. This is typically required when embedding a server app in an external web site. If None, “localhost” is used.

  • threaded (boolean (optional, default=False)) – Whether to launch the Server on a separate thread, allowing interactive use.

  • verbose (boolean (optional, default=True)) – Whether to print the address and port

  • open (boolean (optional, default=True)) – Whether to open the server in a new browser tab

  • location (boolean or panel.io.location.Location) – Whether to create a Location component to observe and set the URL location.

Returns:

server – Returns the Bokeh server instance or the thread the server was launched on (if threaded=True)

Return type:

bokeh.server.Server or panel.io.server.StoppableThread