> ## 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/get Semantic Layer

> Reading the active BigQuery semantic layer YAML and table list into agent context before building a semantic query. Includes SDK V2 examples, schemas, and cost.

Reading the active BigQuery semantic layer YAML and table list into agent context before building a semantic query.

<Info>
  Tool ID: `bigquery_get_semantic_layer`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'bigquery_get_semantic_layer',
  {
    "includeYaml": true
  },
);

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

### CLI

```bash theme={null}
deepline tools execute bigquery_get_semantic_layer --input '{
  "includeYaml": true
}' --json
```

## Example response

The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.

```json theme={null}
{
  "data": {
    "configured": true,
    "source": "convex",
    "provider": "bigquery",
    "contentHash": "example",
    "updatedAt": "2026-01-15T12:00:00Z",
    "tableCount": 123,
    "tables": [
      "example"
    ]
  }
}
```

Use `deepline tools get bigquery_get_semantic_layer --json` for the latest machine-readable contract.

## Input reference

Read the active BigQuery semantic layer for the organization.

| Name                  | Type      | Required | Default | Details                                                        |
| --------------------- | --------- | -------- | ------- | -------------------------------------------------------------- |
| `payload.includeYaml` | `boolean` | No       | `true`  | Whether to include the full semantic layer YAML. Default true. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Read the active BigQuery semantic layer for the organization.",
    "properties": {
      "includeYaml": {
        "type": "boolean",
        "description": "Whether to include the full semantic layer YAML. Default true.",
        "default": true
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

BigQuery semantic layer document.

| Name                      | Type               | Required | Default | Details                    |
| ------------------------- | ------------------ | -------- | ------- | -------------------------- |
| `result.data`             | `object`           | Yes      | —       | Semantic layer payload.    |
| `result.data.configured`  | `boolean`          | Yes      | —       | —                          |
| `result.data.source`      | `"convex" \| null` | Yes      | —       | Allowed: `convex`, `null`. |
| `result.data.provider`    | `"bigquery"`       | Yes      | —       | —                          |
| `result.data.contentHash` | `string \| null`   | Yes      | —       | —                          |
| `result.data.updatedAt`   | `string \| null`   | Yes      | —       | —                          |
| `result.data.tableCount`  | `integer`          | Yes      | —       | —                          |
| `result.data.tables`      | `array`            | Yes      | —       | —                          |
| `result.data.yaml`        | `string`           | No       | —       | —                          |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "BigQuery semantic layer document.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Semantic layer payload.",
        "properties": {
          "configured": {
            "type": "boolean"
          },
          "source": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "convex",
              null
            ]
          },
          "provider": {
            "type": "string",
            "const": "bigquery"
          },
          "contentHash": {
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "tableCount": {
            "type": "integer"
          },
          "tables": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "yaml": {
            "type": "string"
          }
        },
        "required": [
          "configured",
          "source",
          "provider",
          "contentHash",
          "updatedAt",
          "tableCount",
          "tables"
        ],
        "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](/docs/providers/bigquery/guide)
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)