Class WorkflowEndpoint

Endpoint for a workflow.

Index

Other

constructor settings urlRoot sendFileForPrediction

Synchronous

executeWorkflow

Other

constructor

new WorkflowEndpoint(
settings: ApiSettingsV1,
workflowId: string,
): WorkflowEndpoint
Parameters
- settings: ApiSettingsV1
- workflowId: string
Returns WorkflowEndpoint
- Defined in src/v1/http/workflowEndpoint.ts:25

settings

settings: ApiSettingsV1

Settings relating to the API.

urlRoot

urlRoot: string

Root of the URL for API calls.

`Protected`sendFileForPrediction

sendFileForPrediction(
    input: InputSource,
    alias?: string | null,
    priority?: ExecutionPriority | null,
    fullText?: boolean,
    publicUrl?: string | null,
    rag?: boolean | null,
): Promise<BaseHttpResponse>
Send a file to a prediction API.
Parameters
- input: InputSource
- alias: string | null = null
- priority: ExecutionPriority | null = null
- fullText: boolean = false
- publicUrl: string | null = null
- rag: boolean | null = null
Returns Promise<BaseHttpResponse>
- Defined in src/v1/http/workflowEndpoint.ts:77

Synchronous

executeWorkflow

executeWorkflow(params: WorkflowParams): Promise<BaseHttpResponse>
Sends a document to a workflow execution. Throws an error if the server's response contains one.
Parameters
- params: WorkflowParams
  parameters relating to prediction options.
Returns Promise<BaseHttpResponse>
a Promise containing parsing results.
- Defined in src/v1/http/workflowEndpoint.ts:40