CitationCandidate

@forge/monorepo

---

@forge/monorepo / backend/src / CitationCandidate

Type Alias: CitationCandidate

CitationCandidate = object

Defined in: backend/src/citations/index.ts:52

Properties

authSubject?

readonly optional authSubject?: string

Defined in: backend/src/citations/index.ts:65

The subject the reader must be entitled to.

Required for a retrieval citation and absent for a web one — a public URL has no subject to check. Kept outside the part on purpose: it is an input to the emission decision, not something a stored citation should carry, because a stale subject on a durable part is a permission claim nobody re-evaluates.

---

charRange?

readonly optional charRange?: object

Defined in: backend/src/citations/index.ts:57

end

readonly end: number

start

readonly start: number

---

excerpt

readonly excerpt: string

Defined in: backend/src/citations/index.ts:54

---

origin

readonly origin: CitationOrigin

Defined in: backend/src/citations/index.ts:53

---

retrievedAt

readonly retrievedAt: string

Defined in: backend/src/citations/index.ts:55

---

supports

readonly supports: readonly MessagePartId[]

Defined in: backend/src/citations/index.ts:56