API Reference

Main functions

The main agent constructor, plus the building blocks for a commons agent.

Commons: A trustworthy agent that answers questions about its data.
data_source(): Create a data source from an engine, a pins board, or named frames.
semantic_layer(): Collect measures into a semantic layer.
measure(): Mark a function as a measure.
context_layer(): Create a context layer from text or Markdown files.

Methods for the Commons class

Commons.__repr__()
Commons.__deepcopy__()
Commons.chat(): Ask a question and wait for the whole answer.
Commons.stream_async(): Ask a question and stream the answer as it arrives.
Commons.chat_async()
Commons.stream()
Commons.chat_structured()
Commons.chat_structured_async()
Commons.extract_data()
Commons.extract_data_async()
Commons.to_solver()
Commons.citation_corpus(): The trusted text this agent’s citations are verified against.
Commons.prewarm(): Build the caches the first question would otherwise pay for.
Commons.add_turn(): Add a turn, restarting the citation request if a person spoke.
Commons.set_turns(): Replace the conversation, dropping any reminder queued for it.
Commons.queue_restore_reminder(): Tell the next turn that the session behind its history is gone.

The objects the constructors return, and the values they carry.

DataSource: Tables an agent can query, and the dictionary that describes them.
SemanticLayer: The trusted calculations an agent can run.
ContextLayer: Text that helps an agent interpret its data source.
Measure: A trusted calculation the agent can run.
Injected
Tag: How an answer was produced.
list_tables(): The table names an agent can query on source.

Methods for the DataSource class

DataSource.from_frames(): Load named data frames into a locked-down in-process DuckDB.
DataSource.from_engine(): Query a caller’s database directly. Nothing is copied.
DataSource.from_board(): Expose a pins board’s pins as tables, each read on first use.
DataSource.query(): Run one read-only statement, rejecting anything else first.
DataSource.ensure_loaded(): Read every pin this source has not read yet.
DataSource.dialect(): A hint for the system prompt, not a contract.

Put a commons agent inside of an interactive chat app. Needs the shiny extra.

ui.app(): Build a complete app around a commons agent.
ui.server(): Wire a commons agent to the chat element id on the page.
ui.theme(): Build the theme a commons chat page uses.
ui.commons_chat_dependency(): The dependency serving the chat script, stylesheet and icons.
ui.asset_base_url(): The URL the assets are served under on a page.