Endpoint
extends BaseEndpoint
in package
Endpoint management.
Table of Contents
Properties
Methods
- __construct() : mixed
- documentQueueReqGet() : array<string|int, mixed>
- Retrieves a document from its queue ID.
- predictAsyncRequestPost() : array<string|int, mixed>
- Sends a document for synchronous enqueuing.
- predictRequestPost() : array<string|int, mixed>
- Sends a document for asynchronous enqueuing.
- setFinalCurlOpts() : array<string|int, mixed>
- initCurlSessionGet() : array<string|int, mixed>
- Starts a CURL session, using GET.
- initCurlSessionPost() : array<string|int, mixed>
- Starts a CURL session, using POST.
Properties
$owner
public
string
$owner
Name of the endpoint's owner.
$settings
public
MindeeApi|MindeeWorkflowApi
$settings
Settings of the endpoint.
$urlName
public
string
$urlName
Url (name) of then endpoint.
$version
public
string
$version
Version of the endpoint.
Methods
__construct()
public
__construct(string $urlName, string $owner, string $version, MindeeApi $settings) : mixed
Parameters
- $urlName : string
-
Url (name) of the endpoint.
- $owner : string
-
Name of the endpoint's owner.
- $version : string
-
Version of the endpoint.
- $settings : MindeeApi
-
Settings for the endpoint.
documentQueueReqGet()
Retrieves a document from its queue ID.
public
documentQueueReqGet(string $queueId) : array<string|int, mixed>
Parameters
- $queueId : string
-
ID of the queue to poll.
Return values
array<string|int, mixed>predictAsyncRequestPost()
Sends a document for synchronous enqueuing.
public
predictAsyncRequestPost(InputSource $fileCurl, PredictMethodOptions $options) : array<string|int, mixed>
Parameters
- $fileCurl : InputSource
-
File to upload.
- $options : PredictMethodOptions
-
Prediction Options.
Return values
array<string|int, mixed>predictRequestPost()
Sends a document for asynchronous enqueuing.
public
predictRequestPost(InputSource $fileCurl, PredictMethodOptions $options) : array<string|int, mixed>
Parameters
- $fileCurl : InputSource
-
File to upload.
- $options : PredictMethodOptions
-
Prediction Options.
Return values
array<string|int, mixed>setFinalCurlOpts()
public
setFinalCurlOpts(resource $ch, string $suffix, array<string|int, mixed>|null $postFields[, string|null $workflowId = null ]) : array<string|int, mixed>
Parameters
- $ch : resource
-
Curl Channel.
- $suffix : string
-
Optional suffix for the url call.
- $postFields : array<string|int, mixed>|null
-
Post fields.
- $workflowId : string|null = null
-
Optional ID of the workflow.
Return values
array<string|int, mixed>initCurlSessionGet()
Starts a CURL session, using GET.
protected
initCurlSessionGet(string $queueId) : array<string|int, mixed>
Parameters
- $queueId : string
-
ID of the queue to poll.
Return values
array<string|int, mixed>initCurlSessionPost()
Starts a CURL session, using POST.
private
initCurlSessionPost(InputSource $fileCurl, PredictMethodOptions $options, bool $async) : array<string|int, mixed>
Parameters
- $fileCurl : InputSource
-
File to upload.
- $options : PredictMethodOptions
-
Prediction Options.
- $async : bool
-
Whether to use the async endpoint.