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

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

import type { Expectations } from '../../pipeline/PipelineJson/Expectations';
/**
 * Function checkExpectations will check if the expectations on given value are met
 *
 * Note: There are two similar functions:
 * - `checkExpectations` which throws an error if the expectations are not met
 * - `isPassingExpectations` which returns a boolean
 *
 * @throws {ExpectError} if the expectations are not met
 * @returns {void} Nothing
 * @private internal function of `createPipelineExecutor`
 */
export declare function checkExpectations(expectations: Expectations, value: string): void;
/**
 * Function checkExpectations will check if the expectations on given value are met
 *
 * Note: There are two similar functions:
 * - `checkExpectations` which throws an error if the expectations are not met
 * - `isPassingExpectations` which returns a boolean
 *
 * @returns {boolean} True if the expectations are met
 * @public exported from `@promptbook/core`
 */
export declare function isPassingExpectations(expectations: Expectations, value: string): boolean;
/**
 * TODO: [💝] Unite object for expecting amount and format
 * TODO: [🧠][🤠] This should be part of `TextFormatParser`
 * Note: [💝] and [🤠] are interconnected together
 */