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

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

import { ReadonlyDeep } from 'type-fest';
import type { PipelineJson } from '../pipeline/PipelineJson/PipelineJson';
import type { Parameters } from '../types/typeAliases';
import type { AbstractTaskResult } from './AbstractTaskResult';
import type { ExecutionReportJson } from './execution-report/ExecutionReportJson';
import type { Usage } from './Usage';
/**
 * The result of executing a pipeline
 *
 * Note: [🚉] This is fully serializable as JSON
 */
export type PipelineExecutorResult = AbstractTaskResult & {
    /**
     * Result parameters of the execution
     *
     * Note: If the execution was not successful, there are only some of the result parameters
     */
    readonly outputParameters: Readonly<Parameters>;
    /**
     * Added usage of whole execution, detailed usage is available in `executionReport`
     */
    readonly usage: ReadonlyDeep<Usage>;
    /**
     * The report of the execution with all details
     *
     * Note: If the execution fails unexpectedly, this will be `null`
     */
    readonly executionReport: ReadonlyDeep<ExecutionReportJson> | null;
    /**
     * The prepared pipeline that was used for the execution
     *
     * Note: If you called `createPipelineExecutor` with fully prepared pipeline, this is the same object as this pipeline
     *       If you passed not fully prepared pipeline, this is same pipeline but fully prepared
     */
    readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
};
/**
 * TODO: [🧠] Should this file be in /execution or /types folder?
 */