Interface: ExtractImageResponse
@kortexya/reasoninglayer / ExtractImageResponse
Interface: ExtractImageResponse
Section titled “Interface: ExtractImageResponse”Defined in: src/types/image-extraction.ts:85
Response from vision-based image extraction.
Properties
Section titled “Properties”entities
Section titled “entities”entities:
ImageExtractedEntityDto[]
Defined in: src/types/image-extraction.ts:87
Extracted entities (visual elements identified in the image).
error?
Section titled “error?”
optionalerror?:string|null
Defined in: src/types/image-extraction.ts:89
Error message if extraction failed.
originalFileId?
Section titled “originalFileId?”
optionaloriginalFileId?:string|null
Defined in: src/types/image-extraction.ts:104
The retained original image’s id; absent for a preview request. The bytes
are downloadable through GET /api/v1/sources/files/{id}/content.
relations
Section titled “relations”relations:
ImageExtractedRelationDto[]
Defined in: src/types/image-extraction.ts:91
Extracted relations (connections/arrows between entities).
stats:
ImageExtractionStatsDto
Defined in: src/types/image-extraction.ts:93
Extraction statistics.
success
Section titled “success”success:
boolean
Defined in: src/types/image-extraction.ts:95
Whether the extraction was successful.
suggestedSorts
Section titled “suggestedSorts”suggestedSorts:
ImageSuggestedSortDto[]
Defined in: src/types/image-extraction.ts:97
Suggested sorts (new types discovered in the image).
termIds
Section titled “termIds”termIds:
string[]
Defined in: src/types/image-extraction.ts:99
IDs of persisted PsiTerms (empty if persist=false).