Skip to main content

SourceReference

@forge/monorepo


@forge/monorepo / backend/src / SourceReference

Type Alias: SourceReference

SourceReference = object

Defined in: backend/src/knowledge/retrieval.ts:90

What a citation needs, derived from a hit so there is one shape rather than each caller's own (AC-6).

Properties

chunkId

readonly chunkId: string

Defined in: backend/src/knowledge/retrieval.ts:94


chunkIndex

readonly chunkIndex: number

Defined in: backend/src/knowledge/retrieval.ts:93


locator?

readonly optional locator?: string

Defined in: backend/src/knowledge/retrieval.ts:96

The heading path, when the chunker found one. What makes a citation point at a place, not a document.


sourceId

readonly sourceId: string

Defined in: backend/src/knowledge/retrieval.ts:92


sourceType

readonly sourceType: KnowledgeSourceType

Defined in: backend/src/knowledge/retrieval.ts:91