allow_custom_fields

Controls whether the Omni Agent and Workbook Agent can generate custom fields in their queries. Custom fields are ad-hoc dimensions and measures that users can create in workbooks with their own calculations. This setting only applies to AI-generated queries. Hand-written SQL is not affected by this setting.

Disabling custom fields is strongly discouraged. It exists only for scenarios where only governed, model-based reporting is required.Omni does not run its AI evals in this mode. Additionally, custom fields are still governed by your model - this means that turning them off substantially limits the AI. Omni will not address reports of it failing to generate certain queries as a result.

Syntax

ai_settings:
  allow_custom_fields: <always | never | not_for_restricted_queriers>

Properties

ai_settings

object

An object that contains various AI settings. See ai_settings for more information.

Hide ai_settings properties

allow_custom_fields

string

default:"always"

When the Omni Agent and Workbook Agent can generate custom fields in their queries. Does not apply to hand-written SQL.Must be one of the following:

always - Default. The AI can generate CTEs for all users, regardless of whether their role allows direct SQL access.
never - The AI cannot generate custom fields.
not_for_restricted_queriers - The AI can generate custom fields for all users with querying access except Restricted Queriers.

Plain column reference dimensions are allowed even when custom fields are disabled on CTEs. Computed dimensions and all measures will be rejected.

Examples

ai_settings: allow_custom_fields: not_for_restricted_queriers

```yaml title="Disable custom fields for all users"
ai_settings:
  allow_custom_fields: never

ai_settings: allow_custom_fields: not_for_restricted_queriers allow_ctes: not_for_restricted_queriers

See [`allow_ctes`](/modeling/models/parameters/ai-settings/allow-ctes) for more information.

allow_ctes

analyze_configuration

⌘I

​Syntax

​Properties

​Examples

Syntax

Properties

Examples