Class Endpoint

Endpoint for a product (OTS or Custom).

Hierarchy

BaseEndpoint
- Endpoint

Index

Constructors

constructor

new Endpoint(urlName: string, owner: string, version: string, settings: ApiSettings): Endpoint
Parameters
- urlName: string
- owner: string
- version: string
- settings: ApiSettings
Returns Endpoint
Overrides BaseEndpoint.constructor
- Defined in src/http/endpoint.ts:35

Properties

owner

owner: string

Account owning the product.

settings

settings: ApiSettings

Settings relating to the API.

urlName

urlName: string

URL of a product.

urlRoot

urlRoot: string

Entire root of the URL for API calls.

version

version: string

Product's version, as a string.

Asynchronous Methods

getQueuedDocument

getQueuedDocument(queueId: string): Promise<EndpointResponse>
Requests the results of a queued document from the API. Throws an error if the server's response contains one.

Returns
a Promise containing the parsed result.
Parameters
- queueId: string
  
  The document's ID in the queue.
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:104

predictAsync

predictAsync(params: PredictParams): Promise<EndpointResponse>
Enqueues a prediction to the API. Throws an error if the server's response contains one.

Returns
a Promise containing queue data.
Parameters
- params: PredictParams
  
  parameters relating to prediction options.
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:80

Other Methods

`Private` #cutDocPages

#cutDocPages(inputDoc: InputSource, pageOptions: PageOptions): Promise<void>
Cuts a document's pages according to the given options.
Parameters
- inputDoc: InputSource
  
  input document.
- pageOptions: PageOptions
  
  page cutting options.
Returns Promise<void>
- Defined in src/http/endpoint.ts:217

`Private` #documentFeedbackPutReq

#documentFeedbackPutReq(documentId: string, feedback: StringDict): Promise<EndpointResponse>
Make a request to PUT a document feedback.
Parameters
- documentId: string
- feedback: StringDict
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:302

`Private` #documentGetReq

#documentGetReq(documentId: string): Promise<EndpointResponse>
Make a request to GET a document.
Parameters
- documentId: string
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:283

`Private` #documentQueueReqGet

#documentQueueReqGet(queueId: string): Promise<EndpointResponse>
Make a request to GET the status of a document in the queue.
Parameters
- queueId: string
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:265

`Private` #predictAsyncReqPost

#predictAsyncReqPost(input: InputSource, includeWords?: boolean, fullText?: boolean, cropper?: boolean): Promise<EndpointResponse>
Make a request to POST a document for async prediction.
Parameters
- input: InputSource
- includeWords: boolean = false
- fullText: boolean = false
- cropper: boolean = false
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:246

`Private` #predictReqPost

#predictReqPost(input: InputSource, includeWords?: boolean, fullText?: boolean, cropper?: boolean): Promise<EndpointResponse>
Make a request to POST a document for prediction.
Parameters
- input: InputSource
- includeWords: boolean = false
- fullText: boolean = false
- cropper: boolean = false
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:230

getDocument

getDocument(documentId: string): Promise<EndpointResponse>
Send a feedback
Parameters
- documentId: string
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:126

`Protected` readResponse

readResponse(options: RequestOptions, resolve: ((value: EndpointResponse | PromiseLike<EndpointResponse>) => void), reject: ((reason?: any) => void)): ClientRequest
Reads a response from the API and processes it.

Returns
the processed request.
Parameters
- options: RequestOptions
  
  options related to the request itself.
- resolve: ((value: EndpointResponse | PromiseLike<EndpointResponse>) => void)
  
  the resolved response
  - - (value: EndpointResponse | PromiseLike<EndpointResponse>): void
    - Parameters
      
      value: EndpointResponse | PromiseLike<EndpointResponse>
      
      Returns void
- reject: ((reason?: any) => void)
  
  promise rejection reason.
  - - (reason?: any): void
    - Parameters
      
      Optional reason: any
      
      Returns void
Returns ClientRequest
Inherited from BaseEndpoint.readResponse
- Defined in src/http/baseEndpoint.ts:32

sendFeedback

sendFeedback(documentId: string, feedback: StringDict): Promise<EndpointResponse>
Send a feedback
Parameters
- documentId: string
  
  ID of the document to send feedback to.
- feedback: StringDict
  
  Feedback object to send.
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:142

`Protected` sendFileForPrediction

sendFileForPrediction(input: InputSource, predictUrl: string, includeWords?: boolean, fullText?: boolean, cropper?: boolean): Promise<EndpointResponse>
Send a file to a prediction API.
Parameters
- input: InputSource
- predictUrl: string
- includeWords: boolean = false
- fullText: boolean = false
- cropper: boolean = false
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:165

Synchronous Methods

predict

predict(params: PredictParams): Promise<EndpointResponse>
Sends a prediction to the API and parses out the result. Throws an error if the server's response contains one.

Returns
a Promise containing parsing results.
Parameters
- params: PredictParams
  
  parameters relating to prediction options.
Returns Promise<EndpointResponse>
- Defined in src/http/endpoint.ts:55

Class Endpoint

Hierarchy

Index

Constructors

Properties

Methods - Asynchronous

Methods - Other

Methods - Synchronous

Constructors

constructor

Parameters

urlName: string

owner: string

version: string

settings: ApiSettings

Returns Endpoint

Properties

owner

settings

urlName

urlRoot

version

Asynchronous Methods

getQueuedDocument

Returns

Parameters

queueId: string

Returns Promise<EndpointResponse>

predictAsync

Returns

Parameters

params: PredictParams

Returns Promise<EndpointResponse>

Other Methods

Private #cutDocPages

Parameters

inputDoc: InputSource

pageOptions: PageOptions

Returns Promise<void>

Private #documentFeedbackPutReq

Parameters

documentId: string

feedback: StringDict

Returns Promise<EndpointResponse>

Private #documentGetReq

Parameters

documentId: string

Returns Promise<EndpointResponse>

Private #documentQueueReqGet

Parameters

queueId: string

Returns Promise<EndpointResponse>

Private #predictAsyncReqPost

Parameters

input: InputSource

includeWords: boolean = false

fullText: boolean = false

cropper: boolean = false

Returns Promise<EndpointResponse>

Private #predictReqPost

Parameters

input: InputSource

includeWords: boolean = false

fullText: boolean = false

cropper: boolean = false

Returns Promise<EndpointResponse>

getDocument

Parameters

documentId: string

Returns Promise<EndpointResponse>

Protected readResponse

Returns

Parameters

options: RequestOptions

resolve: ((value: EndpointResponse | PromiseLike<EndpointResponse>) => void)

Parameters

value: EndpointResponse | PromiseLike<EndpointResponse>

Returns void

reject: ((reason?: any) => void)

Parameters

`Private` #cutDocPages

`Private` #documentFeedbackPutReq

`Private` #documentGetReq

`Private` #documentQueueReqGet

`Private` #predictAsyncReqPost

`Private` #predictReqPost

`Protected` readResponse

`Optional` reason: any

`Protected` sendFileForPrediction