IAllowedRelationshipType
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Allowed relationship type combination for semantic search. Filters relationships and results to only include direct matches or objects reachable via allowed relationship types.
export interface IAllowedRelationshipType
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
boolean | (BETA) (Optional) If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed). | ||
(BETA) Source object type (e.g. ‘dashboard’, ‘visualization’, ‘metric’). | |||
(BETA) Target object type (e.g. ‘visualization’, ‘metric’, ‘attribute’). |
Property details
IAllowedRelationshipType.allowOrphanspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
If true, allows target objects that are not part of any relationship (orphans) to be included in results. If false, orphan target objects will be excluded even if they directly match the search query. Default is true (orphans are allowed).
allowOrphans?: boolean;
IAllowedRelationshipType.sourceTypepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Source object type (e.g. ‘dashboard’, ‘visualization’, ‘metric’).
sourceType: GenAIObjectType;
IAllowedRelationshipType.targetTypepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Target object type (e.g. ‘visualization’, ‘metric’, ‘attribute’).
targetType: GenAIObjectType;