Documentation

WorkflowOptions extends CommonOptions
in package

Handles options tied to Workflows.

Table of Contents

Properties

$alias  : string|null
$fullText  : bool
$priority  : string|null
$publicUrl  : string|null

Methods

__construct()  : mixed
Prediction options.
setFullText()  : $this

Properties

$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.

$priority

public string|null $priority

Priority to give to the document.

$publicUrl

public string|null $publicUrl

A unique, encrypted URL for accessing the document validation interface without requiring authentication.

Methods

__construct()

Prediction options.

public __construct([string|null $alias = null ][, string|null $priority = null ][, bool $fullTextOcr = false ][, string|null $publicUrl = null ]) : mixed
Parameters
$alias : string|null = null

Alias for the document.

$priority : string|null = null

Priority for the document.

$fullTextOcr : bool = false

Whether to retrieve the full ocr text.

$publicUrl : string|null = null

Priority for the document.

setFullText()

public setFullText(bool $fullText) : $this
Parameters
$fullText : bool

Whether to include the full text.

Return values
$this

        
On this page

Search results