Skip to main content

CannedReportParams

@gravity-rail/sdk

@gravity-rail/sdk / CannedReportParams

Interface: CannedReportParams

A named report: a fixed query over one Form, with typed parameters.

Properties​

dataTypeUuid​

dataTypeUuid: string

UUID of the Form the report reads

description​

description: string

What the report answers, for the model (up to 300 characters)

Min Length​

1

Max Length​

300

includeInPrompt?​

optional includeInPrompt: boolean

Run the report each time the Agent's prompt is built and put the result in the prompt, so the Agent can answer without a tool call. Every parameter needs a default. Up to 5 reports may set this.

name​

name: string

Report name: lowercase letters, digits and underscores, up to 40 characters

Pattern​

^[a-z][a-z0-9_]{0,39}$

parameters?​

optional parameters: ReportParameterParams[]

Values the model may supply (up to 8)

Max Items​

8

query​

query: CannedReportParamsQuery

Query IR for the report without 'entity' and 'dataType': any of 'where', 'select', 'sort', 'limit', 'aggregate'. Use {"param": ""} where a parameter value goes: as a compare 'value', inside a value object (for example daysAgo 'days'), or as 'limit'.