Class Client

Mindee Client V2 class that centralizes most basic operations.

Index

Constructors

Properties

Methods

enqueue enqueueAndGetResult getJob getResult getResultByUrl pollForResult

Constructors

constructor

new Client(options?: ClientOptions): Client
Parameters
- options: ClientOptions = ...
  options for the initialization of a client.
Returns Client
- Defined in src/v2/client.ts:41

Properties

`Protected`mindeeApi

mindeeApi: MindeeApiV2

Mindee V2 API handler.

Methods

enqueue

enqueue<P extends typeof BaseProduct>(
    product: P,
    inputSource: InputSource,
    params:
        | InstanceType<P["parametersClass"]>
        | ConstructorParameters<P["parametersClass"]>[0],
): Promise<JobResponse>
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
- inputSource: InputSource
- params:
  | InstanceType<P["parametersClass"]>
  | ConstructorParameters<P["parametersClass"]>[0]
Returns Promise<JobResponse>
- Defined in src/v2/client.ts:57

enqueueAndGetResult

enqueueAndGetResult<P extends typeof BaseProduct>(
    product: P,
    inputSource: InputSource,
    params:
        | InstanceType<P["parametersClass"]>
        | ConstructorParameters<P["parametersClass"]>[0],
    pollingOptions?: PollingOptionsConstructor,
): Promise<InstanceType<P["responseClass"]>>
Enqueue a request and poll the server until the result is sent or until the maximum number of tries is reached.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
  the product to retrieve.
- inputSource: InputSource
  file or URL to parse.
- params:
  | InstanceType<P["parametersClass"]>
  | ConstructorParameters<P["parametersClass"]>[0]
  parameters relating to prediction options.
- OptionalpollingOptions: PollingOptionsConstructor
  options for the polling loop, see PollingOptions.
Returns Promise<InstanceType<P["responseClass"]>>
a Promise containing parsing results.
- Defined in src/v2/client.ts:144

getJob

getJob(jobId: string): Promise<JobResponse>
Get the processing status of a previously enqueued request. Can be used for polling.
Parameters
- jobId: string
  id of the queue to poll.
Returns Promise<JobResponse>
a Promise containing a Job, which also contains a Document if the parsing is complete.
- Defined in src/v2/client.ts:128

getResult

getResult<P extends typeof BaseProduct>(
product: P,
inferenceId: string,
): Promise<InstanceType<P["responseClass"]>>
Retrieves the result of a previously enqueued request.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
  the product to retrieve.
- inferenceId: string
  id of the queue to poll.
Returns Promise<InstanceType<P["responseClass"]>>
a Promise containing the inference.
- Defined in src/v2/client.ts:90

getResultByUrl

getResultByUrl<P extends typeof BaseProduct>(
product: P,
url: string,
): Promise<InstanceType<P["responseClass"]>>
Retrieves the result of a previously enqueued request. This method is used when manually polling the server for the result URL.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: P
  the product to retrieve.
- url: string
  URL as given in the getJob() response.
Returns Promise<InstanceType<P["responseClass"]>>
a Promise containing the inference.
- Defined in src/v2/client.ts:109

`Protected`pollForResult

pollForResult<P extends typeof BaseProduct>(
    product: typeof BaseProduct,
    pollingOptions: PollingOptions,
    jobId: string,
): Promise<InstanceType<P["responseClass"]>>
Protected
Send a document to an endpoint and poll the server until the result is sent or until the maximum number of tries is reached.
Type Parameters
- P extends typeof BaseProduct
Parameters
- product: typeof BaseProduct
- pollingOptions: PollingOptions
- jobId: string
Returns Promise<InstanceType<P["responseClass"]>>
- Defined in src/v2/client.ts:167