PredictMethodOptions
in package
Handles options tied to prediction method.
Table of Contents
Properties
- $closeFile : bool
- $endpoint : Endpoint|WorkflowEndpoint|null
- $pageOptions : PageOptions
- $predictOptions : PredictOptions
- $rag : bool
- $workflowId : string|null
- $workflowOptions : WorkflowOptions
Methods
- __construct() : mixed
- Prediction method options.
- setEndpoint() : $this
- setPageOptions() : $this
- setPredictOptions() : $this
- setRag() : $this
- setWorkflowId() : $this
- Sets the workflow ID for the prediction method options.
- setWorkflowOptions() : $this
Properties
$closeFile
public
bool
$closeFile
Whether to close the file after parsing it.
$endpoint
public
Endpoint|WorkflowEndpoint|null
$endpoint
Endpoint.
$pageOptions
public
PageOptions
$pageOptions
Page options.
$predictOptions
public
PredictOptions
$predictOptions
Prediction options.
$rag
public
bool
$rag
If set, will enable Retrieval-Augmented Generation (only works if a valid WorkflowId is set).
$workflowId
public
string|null
$workflowId
Workflow ID.
$workflowOptions
public
WorkflowOptions
$workflowOptions
Workflow options.
Methods
__construct()
Prediction method options.
public
__construct() : mixed
setEndpoint()
public
setEndpoint(Endpoint $customEndpoint) : $this
Parameters
- $customEndpoint : Endpoint
-
Endpoint.
Return values
$thissetPageOptions()
public
setPageOptions(PageOptions $pageOptions) : $this
Parameters
- $pageOptions : PageOptions
-
Page Options.
Return values
$thissetPredictOptions()
public
setPredictOptions(PredictOptions $predictOptions) : $this
Parameters
- $predictOptions : PredictOptions
-
Prediction Options.
Return values
$thissetRag()
public
setRag(bool $rag) : $this
Parameters
- $rag : bool
-
Whether to enable Retrieval-Augmented Generation.
Return values
$thissetWorkflowId()
Sets the workflow ID for the prediction method options.
public
setWorkflowId(string $workflowId) : $this
Parameters
- $workflowId : string
-
The unique workflow ID to be set.
Return values
$thissetWorkflowOptions()
public
setWorkflowOptions(WorkflowOptions $workflowOptions) : $this
Parameters
- $workflowOptions : WorkflowOptions
-
Prediction Options.