RetrieveInput

@forge/monorepo

---

@forge/monorepo / backend/src / RetrieveInput

Type Alias: RetrieveInput

RetrieveInput = object

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

Properties

authSubjects

readonly authSubjects: readonly string[]

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

The subjects this caller may read.

Required, and passed to both signals. A filter applied to one and not the other is a filter that does not exist — the unfiltered signal would surface the chunk and fusion would rank it.

---

limit

readonly limit: number

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

---

mode?

readonly optional mode?: RetrievalMode

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

Defaults to hybrid. The other two exist so the hybrid claim can be measured against them.

---

query

readonly query: string

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

---

sourceTypes?

readonly optional sourceTypes?: readonly KnowledgeSourceType[]

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