Interface: IngestRdfRequest

@kortexya/reasoninglayer / IngestRdfRequest

Interface: IngestRdfRequest

Defined in: src/types/ingestion.ts:1158

Request to ingest RDF content — the body of POST /api/v1/ingest/rdf.

Remarks

The tenant comes from the X-Tenant-Id header and the owner from the caller’s identity; the body carries neither. Synchronous versus queued processing is chosen by the sync option of ingestRdf, which travels as a query parameter. The wire keys are snake_case; the engine refuses an unknown key with 422.

Properties

computeEmbeddings?

optional computeEmbeddings?: boolean

Defined in: src/types/ingestion.ts:1165

Compute and store a text embedding for each ingested term. Set false only for a fast, structural-only ingest.

Default Value

true

content

content: string

Defined in: src/types/ingestion.ts:1167

RDF content in Turtle, N-Triples, RDF/XML, JSON-LD, TriG or N-Quads.

format

format: RdfFormatDto

Defined in: src/types/ingestion.ts:1169

Format of the RDF content.

keepDeclarations?

optional keepDeclarations?: boolean

Defined in: src/types/ingestion.ts:1176

Materialise OWL/RDFS class and property declarations as queryable identity terms. Set true only for SPARQL OWL/RDFS entailment workloads.

Default Value

false — declarations stay schema-level.

parseOntology?

optional parseOntology?: boolean

Defined in: src/types/ingestion.ts:1178

Whether to also parse OWL ontology from the content.

parseShacl?

optional parseShacl?: boolean

Defined in: src/types/ingestion.ts:1180

Whether to also parse SHACL shapes from the content.

repairIris?

optional repairIris?: boolean

Defined in: src/types/ingestion.ts:1188

Percent-encode the illegal code points of RFC 3987-invalid IRIs (raw spaces, \, <>, []) instead of refusing the document with 400. Each rewrite is reported in IngestRdfResponse.repairedIris.

Default Value

false — repair changes the ingested bytes, so it is opt-in.