mindee/src/http/workflowEndpoint.d.ts

Mindee Client Library for Node.js

import { BaseEndpoint, EndpointResponse } from "./baseEndpoint";
import { ApiSettings } from "./apiSettings";
import { InputSource } from "../input";
import { WorkflowParams } from "./httpParams";
import { ExecutionPriority } from "../parsing/common";
/**
 * Endpoint for a workflow.
 */
export declare class WorkflowEndpoint extends BaseEndpoint {
    #private;
    constructor(settings: ApiSettings, workflowId: string);
    /**
     * Sends a document to a workflow execution.
     * Throws an error if the server's response contains one.
     * @param {WorkflowParams} params parameters relating to prediction options.
     * @category Synchronous
     * @returns a `Promise` containing parsing results.
     */
    executeWorkflow(params: WorkflowParams): Promise<EndpointResponse>;
    /**
     * Send a file to a prediction API.
     * @param input
     * @param alias
     * @param priority
     * @param fullText
     * @param publicUrl
     * @param rag
     */
    protected sendFileForPrediction(input: InputSource, alias?: string | null, priority?: ExecutionPriority | null, fullText?: boolean, publicUrl?: string | null, rag?: boolean | null): Promise<EndpointResponse>;
}