@promptbook/types
Advanced tools
Comparing version 0.27.0-0 to 0.27.0-1
@@ -6,3 +6,3 @@ import type { Promisable } from 'type-fest'; | ||
/** | ||
* Executor is a simple async function that takes input parameters and returns result parameters _(along with all intermediate parameters and input parameters = it extends input object)_. | ||
* Executor is a simple async function that takes INPUT PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT PARAMETERs = it extends input object)_. | ||
* Executor is made by combining execution tools and prompt template pipeline library. | ||
@@ -9,0 +9,0 @@ * |
import { string_name, string_script } from '.././types/typeAliases'; | ||
import { ScriptLanguage } from '../types/ScriptLanguage'; | ||
/** | ||
* Represents all the tools needed to execute scripts | ||
* Represents all the tools needed to EXECUTE SCRIPTs | ||
* | ||
@@ -6,0 +6,0 @@ * @see https://github.com/webgptorg/promptbook#script-execution-tools |
@@ -49,3 +49,3 @@ import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases'; | ||
* | ||
* - It can tell if it is input or output parameter | ||
* - It can tell if it is input or OUTPUT PARAMETER | ||
* - It can have description | ||
@@ -62,3 +62,3 @@ * - In description it can have simple formatting BUT not markdown structure or reference to other parameters | ||
* Postprocess command describes which function to use for postprocessing | ||
* This will be created as separate execute script block bellow | ||
* This will be created as separate EXECUTE SCRIPT block bellow | ||
*/ | ||
@@ -65,0 +65,0 @@ export interface PostprocessCommand { |
@@ -5,5 +5,5 @@ /** | ||
* There are three types of parameters: | ||
* - **Input parameters** are required to execute the prompt template pipeline. | ||
* - **INPUT PARAMETERs** are required to execute the prompt template pipeline. | ||
* - **Intermediate parameters** are used internally in the prompt template pipeline. | ||
* - **Output parameters** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution. | ||
* - **OUTPUT PARAMETERs** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution. | ||
* | ||
@@ -10,0 +10,0 @@ * @see https://github.com/webgptorg/promptbook#parameters |
@@ -15,3 +15,3 @@ import { string_name } from '../.././types/typeAliases'; | ||
* | ||
* Note: Output parameter is every parameter including input one | ||
* Note: OUTPUT PARAMETER is every parameter including input one | ||
*/ | ||
@@ -18,0 +18,0 @@ readonly isInput: boolean; |
{ | ||
"name": "@promptbook/types", | ||
"version": "0.27.0-0", | ||
"version": "0.27.0-1", | ||
"description": "Library to supercharge your use of large language models", | ||
@@ -38,3 +38,3 @@ "private": false, | ||
"peerDependencies": { | ||
"@promptbook/core": "0.27.0-0" | ||
"@promptbook/core": "0.27.0-1" | ||
}, | ||
@@ -41,0 +41,0 @@ "main": "./umd/index.umd.js", |
@@ -6,3 +6,3 @@ import type { Promisable } from 'type-fest'; | ||
/** | ||
* Executor is a simple async function that takes input parameters and returns result parameters _(along with all intermediate parameters and input parameters = it extends input object)_. | ||
* Executor is a simple async function that takes INPUT PARAMETERs and returns result parameters _(along with all intermediate parameters and INPUT PARAMETERs = it extends input object)_. | ||
* Executor is made by combining execution tools and prompt template pipeline library. | ||
@@ -9,0 +9,0 @@ * |
import { string_name, string_script } from '.././types/typeAliases'; | ||
import { ScriptLanguage } from '../types/ScriptLanguage'; | ||
/** | ||
* Represents all the tools needed to execute scripts | ||
* Represents all the tools needed to EXECUTE SCRIPTs | ||
* | ||
@@ -6,0 +6,0 @@ * @see https://github.com/webgptorg/promptbook#script-execution-tools |
@@ -49,3 +49,3 @@ import type { string_markdown_text, string_name, string_version } from '.././types/typeAliases'; | ||
* | ||
* - It can tell if it is input or output parameter | ||
* - It can tell if it is input or OUTPUT PARAMETER | ||
* - It can have description | ||
@@ -62,3 +62,3 @@ * - In description it can have simple formatting BUT not markdown structure or reference to other parameters | ||
* Postprocess command describes which function to use for postprocessing | ||
* This will be created as separate execute script block bellow | ||
* This will be created as separate EXECUTE SCRIPT block bellow | ||
*/ | ||
@@ -65,0 +65,0 @@ export interface PostprocessCommand { |
@@ -5,5 +5,5 @@ /** | ||
* There are three types of parameters: | ||
* - **Input parameters** are required to execute the prompt template pipeline. | ||
* - **INPUT PARAMETERs** are required to execute the prompt template pipeline. | ||
* - **Intermediate parameters** are used internally in the prompt template pipeline. | ||
* - **Output parameters** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution. | ||
* - **OUTPUT PARAMETERs** are not used internally in the prompt template pipeline, but are returned as the result of the prompt template pipeline execution. | ||
* | ||
@@ -10,0 +10,0 @@ * @see https://github.com/webgptorg/promptbook#parameters |
@@ -15,3 +15,3 @@ import { string_name } from '../.././types/typeAliases'; | ||
* | ||
* Note: Output parameter is every parameter including input one | ||
* Note: OUTPUT PARAMETER is every parameter including input one | ||
*/ | ||
@@ -18,0 +18,0 @@ readonly isInput: boolean; |
278602