BatchTypeParams Object (IBatchTypeParams Interface)

This object represents the settings of a BatchType object. Each BatchType can only have one BatchTypeParams object. Every new batch of this BatchType (for example, created with the AddNewEx method of the Batches object) will use the settings from its BatchTypeParams.

If the settings from its BatchTypeParams are updated, all the existing batches with this type will be recognized with the new settings.


Name Type Description
ClassificationBatch ClassificationTrainingBatch

Specifies classifier.

The training batch contains the classifier which is used for batches of this type.

ExportParamsForUnknownDocuments ImageExportParams, read-only

Specifies the export parameters for unknown documents, i.e. documents to which no Document Definition has been applied or which weren't recognized.

Note: When working with batch types and exporting unknown documents from a project or a batch, the export settings with which export will be performed depend on the following rule: if the batch type is different from default, the export settings of the batch type are used, otherwise, export is performed with the project export settings.

FullTextRecognitionParams FullTextRecognitionParams Provides access to full text recognition parameters.
ShouldExportUnknownDocuments Boolean

Specifies if unknown documents should be exported by calling the Export method of the Project object or Export method of the Batch object, i.e. documents to which no Document Definition has been applied or which weren't recognized.

The default value of the property is FALSE.

UseClassifier Boolean

Specifies if the batches with this batch type should use a classifier.

The default value of this property is FALSE.

Related objects

Output parameter

This object is the output parameter of the CreateBatchTypeParams method of the Project object.

Input parameter

This object is the input parameter of the AddNew method of the BatchTypes object.


This object is used in the following code samples: Classification.

See also


Working with Properties

15.08.2023 13:19:30

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.