@promptbook/azure-openai/esm/typings/src/execution/AbstractTaskResult.d.ts

Promptbook: Run AI apps in plain human language across multiple models and platforms

import { ReadonlyDeep } from 'type-fest';
import type { ErrorJson } from '../errors/utils/ErrorJson';
/**
 * Represents the result of execution of a task in a pipeline
 *
 * Note: [🚉] This is fully serializable as JSON
 */
export type AbstractTaskResult = {
    /**
     * Whether the execution was successful, details are available in `executionReport`
     */
    readonly isSuccessful: boolean;
    /**
     * Errors that occurred during the execution, details are available in `executionReport`
     */
    readonly errors: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
    /**
     * Warnings that occurred during the execution, details are available in `executionReport`
     */
    readonly warnings: ReadonlyDeep<ReadonlyArray<ErrorJson>>;
};
/**
 * TODO: [🧠] Should this file be in /execution or /types folder?
 * TODO: [🧠] Maybe constrain `ErrorJson` -> `ErrorJson & { name: 'PipelineExecutionError' | 'Error' }`
 */