> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bigquery: Actions/run Semantic Query

> Answer a business question from BigQuery by picking metrics, dimensions and filters defined in your semantic layer. Includes SDK V2 examples, schemas, and cost.

Answer a business question from BigQuery by picking metrics, dimensions and filters defined in your semantic layer.

> [!NOTE]
>
> Tool ID: `bigquery_run_semantic_query`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bigquery_run_semantic_query',
  {
    "credentials": {
      "service_account_json": "example"
    },
    "name": "Example",
    "output_df_name": "Example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute bigquery_run_semantic_query --input '{
  "credentials": {
    "service_account_json": "example"
  },
  "name": "Example",
  "output_df_name": "Example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "rows": [
      {}
    ],
    "rowCount": 123,
    "limited": true,
    "columns": [
      "example"
    ],
    "jobId": "job_123",
    "sql": "SELECT * FROM companies LIMIT 10"
  }
}
```

Use `deepline describe bigquery_run_semantic_query --json` for the latest machine-readable contract.

## Input reference

Render a stored BigQuery semantic layer query and execute it.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.credentials` | `object` | No | — | — |
| `payload.name` | `string` | No | — | — |
| `payload.output_df_name` | `string` | No | — | — |
| `payload.renderer_version` | `"v2"` | No | — | — |
| `payload.type` | `"metrics" \| "funnel" \| null` | No | — | — |
| `payload.params` | `object \| null` | No | — | — |
| `payload.table_name` | `string` | No | — | Legacy semantic table name. |
| `payload.metrics` | `array` | No | — | — |
| `payload.dimensions` | `array` | No | — | — |
| `payload.custom_dimensions` | `array` | No | — | — |
| `payload.facts` | `array` | No | — | — |
| `payload.filters` | `array` | No | — | — |
| `payload.custom_filter_expressions` | `array` | No | — | — |
| `payload.rowLimit` | `integer` | No | `5000` | Maximum number of rows to return. Default 5000. |
| `payload.timeoutMs` | `integer` | No | `120000` | BigQuery statement timeout in milliseconds. Default 120000. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Render a stored BigQuery semantic layer query and execute it.",
    "properties": {
      "credentials": {
        "type": "object",
        "properties": {
          "project_id": {
            "type": "string",
            "description": "Billing project ID."
          },
          "dataset": {
            "type": "string",
            "description": "Default dataset."
          },
          "location": {
            "type": "string",
            "description": "BigQuery job location."
          },
          "service_account_json": {
            "type": "string",
            "description": "Google service-account key JSON. Parsed only in memory."
          }
        },
        "required": [
          "service_account_json"
        ],
        "additionalProperties": false
      },
      "name": {
        "type": [
          "string",
          "null"
        ]
      },
      "output_df_name": {
        "type": [
          "string",
          "null"
        ]
      },
      "renderer_version": {
        "type": "string",
        "const": "v2"
      },
      "type": {
        "anyOf": [
          {
            "type": "string",
            "const": "metrics"
          },
          {
            "type": "string",
            "const": "funnel"
          },
          {
            "type": "null"
          }
        ]
      },
      "params": {
        "anyOf": [
          {
            "type": "object",
            "properties": {
              "table_name": {
                "type": "string",
                "description": "Semantic table name."
              },
              "metrics": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "dimensions": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "custom_dimensions": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "facts": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "filters": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "custom_filter_expressions": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "output_format": {
                "type": "string",
                "enum": [
                  "csv",
                  "parquet"
                ]
              }
            },
            "additionalProperties": false
          },
          {
            "type": "object",
            "properties": {
              "table_name": {
                "type": "string",
                "description": "Semantic table name."
              },
              "steps": {
                "type": "array",
                "items": {
                  "anyOf": [
                    {
                      "type": "string"
                    },
                    {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "source_table": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "ts_expr": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "time_dimension": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "filter_expr": {
                          "type": [
                            "string",
                            "null"
                          ]
                        },
                        "events_sql": {
                          "type": [
                            "string",
                            "null"
                          ]
                        }
                      },
                      "additionalProperties": false
                    }
                  ]
                }
              },
              "cohort_by": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "enforce_order": {
                "type": "boolean"
              },
              "time_window_days": {
                "type": [
                  "integer",
                  "null"
                ]
              },
              "filters": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "custom_filter_expressions": {
                "type": [
                  "array",
                  "null"
                ],
                "items": {
                  "type": "string"
                }
              },
              "output_format": {
                "type": "string",
                "enum": [
                  "csv",
                  "parquet"
                ]
              }
            },
            "additionalProperties": false
          },
          {
            "type": "null"
          }
        ]
      },
      "table_name": {
        "type": "string",
        "description": "Legacy semantic table name."
      },
      "metrics": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        }
      },
      "dimensions": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        }
      },
      "custom_dimensions": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        }
      },
      "facts": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        }
      },
      "filters": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        }
      },
      "custom_filter_expressions": {
        "type": [
          "array",
          "null"
        ],
        "items": {
          "type": "string"
        }
      },
      "rowLimit": {
        "type": "integer",
        "description": "Maximum number of rows to return. Default 5000.",
        "default": 5000
      },
      "timeoutMs": {
        "type": "integer",
        "description": "BigQuery statement timeout in milliseconds. Default 120000.",
        "default": 120000
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

BigQuery semantic query result.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Semantic query response payload. |
| `result.data.rows` | `array` | Yes | — | — |
| `result.data.rowCount` | `integer` | Yes | — | — |
| `result.data.limited` | `boolean` | Yes | — | — |
| `result.data.columns` | `array` | Yes | — | — |
| `result.data.jobId` | `string \| null` | Yes | — | — |
| `result.data.sql` | `string` | Yes | — | — |
| `result.data.dataset` | `object` | No | — | — |
| `result.data.dataset.kind` | `"bigquery_query"` | Yes | — | — |
| `result.data.dataset.total_rows` | `integer` | Yes | — | — |
| `result.data.dataset.returned_limit` | `integer` | Yes | — | — |
| `result.data.dataset.offset` | `integer` | Yes | — | — |
| `result.data.dataset.page_size` | `integer` | Yes | — | — |
| `result.meta` | `object` | No | — | — |
| `result.meta.projectId` | `string` | Yes | — | — |
| `result.meta.defaultDataset` | `string \| null` | Yes | — | — |
| `result.meta.location` | `string \| null` | Yes | — | — |
| `result.meta.rowLimit` | `integer` | Yes | — | — |
| `result.meta.timeoutMs` | `integer` | Yes | — | — |
| `result.meta.rendererVersion` | `"v2"` | Yes | — | — |
| `result.meta.semanticLayerHash` | `string` | Yes | — | — |
| `result.meta.dataset` | `object` | No | — | — |
| `result.meta.dataset.limit` | `integer` | Yes | — | — |
| `result.meta.dataset.offset` | `integer` | Yes | — | — |
| `result.meta.dataset.pageSize` | `integer` | Yes | — | — |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "BigQuery semantic query result.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Semantic query response payload.",
        "properties": {
          "rows": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": {}
            }
          },
          "rowCount": {
            "type": "integer"
          },
          "limited": {
            "type": "boolean"
          },
          "columns": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "jobId": {
            "type": [
              "string",
              "null"
            ]
          },
          "sql": {
            "type": "string"
          },
          "dataset": {
            "type": "object",
            "properties": {
              "kind": {
                "type": "string",
                "const": "bigquery_query"
              },
              "total_rows": {
                "type": "integer"
              },
              "returned_limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              },
              "page_size": {
                "type": "integer"
              }
            },
            "required": [
              "kind",
              "total_rows",
              "returned_limit",
              "offset",
              "page_size"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "rows",
          "rowCount",
          "limited",
          "columns",
          "jobId",
          "sql"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "properties": {
          "projectId": {
            "type": "string"
          },
          "defaultDataset": {
            "type": [
              "string",
              "null"
            ]
          },
          "location": {
            "type": [
              "string",
              "null"
            ]
          },
          "rowLimit": {
            "type": "integer"
          },
          "timeoutMs": {
            "type": "integer"
          },
          "rendererVersion": {
            "type": "string",
            "const": "v2"
          },
          "semanticLayerHash": {
            "type": "string"
          },
          "dataset": {
            "type": "object",
            "properties": {
              "limit": {
                "type": "integer"
              },
              "offset": {
                "type": "integer"
              },
              "pageSize": {
                "type": "integer"
              }
            },
            "required": [
              "limit",
              "offset",
              "pageSize"
            ],
            "additionalProperties": false
          }
        },
        "required": [
          "projectId",
          "defaultDataset",
          "location",
          "rowLimit",
          "timeoutMs",
          "rendererVersion",
          "semanticLayerHash"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Bigquery provider guide](https://deepline.com/docs/providers/bigquery/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.