@ifzai/connect2dify/dist/workflow.d.ts

A comprehensive TypeScript client for the Dify API, providing a clean and modular interface for chat, workflow, file management, and application interactions.

/**
 * Workflow-related API methods for Dify client
 */
import type { DifyConfiguration, GetWorkflowLogsParams, GetWorkflowLogsResult, GetWorkflowParams, GetWorkflowResult, StopWorkflowTaskParams, StopWorkflowTaskResult, WorkflowChunkResponse, WorkflowCompletionResponse, WorkflowRunParams } from './types.js';
/**
 * Workflow API methods
 */
export declare class WorkflowAPI {
    private config;
    constructor(config: DifyConfiguration);
    /**
     * Run a workflow
     * @param params - Workflow run parameters
     * @returns Promise resolving to workflow completion response or stream chunks
     */
    runWorkflow(params: WorkflowRunParams): Promise<WorkflowCompletionResponse | WorkflowChunkResponse[]>;
    /**
     * Get workflow run execution result
     * @param params - Query parameters containing workflow_run_id
     * @returns Promise resolving to workflow run result
     */
    getWorkflow(params: GetWorkflowParams): Promise<GetWorkflowResult>;
    /**
     * Stop a workflow task
     * @param params - Stop parameters
     * @returns Promise resolving to stop result
     */
    stopWorkflowTask(params: StopWorkflowTaskParams): Promise<StopWorkflowTaskResult>;
    /**
     * Get workflow execution logs
     * @param params - Query parameters
     * @returns Promise resolving to workflow logs
     */
    getWorkflowLogs(params: GetWorkflowLogsParams): Promise<GetWorkflowLogsResult>;
    /**
     * Handle workflow streaming responses
     * @private
     */
    private handleWorkflowStream;
}