@adonis-agora/agent
Version:
Governed, durable-backed AI agent (chat + tool-calling + governance) for AdonisJS — part of the Agora ecosystem.
41 lines • 2.69 kB
TypeScript
import type { DashboardSection, DashboardSpec } from './telescope-sdk.js';
/** Options for the agent "Agent" dashboard. */
export interface AgentDashboardOptions {
/**
* URL template for deep-linking a run row (a `LinkSpec.href` with `{key}` placeholders filled from the
* row, e.g. `/agent/runs/{runId}`). Applied to the `runId` column of every table below that carries one
* (the entry-backed runs/tool-calls/approvals/delegations tables, AND the governance-backed
* runs/tool-calls/approvals tables). Omit to render plain run ids with no link.
*/
runHref?: string;
/**
* URL template for deep-linking a thread, e.g. `/agent/threads/{thread}`. Applied to the entry-backed
* recent-runs table's `thread` column and the governance-backed tables' `threadId` column (two
* different keys — see `data-providers.ts` vs `agent-governance-providers.ts` for why the entry-backed
* table renames the field and the governance-backed ones don't).
*/
threadHref?: string;
/**
* HOST-contributed dashboard sections, appended after the built-in ones. Bind their panels to a
* provider passed via `agentTelescopeExtension({ providers })`, or to any built-in `agent.*`
* provider. Size each section's panel count to an exact multiple of its `cols` where practical — the
* renderer lays a section out as a fixed grid with no `colSpan`, so an orphan panel leaves a visible
* hole beside it. That's a layout nicety, not something validated here.
*/
sections?: DashboardSection[];
}
/**
* The "Agent" overview dashboard. Five ENTRY-BACKED sections (see `data-providers.ts`): run health,
* run activity, run latency & failures by code, tools & approvals, delegations & tokens. Then two
* GOVERNANCE-BACKED sections reading the authoritative, restart-surviving read-model (see
* `agent-governance-providers.ts` for exactly what that read-model can and can't answer on this SPI):
* spend/usage and run reliability + governance activity feeds. Then RAG (see `rag-data-providers.ts`
* for the honest, partial scope: retrieval counts/zero-hit-rate/mean-chunks/trend only — no latency,
* scores, or store/collection breakdown, because the recorded event doesn't carry them).
*
* Pure data: panels bind to the `agent.*` data providers by name; the `*Href` options add an optional
* `LinkSpec` on the id columns so a host agent SPA can deep-link a row. `opts.sections` appends
* host-contributed sections after the built-in ones (see `AgentDashboardOptions.sections`).
*/
export declare function agentDashboard(opts?: AgentDashboardOptions): DashboardSpec;
//# sourceMappingURL=dashboard.d.ts.map