PredictOptions
extends CommonOptions
in package
Handles options tied to Predictions.
Table of Contents
Properties
- $cropper : bool
- $fullText : bool
- $includeWords : bool
Methods
- __construct() : mixed
- Prediction options.
- setCropper() : $this
- setFullText() : $this
- setIncludeWords() : $this
Properties
$cropper
public
bool
$cropper
Whether to include cropper results for each page. This performs a cropping operation on the server and may increase response time.
$fullText
public
bool
$fullText
Whether to include the full OCR text response in compatible APIs. This performs a full OCR operation on the server and will increase response time.
$includeWords
public
bool
$includeWords
Whether to include the full text for each page. This performs a full OCR operation on the server and will increase response time.
Methods
__construct()
Prediction options.
public
__construct([bool $fullText = false ][, bool $includeWords = false ][, bool $cropper = false ]) : mixed
Parameters
- $fullText : bool = false
-
Whether to include the full OCR text response in compatible APIs. This performs a full OCR operation on the server and will increase response time.
- $includeWords : bool = false
-
Whether to include the full text for each page. This performs a full OCR operation on the server and will increase response time.
- $cropper : bool = false
-
Whether to include cropper results for each page. This performs a cropping operation on the server and may increase response time.
setCropper()
public
setCropper(bool $cropper) : $this
Parameters
- $cropper : bool
-
Whether to include the Cropper.
Return values
$thissetFullText()
public
setFullText(bool $fullText) : $this
Parameters
- $fullText : bool
-
Whether to include the full text.
Return values
$thissetIncludeWords()
public
setIncludeWords(bool $includeWords) : $this
Parameters
- $includeWords : bool
-
Whether to include the full text.