Interface: IngestionSyncOptions
@kortexya/reasoninglayer / IngestionSyncOptions
Interface: IngestionSyncOptions
Section titled “Interface: IngestionSyncOptions”Defined in: src/resources/ingestion.ts:128
Options controlling synchronous vs asynchronous ingestion.
Remarks
Section titled “Remarks”When sync is true (default), the request blocks until extraction
completes and returns the full result. When sync is false, the engine
queues the work and answers HTTP 202 with a session to poll; see each
method for the exact return shape.
Extends
Section titled “Extends”Properties
Section titled “Properties”causal?
Section titled “causal?”
optionalcausal?:AuditCausalHeaders
Defined in: src/types/common.ts:97
Causal assertions for the audit ledger, sent as the x-osfkb-* request
headers. See AuditCausalHeaders.
Inherited from
Section titled “Inherited from”namespaceId?
Section titled “namespaceId?”
optionalnamespaceId?:string
Defined in: src/types/common.ts:84
Override the namespace for this request (X-Namespace-Id header).
Inherited from
Section titled “Inherited from”retries?
Section titled “retries?”
optionalretries?:number
Defined in: src/types/common.ts:92
Number of retry attempts for this request. Set to 0 to disable retries.
Inherited from
Section titled “Inherited from”signal?
Section titled “signal?”
optionalsignal?:AbortSignal
Defined in: src/types/common.ts:88
AbortSignal for request cancellation.
Inherited from
Section titled “Inherited from”
optionalsync?:boolean
Defined in: src/resources/ingestion.ts:137
Whether to process synchronously.
true(default): blocks until complete, returns full result.false: asks the engine to queue the work.
Default Value
Section titled “Default Value”truetimeoutMs?
Section titled “timeoutMs?”
optionaltimeoutMs?:number
Defined in: src/types/common.ts:90
Per-call timeout in milliseconds. Overrides the client-level timeoutMs default.
Inherited from
Section titled “Inherited from”userId?
Section titled “userId?”
optionaluserId?:string
Defined in: src/types/common.ts:86
Override the user ID for this request (X-User-Id header). Used for admin impersonation.