ExtractionParameters
extends BaseParameters
in package
Parameters accepted by the asynchronous **inference** v2 endpoint.
Table of Contents
Properties
- $alias : string|null
- $confidence : bool|null
- $dataSchema : DataSchema|null
- $modelId : string
- $polygon : bool|null
- $rag : bool|null
- $rawText : bool|null
- $slug : string
- $textContext : string|null
- $webhookIds : array<string|int, string>
Methods
- __construct() : mixed
- asHash() : array<string, int|float|string|bool|null|array<string|int, mixed>>
Properties
$alias
public
string|null
$alias
Optional file alias.
$confidence
public
bool|null
$confidence
= null
$dataSchema
public
DataSchema|null
$dataSchema
Data schema for inference.
$modelId
public
string
$modelId
$polygon
public
bool|null
$polygon
= null
$rag
public
bool|null
$rag
= null
$rawText
public
bool|null
$rawText
= null
$slug
public
static string
$slug
= "extraction"
Slug of the endpoint.
$textContext
public
string|null
$textContext
Additional text context used by the model during inference. Not recommended, for specific use only.
$webhookIds
public
array<string|int, string>
$webhookIds
Optional webhook IDs.
Methods
__construct()
public
__construct(string $modelId[, bool|null $rag = null ][, bool|null $rawText = null ][, bool|null $polygon = null ][, bool|null $confidence = null ][, string|null $alias = null ][, array<string|int, string>|null $webhookIds = null ][, string|null $textContext = null ][, DataSchema|string|array<string|int, string>|null $dataSchema = null ]) : mixed
Parameters
- $modelId : string
-
ID of the model.
- $rag : bool|null = null
-
Whether to enable Retrieval-Augmented Generation.
- $rawText : bool|null = null
-
Whether to extract the full text content from the document as strings.
- $polygon : bool|null = null
-
Whether to calculate bounding box polygons for all fields.
- $confidence : bool|null = null
-
Whether to calculate confidence scores for all fields.
- $alias : string|null = null
-
Optional file alias.
- $webhookIds : array<string|int, string>|null = null
-
List of webhook IDs.
- $textContext : string|null = null
-
Additional text context used by the model during inference.
- $dataSchema : DataSchema|string|array<string|int, string>|null = null
-
Additional text context used by the model during inference.
asHash()
public
asHash() : array<string, int|float|string|bool|null|array<string|int, mixed>>
Return values
array<string, int|float|string|bool|null|array<string|int, mixed>> —Hash representation.