SystemMessage

Version 4.0.26.4 (latest)
Datatype
Description
(object)
object
text
A direct natural language response.
Expand TextMessage definition...
parts
string[]
textType
string
The type of the text message.
schema
A message produced during schema resolution.
Expand SchemaMessage definition...
query
A schema resolution query.
Expand SchemaQuery definition...
question
string
The question for schema resolution.
result
The result of a schema resolution query.
Expand SchemaResult definition...
datasources
data
A message produced during data retrieval.
Expand DataMessage definition...
query
A data retrieval query.
Expand DataQuery definition...
question
string
A natural language question to answer.
name
string
A snake-case name for the query.
datasources
looker
A query for retrieving data from a Looker explore.
generatedSql
string
SQL generated by the system.
result
Retrieved data.
Expand DataResult definition...
name
string
A snake-case name for the data result.
schema
The schema of the data.
data
any[]
generatedLookerQuery
(DEPRECATED) DEPRECATED: Looker Query generated by the system.
Expand Query definition...
can
object
Operations the current user is able to perform on this object
id
string
Unique Id
model
string
Model
view
string
Explore Name
fields
string[]
pivots
string[]
fill_fields
string[]
filters
object
Filters will contain data pertaining to complex filters that do not contain "or" conditions. When "or" conditions are present, filter data will be found on the `filter_expression` property.
filter_expression
string
Filter Expression
sorts
string[]
limit
string
Row limit. To download unlimited results, set the limit to -1 (negative one).
column_limit
string
Column Limit
total
boolean
Total
row_total
string
Raw Total
subtotals
string[]
vis_config
object
Visualization configuration properties. These properties are typically opaque and differ based on the type of visualization used. There is no specified set of allowed keys. The values can be any type supported by JSON. A "type" key with a string value is often present, and is used by Looker to determine which visualization to present. Visualizations ignore unknown vis_config properties.
filter_config
object
The filter_config represents the state of the filter UI on the explore page for a given query. When running a query via the Looker UI, this parameter takes precedence over "filters". When creating a query or modifying an existing query, "filter_config" should be set to null. Setting it to any other value could cause unexpected filtering behavior. The format should be considered opaque.
visible_ui_sections
string
Visible UI Sections
slug
string
Slug
dynamic_fields
string
Dynamic Fields
client_id
string
Client Id: used to generate shortened explore URLs. If set by client, must be a unique 22 character alphanumeric string. Otherwise one will be generated.
share_url
string
Share Url
expanded_share_url
string
Expanded Share Url
url
string
Expanded Url
query_timezone
string
Query Timezone
has_table_calculations
boolean
Has Table Calculations
bigQueryJob
A BigQuery job executed by the system.
Expand BigQueryJob definition...
projectId
string
The project that the job belongs to.
jobId
string
The ID of the job.
location
string
The location of the job.
destinationTable
A reference to the destination table of the job's query results.
schema
The schema of the job's query results.
analysis
A message produced during analysis.
Expand AnalysisMessage definition...
query
An analysis query.
Expand AnalysisQuery definition...
question
string
An analysis question.
dataResultNames
string[]
progressEvent
An event indicating the progress of the analysis.
Expand AnalysisEvent definition...
plannerReasoning
string
Python codegen planner's reasoning.
coderInstruction
string
Instructions issued for code generation.
code
string
Generated code.
executionOutput
string
Output from code execution.
executionError
string
An error from code execution.
resultVegaChartJson
string
Result as Vega chart JSON string.
resultNaturalLanguage
string
Result as NL string.
resultCsvData
string
Result as CSV string.
resultReferenceData
string
Result as a reference to a data source.
error
string
A generic error message.
chart
A message produced during chart generation.
Expand ChartMessage definition...
query
A query for generating a chart.
Expand ChartQuery definition...
instructions
string
Natural language instructions for generating the chart.
dataResultName
string
The name of a previously retrieved data result to use in the chart.
result
The result of a chart generation query.
Expand ChartResult definition...
vegaConfig
string
A generated Vega chart config.
image
A rendering of the chart.
error
An error message.
Expand ErrorMessage definition...
text
string
The text of the error.
exampleQueries
A message containing example queries.
Expand ExampleQueries definition...
exampleQueries
Expand ExampleQuery definition...
naturalLanguageQuestion
string
A natural language question that a user might ask.
sqlQuery
string
The SQL query that should be generated to answer the natural language question.
groupId
integer
Identifies the group that the event belongs to.