@promptbook/openai 0.74.0-11 → 0.74.0-13

package/README.md

@@ -78,7 +78,7 @@ const tools = {
 const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
-const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book.md`);
 
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
@@ -120,7 +120,7 @@ const tools = await $provideExecutionToolsForNode();
 const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
-const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book.md`);
 
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
@@ -193,7 +193,7 @@ const tools = {
 const collection = await createCollectionFromDirectory('./promptbook-collection', tools);
 
 // ▶ Get single Pipeline
-const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.ptbk.md`);
+const pipeline = await collection.getPipelineByUrl(`https://promptbook.studio/my-collection/write-article.book.md`);
 
 // ▶ Create executor - the function that will execute the Pipeline
 const pipelineExecutor = createPipelineExecutor({ pipeline, tools });
@@ -324,7 +324,7 @@ Following is the documentation and blueprint of the Book language.
 
 File is designed to be easy to read and write. It is strict subset of markdown. It is designed to be understandable by both humans and machines and without specific knowledge of the language.
 
-It has file with `.ptbk.md` or `.book` extension with `UTF-8` non BOM encoding.
+It has file with `.book.md` or `.book` extension with `UTF-8` non BOM encoding.
 
 As it is source code, it can leverage all the features of version control systems like git and does not suffer from the problems of binary formats, proprietary formats, or no-code solutions.
 
@@ -417,11 +417,6 @@ Or you can install them separately:
 
 ## 📚 Dictionary
 
-
-
-
-
-
 ### 📚 Dictionary
 
 The following glossary is used to clarify certain concepts:
@@ -437,8 +432,6 @@ The following glossary is used to clarify certain concepts:
 -   **Retrieval-augmented generation** is a machine learning paradigm where a model generates text by retrieving relevant information from a large database of text. This approach combines the benefits of generative models and retrieval models.
 -   **Longtail** refers to non-common or rare events, items, or entities that are not well-represented in the training data of machine learning models. Longtail items are often challenging for models to predict accurately.
 
-
-
 _Note: Thos section is not complete dictionary, more list of general AI / LLM terms that has connection with Promptbook_
 
 #### Promptbook core
@@ -499,8 +492,6 @@ _Note: Thos section is not complete dictionary, more list of general AI / LLM te
 -   [👮 Agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39)
 -   [view more](https://github.com/webgptorg/promptbook/discussions/categories/concepts)
 
-
-
 ### Terms specific to Promptbook TypeScript implementation
 
 -   Anonymous mode

package/esm/index.es.js

@@ -14,7 +14,7 @@ var BOOK_LANGUAGE_VERSION = '1.0.0';
  *
  * @see https://github.com/webgptorg/promptbook
  */
-var PROMPTBOOK_ENGINE_VERSION = '0.74.0-10';
+var PROMPTBOOK_ENGINE_VERSION = '0.74.0-12';
 /**
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
  */

package/esm/typings/src/cli/promptbookCli.d.ts

@@ -5,7 +5,7 @@
  */
 export declare function promptbookCli(): Promise<void>;
 /**
- * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.ptbk.md` -> `ptbk ./foo.ptbk.md`
+ * TODO: [🧠] Maybe `run` command the default, instead of `ptbk run ./foo.book.md` -> `ptbk ./foo.book.md`
  * TODO: [🥠] Do not export, its just for CLI script
  * TODO: [🕌] When more functionalities, rename
  * Note: 11:11

package/esm/typings/src/collection/collectionToJson.test.d.ts

@@ -1,6 +1,6 @@
 export {};
 /**
- * Note: [🐠] For example here URL https://example.com/pipeline.ptbk.md is not valid
+ * Note: [🐠] For example here URL https://example.com/pipeline.book.md is not valid
  *       because it is on private network BUT its very hard to debug because
  *       there is no error message and false return (the error) happen deep in:
  *       `isValidPipelineUrl` -> `isValidPipelineUrl` -> `isUrlOnPrivateNetwork`

package/esm/typings/src/collection/constructors/createCollectionFromDirectory.d.ts

@@ -5,7 +5,7 @@ import type { PipelineCollection } from '../PipelineCollection';
 /**
  * Options for `createCollectionFromDirectory` function
  *
- * Note: `rootDirname` is not needed because it is the folder in which `.ptbk.md` file is located
+ * Note: `rootDirname` is not needed because it is the folder in which `.book.md` file is located
  *       This is not same as `path` which is the first argument of `createCollectionFromDirectory` - it can be a subfolder
  */
 type CreatePipelineCollectionFromDirectoryOptions = Omit<PrepareAndScrapeOptions, 'rootDirname'> & {

package/esm/typings/src/commands/BOOK_VERSION/BookVersionCommand.d.ts

@@ -7,5 +7,5 @@ import type { string_semantic_version } from '../../types/typeAliases';
  */
 export type BookVersionCommand = {
     readonly type: 'BOOK_VERSION';
-    readonly promptbookVersion: string_semantic_version;
+    readonly bookVersion: string_semantic_version;
 };

package/esm/typings/src/commands/FOREACH/foreachCommandParser.d.ts

@@ -3,12 +3,12 @@ import type { ForeachCommand } from './ForeachCommand';
 /**
  * Parses the foreach command
  *
- * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as foreach for new commands - it should NOT be used in any `.book.md` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder
  */
 export declare const foreachCommandParser: PipelineTemplateCommandParser<ForeachCommand>;
 /**
- * TODO: [🍭] Make .ptbk.md file with examples of the FOREACH with wrong parsing and logic
+ * TODO: [🍭] Make .book.md file with examples of the FOREACH with wrong parsing and logic
  */

package/esm/typings/src/commands/_BOILERPLATE/boilerplateCommandParser.d.ts

@@ -3,7 +3,7 @@ import type { BoilerplateCommand } from './BoilerplateCommand';
 /**
  * Parses the boilerplate command
  *
- * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.ptbk.md` file
+ * Note: @@@ This command is used as boilerplate for new commands - it should NOT be used in any `.book.md` file
  *
  * @see `documentationUrl` for more details
  * @private within the commands folder

package/esm/typings/src/conversion/pipelineJsonToString.d.ts

@@ -3,8 +3,8 @@ import type { PipelineString } from '../types/PipelineString';
 /**
  * Converts promptbook in JSON format to string format
  *
- * @param pipelineJson Promptbook in JSON format (.ptbk.json)
- * @returns Promptbook in string format (.ptbk.md)
+ * @param pipelineJson Promptbook in JSON format (.book.json)
+ * @returns Promptbook in string format (.book.md)
  * @public exported from `@promptbook/core`
  */
 export declare function pipelineJsonToString(pipelineJson: PipelineJson): PipelineString;
@@ -13,5 +13,5 @@ export declare function pipelineJsonToString(pipelineJson: PipelineJson): Pipeli
  * TODO: [🧠] Is there a way to auto-detect missing features in pipelineJsonToString
  * TODO: [🏛] Maybe make some markdown builder
  * TODO: [🏛] Escape all
- * TODO: [🧠] Should be in generated .ptbk.md file GENERATOR_WARNING
+ * TODO: [🧠] Should be in generated .book.md file GENERATOR_WARNING
  */

package/esm/typings/src/conversion/pipelineStringToJson.d.ts

@@ -13,10 +13,10 @@ import type { PipelineString } from '../types/PipelineString';
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
  * @param tools - Tools for the preparation and scraping - if not provided together with `llm`, the preparation will be skipped
  * @param options - Options and tools for the compilation
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/pipelineStringToJsonSync.d.ts

@@ -11,8 +11,8 @@ import type { PipelineString } from '../types/PipelineString';
  * Note: This function does not validate logic of the pipeline only the parsing
  * Note: This function acts as compilation process
  *
- * @param pipelineString {Promptbook} in string markdown format (.ptbk.md)
- * @returns {Promptbook} compiled in JSON format (.ptbk.json)
+ * @param pipelineString {Promptbook} in string markdown format (.book.md)
+ * @returns {Promptbook} compiled in JSON format (.book.json)
  * @throws {ParseError} if the promptbook string is not valid
  * @public exported from `@promptbook/core`
  */

package/esm/typings/src/conversion/utils/stringifyPipelineJson.d.ts

@@ -9,7 +9,7 @@ import type { string_json } from '../../types/typeAliases';
  */
 export declare function stringifyPipelineJson<TType>(pipeline: TType): string_json<TType>;
 /**
- * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.ptbk.md
+ * TODO: [🐝] Not Working propperly @see https://promptbook.studio/examples/mixed-knowledge.book.md
  * TODO: [🧠][0] Maybe rename to `stringifyPipelineJson`, `stringifyIndexedJson`,...
  * TODO: [🧠] Maybe more elegant solution than replacing via regex
  * TODO: [🍙] Make some standard order of json properties

package/esm/typings/src/conversion/validation/_importPipeline.d.ts

@@ -2,7 +2,7 @@ import type { PipelineJson } from '../../types/PipelineJson/PipelineJson';
 import type { PipelineString } from '../../types/PipelineString';
 import type { string_json } from '../../types/typeAliases';
 /**
- * Import the pipeline.ptbk.md or pipeline.ptbk.json file
+ * Import the pipeline.book.md or pipeline.book.json file
  *
  * Note: Using here custom import to work in jest tests
  * Note: Using sync version is 💩 in the production code, but it's ok here in tests
@@ -10,20 +10,20 @@ import type { string_json } from '../../types/typeAliases';
  * @param path - The path to the file relative to examples/pipelines directory
  * @private internal function of tests
  */
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.md`): PipelineString;
-export declare function importPipelineWithoutPreparation(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.md`): PipelineString;
+export declare function importPipelineWithoutPreparation(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as parsed JSON
+ * Import the pipeline.book.json file as parsed JSON
  *
  * @private internal function of tests
  */
-export declare function importPipelineJson(path: `${string}.ptbk.json`): PipelineJson;
+export declare function importPipelineJson(path: `${string}.book.json`): PipelineJson;
 /**
- * Import the pipeline.ptbk.json file as string
+ * Import the pipeline.book.json file as string
  *
  * @private internal function of tests
  */
-export declare function importPipelineJsonAsString(path: `${string}.ptbk.json`): string_json<PipelineJson>;
+export declare function importPipelineJsonAsString(path: `${string}.book.json`): string_json<PipelineJson>;
 /**
  * Note: [⚫] Code in this file should never be published in any package
  */

package/esm/typings/src/formats/_common/FormatDefinition.d.ts

@@ -13,7 +13,7 @@ import type { FormatSubvalueDefinition } from './FormatSubvalueDefinition';
  */
 export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends string, TSettings extends empty_object, TSchema extends empty_object> = {
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
      * @example "JSON"
      */

package/esm/typings/src/formats/_common/FormatSubvalueDefinition.d.ts

@@ -9,7 +9,7 @@ import type { empty_object } from '../../utils/organization/empty_object';
  */
 export type FormatSubvalueDefinition<TValue extends string, TSettings extends empty_object> = {
     /**
-     * The name of the format used in .ptbk.md files
+     * The name of the format used in .book.md files
      *
      * @example "CELL"
      */

package/esm/typings/src/types/PipelineJson/PipelineJson.d.ts

@@ -26,12 +26,12 @@ export type PipelineJson = {
      * 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.ptbk.md@1.0.0
+     *      For example: https://promptbook.studio/webgpt/write-website-content-cs.book.md@1.0.0
      * Warning: Do not hash part of the URL, hash part is used for identification of the template in the pipeline
      */
     readonly pipelineUrl?: string_pipeline_url;
     /**
-     * Internal helper for tracking the source `.ptbk.md` file of the pipeline
+     * Internal helper for tracking the source `.book.md` file of the pipeline
      */
     readonly sourceFile?: string_filename;
     /**
@@ -40,9 +40,11 @@ export type PipelineJson = {
      */
     readonly title: string_markdown_text;
     /**
-     * Version of the .ptbk.json file
+     * Version of the Book language
+     *
+     * @see https://github.com/webgptorg/book
      */
-    readonly promptbookVersion?: string_semantic_version;
+    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

package/esm/typings/src/types/PipelineJson/PreparationJson.d.ts

@@ -18,5 +18,5 @@ export type PreparationJson = {
 /**
  * TODO: [🍙] Make some standard order of json properties
  * TODO: Maybe put here used `modelName`
- * TODO: [🍥] When using `date` it changes all examples .ptbk.json files each time so until some more elegant solution omit the time from prepared pipeline
+ * TODO: [🍥] When using `date` it changes all examples .book.json files each time so until some more elegant solution omit the time from prepared pipeline
  */

package/esm/typings/src/types/Prompt.d.ts

@@ -95,7 +95,7 @@ export type CommonPrompt = {
     /**
      * Unique identifier of the pipeline with specific template name as hash
      *
-     * @example https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords
+     * @example https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords
      */
     readonly pipelineUrl?: string_pipeline_url_with_hashtemplate;
     /**

package/esm/typings/src/types/typeAliases.d.ts

@@ -298,13 +298,13 @@ export type string_base_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md"`
  */
 export type string_pipeline_url = string;
 /**
  * Semantic helper
  *
- * For example `"https://promptbook.studio/webgpt/write-website-content-cs.ptbk.md#keywords"`
+ * For example `"https://promptbook.studio/webgpt/write-website-content-cs.book.md#keywords"`
  */
 export type string_pipeline_url_with_hashtemplate = string;
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.74.0-11",
+    "version": "0.74.0-13",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -53,7 +53,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.74.0-11"
+        "@promptbook/core": "0.74.0-13"
     },
     "dependencies": {
         "colors": "1.4.0",

package/umd/index.umd.js

@@ -22,7 +22,7 @@
      *
      * @see https://github.com/webgptorg/promptbook
      */
-    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-10';
+    var PROMPTBOOK_ENGINE_VERSION = '0.74.0-12';
     /**
      * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
      */