Interface: GenerateDocumentRequest
@kortexya/reasoninglayer / GenerateDocumentRequest
Interface: GenerateDocumentRequest
Section titled “Interface: GenerateDocumentRequest”Defined in: src/types/generation.ts:97
Request body for evidence-grounded document generation.
Remarks
Section titled “Remarks”The pipeline derives a specification from the root term via forward chaining, then generates an artifact using an LLM with evidence grounding.
Properties
Section titled “Properties”metadata?
Section titled “metadata?”
optionalmetadata?:Record<string,string>
Defined in: src/types/generation.ts:99
Additional metadata to guide generation (passed through to the backend).
modality
Section titled “modality”modality:
string
Defined in: src/types/generation.ts:104
Target modality for the output artifact.
Currently only "text" is supported.
rootTermId
Section titled “rootTermId”rootTermId:
string
Defined in: src/types/generation.ts:114
Root term ID describing the artifact to generate.
Remarks
Section titled “Remarks”Must be a data term of this tenant: an absent id, an engine built-in or rule scaffolding answers 404. The artifact covers the root’s material only (the terms it reaches and the terms that reference it), at most 500 terms (more answers 422).
tenantId?
Section titled “tenantId?”
optionaltenantId?:string|null
Defined in: src/types/generation.ts:116
Tenant ID (overridden by X-Tenant-Id header when present).