Elements runtime reference / AI and delivery

`askDashbot`

Call Dashbot from inside an Element and read the answer under the execution access context.

Terug naar builtin index Signatuur Payloadformaat Voorbeeld Scope-notities

Signatuur

askDashbot(prompt, responseFormat=None, allowTools=None, maxToolCalls=None, toolScope=None, contextId=None, timeoutSeconds=None, language=None, timeZone=None, localNow=None, localDate=None)

Doel

Call Dashbot from inside an Element and read the answer under the execution access context.

Aliases and imports

ask_dashbot
callDashbot
call_dashbot
dashbot.ask

Payloadformaat

Use these fields as the Python call arguments or keyword payload for this helper.

{
  "prompt": "Summarize these rows in one operational sentence.",
  "allowTools": false,
  "timeoutSeconds": 120,
  "responseFormat": {
    "type": "json_object"
  }
}

Field	Description
`prompt`	Required prompt string.
`responseFormat`	Optional JSON response-format object passed to Dashbot.
`allowTools`	Optional bool. Defaults false in Element runtime to avoid recursive Element/Dashbot/tool loops.
`maxToolCalls`	Optional tool-call cap when allowTools is true.
`toolScope`	Optional Dashbot tool scope, usually general.
`contextId`	Optional memory context id. Omit for isolated one-shot calls.
`timeoutSeconds`	Optional request timeout.
`language/timeZone/localNow/localDate`	Optional context forwarded to Dashbot.

Return payload

{
  "message": {
    "role": "assistant",
    "content": "{\"summary\":\"Orders are stable.\"}"
  },
  "text": "{\"summary\":\"Orders are stable.\"}",
  "parsed": {
    "summary": "Orders are stable."
  },
  "usage": {
    "inputTokens": 120,
    "outputTokens": 12
  },
  "warnings": []
}

Voorbeeld

def run():
    answer = askDashbot(
        "Summarize this status in one sentence.",
        allowTools=False,
        responseFormat={"type": "json_object"},
    )
    return {"summary": answer.parsed.get("summary") if answer.parsed else answer.text}

Scope-notities

The helper is only available when dashview-be injected a valid user, on-behalf-of, or tenant-system Dashbot runtime context.
Dashbot forwards the same access context to MCP and tool backends; tool calls must not broaden datasource access or bypass forced filters.
Tools are disabled by default. Enable allowTools only when recursive side effects are intentional.
Do not pass secrets or large row payloads in the prompt. Pass bounded summaries instead.

askDashbot