Skip to main content

CommunitySummariser

@forge/monorepo


@forge/monorepo / backend/src / CommunitySummariser

Interface: CommunitySummariser

Defined in: backend/src/knowledge/communities.ts:287

Writes a community's summary — REQ-064 (#270), task #272.

A port, like EntityExtractor, and optional for the same reason: a deployment that clusters but never runs graph-global needs no language model for it. Given the community's entities, its relationships and the text behind them, and asked for a short description of what this cluster is about.

Properties

id

readonly id: string

Defined in: backend/src/knowledge/communities.ts:288

Methods

summarise()

summarise(input): Promise<{ summary: string; usage?: { inputTokens?: number; outputTokens?: number; }; }>

Defined in: backend/src/knowledge/communities.ts:289

Parameters

input
community

Community

entityNames

readonly string[]

excerpts

readonly string[]

The chunk text behind the community, already permission-free — it is all one tenant's own material.

relationshipDescriptions

readonly string[]

Returns

Promise<{ summary: string; usage?: { inputTokens?: number; outputTokens?: number; }; }>