Member Junction
    Preparing search index...

    Framework-agnostic (server + client safe) analytics engine for the Knowledge Hub classify pipeline. Aggregates MJ: Content Item Tags / MJ: Content Items into display-ready summaries so agents and UI can share the same numbers.

    Every method:

    • accepts an optional ClassifyAnalyticsScope, contextUser, and provider,
    • batches reads with RunView/RunViews using ResultType: 'simple' + narrow Fields,
    • never queries per-item inside a loop,
    • returns plain typed result objects (no BaseEntity instances).
    const kpis = await ClassifyAnalyticsEngine.Instance.GetKPIs(
    { ContentSourceIDs: [sourceID], StartDate: lastMonth }, contextUser);

    Hierarchy (View Summary)

    Index

    Constructors

    Accessors

    • get GlobalKey(): string

      Returns string

    Methods

    • Coverage: how many in-scope content items have at least one tag vs none. Note: the date-range portion of scope is intentionally NOT applied here — coverage is a property of items vs. their tags, not of when a tag was applied. Source / content-type scoping IS applied.

      Parameters

      • Optionalscope: ClassifyAnalyticsScope

        Optional source / content-type filter (date range ignored).

      • OptionalcontextUser: UserInfo

        User context for server-side data operations.

      • Optionalprovider: IMetadataProvider

        Optional metadata provider for multi-provider contexts.

      Returns Promise<CoverageSummary>

    • The Global Object Store is a place to store global objects that need to be shared across the application. Depending on the execution environment, this could be the window object in a browser, or the global object in a node environment, or something else in other contexts. The key here is that in some cases static variables are not truly shared because it is possible that a given class might have copies of its code in multiple paths in a deployed application. This approach ensures that no matter how many code copies might exist, there is only one instance of the object in question by using the Global Object Store.

      Returns GlobalObjectStore

    • KPIs summary: total items, total tags, average tags/item, distinct tags.

      Parameters

      • Optionalscope: ClassifyAnalyticsScope

        Optional source / content-type / date-range filter. (Source/content-type apply to items + tags; date range applies to tags.)

      • OptionalcontextUser: UserInfo

        User context for server-side data operations.

      • Optionalprovider: IMetadataProvider

        Optional metadata provider for multi-provider contexts.

      Returns Promise<ClassifyKPIs>

    • Tag distribution: a descending list of (tag -> count) within scope.

      Parameters

      • Optionalscope: ClassifyAnalyticsScope

        Optional source / content-type / date-range filter.

      • OptionalcontextUser: UserInfo

        User context for server-side data operations.

      • Optionalprovider: IMetadataProvider

        Optional metadata provider for multi-provider contexts.

      • Optionallimit: number

        Optional cap on the number of distinct tags returned (top-N by count).

      Returns Promise<TagDistributionEntry[]>

    • Confidence / weight histogram: distribution of ContentItemTag.Weight across binCount equal-width bins spanning [0, 1].

      Parameters

      • OptionalbinCount: number

        Number of bins (default 10). Clamped to >= 1.

      • Optionalscope: ClassifyAnalyticsScope

        Optional source / content-type / date-range filter.

      • OptionalcontextUser: UserInfo

        User context for server-side data operations.

      • Optionalprovider: IMetadataProvider

        Optional metadata provider for multi-provider contexts.

      Returns Promise<WeightHistogramBin[]>

    • Returns the singleton instance of the class. If the instance does not exist, it is created and stored in the Global Object Store. If className is provided it will be used as part of the key in the Global Object Store, otherwise the actual class name will be used. NOTE: the class name used by default is the lowest level of the object hierarchy, so if you have a class that extends another class, the lowest level class name will be used.

      Type Parameters

      Parameters

      • this: new () => T
      • OptionalclassName: string

      Returns T