@promptbook/azure-openai/esm/typings/src/pipeline/PipelineJson/PipelineJson.d.ts

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

import type { string_formfactor_name } from '../../formfactors/_common/string_formfactor_name';
import type { ModelRequirements } from '../../types/ModelRequirements';
import type { string_filename } from '../../types/typeAliases';
import type { string_markdown_text } from '../../types/typeAliases';
import type { string_pipeline_url } from '../../types/typeAliases';
import type { string_relative_filename } from '../../types/typeAliases';
import type { string_semantic_version } from '../../types/typeAliases';
import type { PipelineString } from '../PipelineString';
import type { KnowledgePiecePreparedJson } from './KnowledgePieceJson';
import type { KnowledgeSourceJson } from './KnowledgeSourceJson';
import type { KnowledgeSourcePreparedJson } from './KnowledgeSourceJson';
import type { ParameterJson } from './ParameterJson';
import type { PersonaJson } from './PersonaJson';
import type { PersonaPreparedJson } from './PersonaJson';
import type { PreparationJson } from './PreparationJson';
import type { TaskJson } from './TaskJson';
/**
 * Represents a Promptbook pipeline defined in JSON format.
 * It represents a series of tasks chained together to form a pipeline / one big task with input and result parameters.
 *
 * Note: [🚉] This is fully serializable as JSON
 *
 * @see The main Promptbook documentation for more details: https://github.com/webgptorg/promptbook#promptbook
 */
export type PipelineJson = {
    /**
     * Unique identifier of the pipeline
     *
     * Note: It must be unique across all pipeline collections
     * Note: It must use HTTPs URL
     * Tip: You can do versioning in the URL
     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book@1.0.0
     * Warning: Do not hash part of the URL, hash part is used for identification of the task in the pipeline
     */
    readonly pipelineUrl?: string_pipeline_url;
    /**
     * Internal helper for tracking the source `.book` file of the pipeline
     */
    readonly sourceFile?: string_filename;
    /**
     * Title of the promptbook
     * -It can use simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
     */
    readonly title: string_markdown_text;
    /**
     * Version of the Book language
     *
     * @see https://github.com/webgptorg/book
     */
    readonly bookVersion?: string_semantic_version;
    /**
     * Description of the promptbook
     * It can use multiple paragraphs of simple markdown formatting like **bold**, *italic*, [link](https://example.com), ... BUT not code blocks and structure
     */
    readonly description?: string_markdown_text;
    /**
     * Name of the formfactor that the pipeline is shaped for
     */
    readonly formfactorName: string_formfactor_name;
    /**
     * Set of variables that are used across the pipeline
     */
    readonly parameters: Array<ParameterJson>;
    /**
     * Default model requirements for the model for all `tasks`
     */
    readonly defaultModelRequirements?: Partial<ModelRequirements>;
    /**
     * Sequence of tasks that are chained together to form a pipeline
     */
    readonly tasks: Array<TaskJson>;
    /**
     * Set of information that are used as external knowledge in the pipeline
     *
     * @see https://github.com/webgptorg/promptbook/discussions/41
     */
    readonly knowledgeSources: Array<KnowledgeSourceJson | KnowledgeSourcePreparedJson>;
    /**
     * Set of information that are used as external knowledge in the pipeline
     *
     * @see https://github.com/webgptorg/promptbook/discussions/41
     */
    readonly knowledgePieces: Array<KnowledgePiecePreparedJson>;
    /**
     * List of prepared virtual personas that are used in the pipeline
     *
     * @see https://github.com/webgptorg/promptbook/discussions/22
     */
    readonly personas: Array<PersonaJson | PersonaPreparedJson>;
    /**
     * List of prepared virtual personas that are used in the pipeline
     *
     * @see https://github.com/webgptorg/promptbook/discussions/78
     */
    readonly preparations: Array<PreparationJson>;
    /**
     * Backup of the original book source
     */
    readonly sources: ReadonlyArray<{
        type: 'BOOK';
        path: string_relative_filename | null;
        content: PipelineString;
    }>;
};
/**
 * TODO: [🌪] Make type for deprecated pipelines
 * TODO: [🛳] Default PERSONA for the pipeline `defaultPersonaName` (same as `defaultModelRequirements`)
 * TODO: [🍙] Make some standard order of json properties
 * TODO: [🧠] Maybe wrap all {parameterNames} in brackets for example { "resultingParameterName": "{foo}" }
 * Note: [💼] There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
 *       But then immediately reverted back to the single type
 *       With knowledge as part of the promptbook and collection just as a collection of promptbooks
 */