Class WorkflowResponse<T>

Wrapper for workflow requests.

Type Parameters

T extends v1.Inference

Hierarchy

ApiResponse
- WorkflowResponse

Index

Constructors

Properties

apiRequest execution

Methods

Constructors

constructor

new WorkflowResponse<T extends v1.Inference<v1.Prediction, v1.Prediction>>(
inferenceClass: new (serverResponse: StringDict) => T,
serverResponse: StringDict,
): WorkflowResponse<T>
Type Parameters
- T extends v1.Inference<v1.Prediction, v1.Prediction>
Parameters
- inferenceClass: new (serverResponse: StringDict) => T
- serverResponse: StringDict
Returns WorkflowResponse<T>
Overrides ApiResponse.constructor
- Defined in src/v1/parsing/common/workflowResponse.ts:19

Properties

apiRequest

apiRequest: ApiRequest

Initial request sent to the API.

execution

execution: Execution<T>

Set the prediction model used to parse the document. The response object will be instantiated based on this parameter.

Methods

getRawHttp

getRawHttp(): StringDict
Raw HTTP request sent from server, as a JSON-like structure

Returns StringDict
The HTTP request
Inherited from ApiResponse.getRawHttp
- Defined in src/v1/parsing/common/apiResponse.ts:27