@promptbook/langtail
Version:
It's time for a paradigm shift. The future of software in plain English, French or Latin
46 lines (45 loc) • 1.41 kB
TypeScript
import type { ChatModelRequirements } from '../../types/ModelRequirements';
import type { number_id } from '../../types/typeAliases';
import type { string_name } from '../../types/typeAliases';
import type { string_persona_description } from '../../types/typeAliases';
/**
* Defines a persona in the pipeline
*
* Note: [🚉] This is fully serializable as JSON
*
* @see https://github.com/webgptorg/promptbook/discussions/22
*/
export type PersonaJson = {
/**
* Name of the persona
* - It must be unique across the pipeline
* - It should start uppercase and can contain letters and numbers
*/
readonly name: string_name;
/**
* Description of persona
*/
readonly description: string_persona_description;
};
/**
* Defines a persona in the pipeline after it has been prepared
*
* Note: [🚉] This is fully serializable as JSON
*
* @see https://github.com/webgptorg/promptbook/discussions/22
*/
export type PersonaPreparedJson = PersonaJson & {
/**
* Model requirements for the persona
*
* Note: The model must be CHAT variant to be usable through persona
*/
readonly modelRequirements: ChatModelRequirements;
/**
* List of preparation ids that were used to prepare this persona
*/
readonly preparationIds: ReadonlyArray<number_id>;
};
/**
* TODO: [🍙] Make some standard order of json properties
*/