Skip to main content

Interface: RagRetrievalScope

Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:232

Enterprise access scope applied at retrieval time. The augmentor translates these into the vector-store layer's metadata filter so forbidden context is excluded from results, not retrieved and then asked-to-be-ignored.

Empty/undefined fields are treated as "no constraint" (e.g. no tenantId means cross-tenant retrieval is allowed). When set, only chunks whose matching field matches the scope are eligible:

  • tenantId — exact match
  • aclGroups — intersection with chunk's aclGroups must be non-empty
  • classification — chunk's classification must be <= max sensitivity
  • status — chunk must be one of the listed lifecycle states (default: ['active'])
  • now — chunk's effectiveDate ≤ now ≤ expiresAt window

Properties​

aclGroups?​

optional aclGroups: string[]

Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:234

maxClassification?​

optional maxClassification: "internal" | "public" | "confidential" | "restricted"

Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:236

Maximum sensitivity the requesting principal is allowed to see.

now?​

optional now: string

Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:240

ISO timestamp for effective-date / expires-at filtering. Defaults to "now".

status?​

optional status: ("draft" | "deprecated" | "active" | "archived")[]

Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:238

Allowed lifecycle states. Defaults to ['active'] when omitted.

tenantId?​

optional tenantId: string

Defined in: packages/agentos/src/cognition/rag/IRetrievalAugmentor.ts:233