TsgcAIDocumentExtractor › Properties

TsgcAIDocumentExtractor Properties

Published properties grouped by purpose, followed by the full alphabetical list.

Model

NameDescription
AIChatThe TsgcAIChat component that sends the documents to the AI provider.

Schema

NameDescription
PresetSelects a built in schema (invoice, receipt, identity document) instead of Schema.
SchemaJSON Schema of the data to extract, used when Preset is dpCustom.
InstructionsAdditional extraction instructions appended to the prompt.
SchemaNameName sent to the provider together with the schema.

Validation and Confidence

NameDescription
ValidationRetriesNumber of times the model is asked again when the data does not validate.
RaiseOnInvalidRaises EsgcAIDocumentExtractor when the data still does not validate after the retries.
IncludeConfidenceAsks the model for a confidence value per extracted field.
MinConfidenceThreshold under which OnLowConfidence is raised for a field.

OCR

NameDescription
OCRLocal OCR component used by OCRMode.
OCRModeWhen the local OCR is used instead of sending the attachments to the model.

Result

NameDescription
LastResultResult of the last extraction: data, validation errors, confidences and OCR text.

Diagnostics

NameDescription
VersionRead-only component version string.

All Properties (alphabetical)

NameDescription
AIChatThe TsgcAIChat component that sends the documents to the AI provider.
IncludeConfidenceAsks the model for a confidence value per extracted field.
InstructionsAdditional extraction instructions appended to the prompt.
LastResultResult of the last extraction: data, validation errors, confidences and OCR text.
MinConfidenceThreshold under which OnLowConfidence is raised for a field.
OCRLocal OCR component used by OCRMode.
OCRModeWhen the local OCR is used instead of sending the attachments to the model.
PresetSelects a built in schema (invoice, receipt, identity document) instead of Schema.
RaiseOnInvalidRaises EsgcAIDocumentExtractor when the data still does not validate after the retries.
SchemaJSON Schema of the data to extract, used when Preset is dpCustom.
SchemaNameName sent to the provider together with the schema.
ValidationRetriesNumber of times the model is asked again when the data does not validate.
VersionRead-only component version string.