Class Endpoint

Endpoint for a product (OTS or Custom).

Hierarchy

BaseEndpoint
- Endpoint

Index

Asynchronous

Other

constructor owner settings urlName urlRoot version getDocument sendFeedback sendFileForPrediction useWorkflowId cutDocPages readResponse

Synchronous

predict

Asynchronous

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

predictAsync

predictAsync(params: PredictParams): Promise<EndpointResponse>
Enqueues a prediction to the API. Throws an error if the server's response contains one.
Parameters
- params: PredictParams
  parameters relating to prediction options.
Returns Promise<EndpointResponse>
a Promise containing queue data.
- Defined in src/http/endpoint.ts:76

Other

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:24

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.

getDocument

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

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:155

`Protected`sendFileForPrediction

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

useWorkflowId

useWorkflowId(workflowId: string): void
Changes the url to a workflow ID.
Parameters
- workflowId: string
Returns void
- Defined in src/http/endpoint.ts:40

`Static`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>
Inherited from BaseEndpoint.cutDocPages
- Defined in src/http/baseEndpoint.ts:37

`Static`readResponse

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

Synchronous

predict

predict(params: PredictParams): Promise<EndpointResponse>
Sends a document to the API and parses out the result. Throws an error if the server's response contains one.
Parameters
- params: PredictParams
  parameters relating to prediction options.
Returns Promise<EndpointResponse>
a Promise containing parsing results.
- Defined in src/http/endpoint.ts:51

Class Endpoint

Hierarchy

Index

Asynchronous

Other

Synchronous

Asynchronous

getQueuedDocument

Parameters

Returns Promise<EndpointResponse>

predictAsync

Parameters

Returns Promise<EndpointResponse>

Other

constructor

Parameters

Returns Endpoint

owner

settings

urlName

urlRoot

version

getDocument

Parameters

Returns Promise<EndpointResponse>

sendFeedback

Parameters

Returns Promise<EndpointResponse>

ProtectedsendFileForPrediction

Parameters

Returns Promise<EndpointResponse>

useWorkflowId

Parameters

Returns void

StaticcutDocPages

Parameters

Returns Promise<void>

StaticreadResponse

Parameters

Returns ClientRequest

Synchronous

predict

Parameters

Returns Promise<EndpointResponse>

Settings

On This Page

`Protected`sendFileForPrediction

`Static`cutDocPages

`Static`readResponse