Class Endpoint

Endpoint for a product (OTS or Custom).

Index

Asynchronous

getQueuedDocument predictAsync

Other

constructor owner settings urlName urlRoot version getDocument sendFeedback sendFileForPrediction

Synchronous

Asynchronous

getQueuedDocument

getQueuedDocument(queueId: string): Promise<BaseHttpResponse>
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<BaseHttpResponse>
a Promise containing the parsed result.
- Defined in src/v1/http/endpoint.ts:116

predictAsync

predictAsync(params: PredictParams): Promise<BaseHttpResponse>
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<BaseHttpResponse>
a Promise containing queue data.
- Defined in src/v1/http/endpoint.ts:75

Other

constructor

new Endpoint(
    urlName: string,
    owner: string,
    version: string,
    settings: ApiSettingsV1,
): Endpoint
Parameters
- urlName: string
- owner: string
- version: string
- settings: ApiSettingsV1
Returns Endpoint
- Defined in src/v1/http/endpoint.ts:31

owner

owner: string

Account owning the product.

settings

settings: ApiSettingsV1

Settings relating to the API.

urlName

urlName: string

URL of a product.

urlRoot

urlRoot: string

Root of the URL for API calls.

version

version: string

Product's version, as a string.

getDocument

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

sendFeedback

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

`Protected`sendFileForPrediction

sendFileForPrediction(
    input: InputSource,
    predictUrl: string,
    includeWords?: boolean,
    fullText?: boolean,
    cropper?: boolean,
    rag?: boolean,
    workflowId?: string | undefined,
): Promise<BaseHttpResponse>
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: string | undefined = undefined
Returns Promise<BaseHttpResponse>
- Defined in src/v1/http/endpoint.ts:177

Synchronous

predict

predict(params: PredictParams): Promise<BaseHttpResponse>
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<BaseHttpResponse>
a Promise containing parsing results.
- Defined in src/v1/http/endpoint.ts:51