Skip to main content
Version: v0.17.0

NuixPerformOCR

Alias:NuixPerformOCR

Output:Unit

Requires Nuix.Version 7.8

Requires Nuix.Features: OCR_PROCESSING

Performs optical character recognition on items in a NUIX case.

ParameterTypeRequiredPositionDefault ValueExampleRequirementsSummary
SearchTerm
Search
string1*.txtThe search query used for searching for items to OCR.
CasePath
Directory
stringUse the current open caseC:/Cases/MyCaseThe case path to use. If this is set, that case will be opened. If it is not set, the existing case will be used. If it is not set and no existing case is open this will result in an error.
OCRProfileName
Profile
stringThe Default profile will be used.MyOcrProfileThe name of the OCR profile to use. This cannot be set at the same time as OCRProfilePath.
OCRProfilePath
ProfilePath
stringThe Default profile will be used.C:\Profiles\MyProfile.xmlVersion 7.6Path to the OCR profile to use. This cannot be set at the same times as OCRProfileName.
SearchOptionsentityNo search options providedPass additional search options to nuix. For an unsorted search (default) the only available option is defaultFields. When using SortSearch=true the options are defaultFields, order, and limit. Please see the nuix API for Case.search and Case.searchUnsorted for more details.
SearchTypeSearchTypeItemsOnlyDefines the type of search that is done. By default only the items responsive to the search terms are tagged, but the result set can be augmented using this parameter.
SortSearchboolfalseBy default the search is not sorted by relevance which increases performance. Set this to true to sort the search by relevance and enabling additional SearchOptions.