Skip to content

@camera.ui/sdk / plugin / AssistantToolReference

Interface: AssistantToolReference ​

Defined in: plugin/assistant.ts:102

Something in the app a tool result points at. The chat renders it as a button that opens the matching view: the recording player for an event, the episode player for an episode, the camera page for a camera, or a download button for a file the download manager serves.

Properties ​

cameraId? ​

optional cameraId?: string

Defined in: plugin/assistant.ts:110

Camera the event belongs to, required for event.


id ​

id: string

Defined in: plugin/assistant.ts:106

Id of the event, episode or camera, or the download token.


kind ​

kind: "camera" | "event" | "episode" | "download"

Defined in: plugin/assistant.ts:104

What the id names.


label? ​

optional label?: string

Defined in: plugin/assistant.ts:108

Short label for the button, for example the camera name and time.


timestamp? ​

optional timestamp?: number

Defined in: plugin/assistant.ts:112

Start of the event or episode in milliseconds since the epoch, required for event.


url? ​

optional url?: string

Defined in: plugin/assistant.ts:114

Download path from the download manager, required for download; the chat shows a download button labelled with label.