@promptbook/remote-client
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
171 lines (170 loc) • 7.26 kB
TypeScript
/**
* All available formfactor definitions
*
* @public exported from `@promptbook/core`
*/
export declare const FORMFACTOR_DEFINITIONS: readonly [{
readonly name: "GENERIC";
readonly description: "A generic pipeline";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/173";
readonly pipelineInterface: {
readonly inputParameters: readonly [];
readonly outputParameters: readonly [];
};
}, {
readonly name: "CHATBOT";
readonly aliasNames: readonly ["CHAT"];
readonly description: "A chatbot form factor for conversational user interfaces.";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/174";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "previousTitle";
readonly description: "Previous title of the conversation";
readonly isInput: true;
readonly isOutput: false;
}, {
readonly name: "previousConversationSummary";
readonly description: "Previous conversation summary";
readonly isInput: true;
readonly isOutput: false;
}, {
readonly name: "userMessage";
readonly description: "User message";
readonly isInput: true;
readonly isOutput: false;
}];
readonly outputParameters: readonly [{
readonly name: "title";
readonly description: "Title of the conversation";
readonly isInput: false;
readonly isOutput: true;
}, {
readonly name: "conversationSummary";
readonly description: "Summary of the conversation";
readonly isInput: false;
readonly isOutput: true;
}, {
readonly name: "chatbotResponse";
readonly description: "Chatbot response";
readonly isInput: false;
readonly isOutput: true;
}];
};
}, {
readonly name: "TRANSLATOR";
readonly description: "A text transformation system that converts input content into different forms,\n including language translations, paraphrasing, style conversions, and tone adjustments.\n This form factor takes one input and produces one transformed output.";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/175";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "inputMessage";
readonly description: "Input message to be translated";
readonly isInput: true;
readonly isOutput: false;
}];
readonly outputParameters: readonly [{
readonly name: "outputMessage";
readonly description: "Translated output message";
readonly isInput: false;
readonly isOutput: true;
}];
};
}, {
readonly name: "SHEETS";
readonly aliasNames: readonly ["SHEETS", "SHEET"];
readonly description: "A formfactor for processing spreadsheet-like data in CSV format, enabling AI transformations on tabular data";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/176";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "inputSheet";
readonly description: "Input sheet to be processed as csv";
readonly isInput: true;
readonly isOutput: false;
}];
readonly outputParameters: readonly [{
readonly name: "outputSheet";
readonly description: "Output sheet as csv";
readonly isInput: false;
readonly isOutput: true;
}];
};
}, {
readonly name: "EXPERIMENTAL_MATCHER";
readonly description: "An evaluation system that determines whether content meets specific criteria or patterns.\n Used for content validation, quality assessment, and intelligent filtering tasks. Currently in experimental phase.";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/177";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "nonce";
readonly description: "Just to prevent EXPERIMENTAL_MATCHER to be set as implicit formfactor";
readonly isInput: true;
readonly isOutput: false;
}];
readonly outputParameters: readonly [];
};
}, {
readonly name: "GENERATOR";
readonly description: "Generates any kind (in HTML with possible scripts and css format) of content from input message";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "inputMessage";
readonly description: "Input message to be image made from";
readonly isInput: true;
readonly isOutput: false;
}];
readonly outputParameters: readonly [{
readonly name: "result";
readonly description: "Result in HTML to be shown to user";
readonly isInput: false;
readonly isOutput: true;
}];
};
}, {
readonly name: "IMAGE_GENERATOR";
readonly description: "Generates prompt for image generation from input message";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/184";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "inputMessage";
readonly description: "Input message to be image made from";
readonly isInput: true;
readonly isOutput: false;
}];
/**
* All available formfactor definitions
*
* @public exported from `@promptbook/core`
*/
readonly outputParameters: readonly [{
readonly name: "prompt";
readonly description: "Prompt to be used for image generation";
readonly isInput: false;
readonly isOutput: true;
}];
};
}, {
readonly name: "COMPLETION";
readonly description: "Completion is formfactor that emulates completion models";
readonly documentationUrl: "https://github.com/webgptorg/promptbook/discussions/@@";
readonly pipelineInterface: {
readonly inputParameters: readonly [{
readonly name: "inputText";
readonly description: "Input text to be completed";
readonly isInput: true;
readonly isOutput: false;
}, {
readonly name: "instructions";
readonly description: "Additional instructions for the model, for example the required length, empty by default";
readonly isInput: true;
readonly isOutput: false;
}];
readonly outputParameters: readonly [{
readonly name: "followingText";
readonly description: "Text that follows the input text";
readonly isInput: false;
readonly isOutput: true;
}];
};
}];
/**
* Note: [💞] Ignore a discrepancy between file name and entity name
*/