Skip to main content

DataReportConfig

@gravity-rail/sdk

@gravity-rail/sdk / DataReportConfig

Interface: DataReportConfig

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)

includeInPrompt?​

optional includeInPrompt: boolean

Run the report when the Agent's prompt is built and put the result in the prompt. Every parameter needs a default. At most 5 reports of one ability may set it.

name​

name: string

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

parameters?​

optional parameters: DataReportParameterConfig[]

Values the model may supply (up to 8)

query​

query: Record<string, unknown>

Query IR without entity and dataType: any of where, select, sort, limit, aggregate. { "param": "<name>" } marks where a parameter value goes.