Member Junction
    Preparing search index...

    Interface SecondaryScopeConfig

    Configuration for secondary scope dimensions on an AI Agent.

    Defines what secondary scope dimensions are valid for an agent and how they should behave for memory retrieval and storage. This configuration is stored in the SecondaryScopeConfig JSON field on the AIAgent entity.

    2.131.0

    {
        "dimensions": [
            {"name": "ContactID", "entityId": "uuid-for-contacts", "inheritanceMode": "cascading"},
            {"name": "TeamID", "entityId": "uuid-for-teams", "inheritanceMode": "strict"}
        ],
        "allowSecondaryOnly": false
    }

    {
        "dimensions": [
            {"name": "Region", "inheritanceMode": "cascading"},
            {"name": "DealStage", "inheritanceMode": "strict"}
        ],
        "allowSecondaryOnly": true
    }
    interface SecondaryScopeConfig {
        allowSecondaryOnly?: boolean;
        defaultInheritanceMode?: "cascading" | "strict";
        dimensions: SecondaryDimension[];
        strictValidation?: boolean;
    }
    Index

    Properties

    allowSecondaryOnly? defaultInheritanceMode? dimensions strictValidation?

    Properties

    allowSecondaryOnly?: boolean

    Whether to allow secondary-only scoping (no primary scope required). When true, the agent can function with only secondary dimensions provided in ExecuteAgentParams.SecondaryScopes without requiring PrimaryScopeRecordID.

    false
    defaultInheritanceMode?: "cascading" | "strict"

    Default inheritance mode for dimensions that don't specify one.

    • 'cascading': Notes without a dimension match queries with that dimension (broader retrieval)
    • 'strict': Notes must exactly match the dimension value or be absent
    'cascading'
    dimensions: SecondaryDimension[]

    Array of dimension definitions. Each dimension defines a scope key that can be provided at runtime via ExecuteAgentParams.SecondaryScopes.

    strictValidation?: boolean

    Whether to validate runtime scope values against this config. When true, extra dimensions not defined in dimensions array will cause validation errors. When false, extra dimensions are accepted and stored but may not be used in filtering.

    false

    Settings

    Member Visibility

    On This Page

    Properties