Skip to main content

docExtractorPublisher

Workspace API


Workspace API / services/docExtractorPublisher

services/docExtractorPublisher

Interfaces

FileUploadEvent

Defined in: services/docExtractorPublisher.ts:51

File upload event for document extraction.

Required by consumer: document_id, organization_id, storage_path Optional: all other fields (passed through to handler)

Properties

document_id

document_id: string

Defined in: services/docExtractorPublisher.ts:53

organization_id

organization_id: string

Defined in: services/docExtractorPublisher.ts:54

storage_path

storage_path: string

Defined in: services/docExtractorPublisher.ts:55

project_id

project_id: string | null

Defined in: services/docExtractorPublisher.ts:58

user_id

user_id: string

Defined in: services/docExtractorPublisher.ts:59

filename

filename: string

Defined in: services/docExtractorPublisher.ts:60

file_size_bytes

file_size_bytes: number

Defined in: services/docExtractorPublisher.ts:61

content_type

content_type: string

Defined in: services/docExtractorPublisher.ts:62

uploaded_at

uploaded_at: string

Defined in: services/docExtractorPublisher.ts:63

content_hash

content_hash: string

Defined in: services/docExtractorPublisher.ts:64

trace_id

trace_id: string

Defined in: services/docExtractorPublisher.ts:65

replace_document_id?

optional replace_document_id: string

Defined in: services/docExtractorPublisher.ts:66

exclude_furniture?

optional exclude_furniture: boolean

Defined in: services/docExtractorPublisher.ts:68

enable_table_detection?

optional enable_table_detection: boolean

Defined in: services/docExtractorPublisher.ts:69

metadata

metadata: object

Defined in: services/docExtractorPublisher.ts:70

original_filename

original_filename: string

upload_source

upload_source: "api"

upload_type?

optional upload_type: "organization" | "project"

Functions

publishFileUploadEvent()

publishFileUploadEvent(event): Promise<string | null>

Defined in: services/docExtractorPublisher.ts:84

Publish a file upload event to doc-extractor Kafka topic This triggers document extraction processing for the uploaded file using Docling

Parameters

event

FileUploadEvent

File upload event data

Returns

Promise<string | null>

Promise resolving to message offset if successful, null if topic not configured


publishDoclingExtractionEvent()

publishDoclingExtractionEvent(event): Promise<string | null>

Defined in: services/docExtractorPublisher.ts:158

Publish a document to the Docling extraction queue This triggers enhanced Docling extraction processing (Phase 2)

Parameters

event

FileUploadEvent

Document event data (same schema as FileUploadEvent)

Returns

Promise<string | null>

Promise resolving to message offset if successful, null if topic not configured