Interface: BulkAddTermsResponse
@kortexya/reasoninglayer / BulkAddTermsResponse
Interface: BulkAddTermsResponse
Section titled “Interface: BulkAddTermsResponse”Defined in: src/types/terms.ts:403
Response from bulk term creation.
Properties
Section titled “Properties”coreferencedTermIds?
Section titled “coreferencedTermIds?”
optionalcoreferencedTermIds?:string[]
Defined in: src/types/terms.ts:439
Existing entities a @key coreference merged a row into.
Remarks
Section titled “Remarks”These outlive a dry run, because they existed before it: they are the one kind of id a dry run can honestly report.
dryRun
Section titled “dryRun”dryRun:
boolean
Defined in: src/types/terms.ts:420
Whether the request asked for a dry run, echoed so an answer is self-describing.
errors?
Section titled “errors?”
optionalerrors?:BulkRowRefusal[]
Defined in: src/types/terms.ts:431
The rows the write refused, each with its index in the request.
Remarks
Section titled “Remarks”Present on a 201 under BulkAddTermsRequest.partial, where some
rows landed and some did not. When EVERY row was refused the route answers
a BulkRefusedError instead, which carries the same list.
processingTimeMs
Section titled “processingTimeMs”processingTimeMs:
number
Defined in: src/types/terms.ts:441
Total processing time in milliseconds.
refused?
Section titled “refused?”
optionalrefused?:number
Defined in: src/types/terms.ts:422
How many rows were refused. Absent when none were.
termIds?
Section titled “termIds?”
optionaltermIds?:string[]
Defined in: src/types/terms.ts:416
Effective term id per accepted row, in request order.
Remarks
Section titled “Remarks”The created id, or the EXISTING entity’s id when the row coreferenced into
it through a @key. Absent on a dry run, where the ids were rolled back —
see BulkAddTermsRequest.dryRun. Under
BulkAddTermsRequest.partial it carries one id per ACCEPTED row, so
it is shorter than the request when errors is non-empty; use
errors[].index to map a refusal back to its row, never this array’s
positions.
termsAdded
Section titled “termsAdded”termsAdded:
number
Defined in: src/types/terms.ts:418
How many terms the write created (or would have created, on a dry run).