@promptbook/openai 0.72.0-33 → 0.72.0-34

package/README.md

@@ -228,15 +228,15 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 
 
-If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
+If you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 3, or whatever, it doesn't matter how you integrate it. Whether it's calling a REST API directly, using the SDK, hardcoding the prompt into the source code, or importing a text file, the process remains the same.
 
-But often you will struggle with the limitations of LLMs, such as hallucinations, off-topic responses, poor quality output, language drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses. When this happens, you generally have three options:
+But often you will struggle with the **limitations of LLMs**, such as **hallucinations, off-topic responses, poor quality output, language and prompt drift, word repetition repetition repetition repetition or misuse, lack of context, or just plain w𝒆𝐢rd responses**. When this happens, you generally have three options:
 
 1. **Fine-tune** the model to your specifications or even train your own.
 2. **Prompt-engineer** the prompt to the best shape you can achieve.
 3. Orchestrate **multiple prompts** in a [pipeline](https://github.com/webgptorg/promptbook/discussions/64) to get the best result.
 
-In all of these situations, but especially in 3., the Promptbook library can make your life easier.
+In all of these situations, but especially in 3., the **✨ Promptbook can make your life waaaaaaaaaay easier**.
 
 -   [**Separates concerns**](https://github.com/webgptorg/promptbook/discussions/32) between prompt-engineer and programmer, between code files and prompt files, and between prompts and their execution logic.
 -   Establishes a [**common format `.ptbk.md`**](https://github.com/webgptorg/promptbook/discussions/85) that can be used to describe your prompt business logic without having to write code or deal with the technicalities of LLMs.

package/esm/index.es.js

@@ -6,7 +6,7 @@ import OpenAI from 'openai';
 /**
  * The version of the Promptbook library
  */
-var PROMPTBOOK_VERSION = '0.72.0-32';
+var PROMPTBOOK_VERSION = '0.72.0-33';
 // TODO: [main] !!!! List here all the versions and annotate + put into script
 
 /*! *****************************************************************************
@@ -1850,11 +1850,11 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             assistant_id: this.assistantId,
                             thread: {
                                 messages: [
-                                    // TODO:  [🗯] !!!!!! Allow threads to be passed
+                                    // TODO:  [🗯] !! Allow threads to be passed
                                     { role: 'user', content: rawPromptContent },
                                 ],
                             },
-                            // !!!!!! user: this.options.user,
+                            // <- TODO: Add user identification here> user: this.options.user,
                         };
                         start = getCurrentIsoDate();
                         if (this.options.isVerbose) {
@@ -1905,7 +1905,7 @@ var OpenAiAssistantExecutionTools = /** @class */ (function (_super) {
                             throw new PipelineExecutionError("There is NOT 'text' BUT ".concat((_b = rawResponse[0].content[0]) === null || _b === void 0 ? void 0 : _b.type, " finalMessages content type from OpenAI"));
                         }
                         resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
-                        //                                                     <- TODO: !!!!!! There are also annotations, maybe use them
+                        //                                                     <- TODO: [🧠] There are also annotations, maybe use them
                         // eslint-disable-next-line prefer-const
                         complete = getCurrentIsoDate();
                         usage = UNCERTAIN_USAGE;

package/esm/typings/src/executables/apps/locateLibreoffice.d.ts

@@ -4,7 +4,7 @@ import type { string_executable_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function locateLibreoffice(): Promise<string_executable_path>;
+export declare function locateLibreoffice(): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/legacy-documents`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/apps/locatePandoc.d.ts

@@ -4,7 +4,7 @@ import type { string_executable_path } from '../../types/typeAliases';
  *
  * @private within the repository
  */
-export declare function locatePandoc(): Promise<string_executable_path>;
+export declare function locatePandoc(): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node` OR `@promptbook/documents`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/locateApp.d.ts

@@ -26,7 +26,7 @@ export interface LocateAppOptions {
  *
  * @private within the repository
  */
-export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path>;
+export declare function locateApp(options: RequireAtLeastOne<LocateAppOptions, 'linuxWhich' | 'windowsSuffix' | 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnLinux.d.ts

@@ -1,11 +1,11 @@
-import type { LocateAppOptions } from '../locateApp';
 import type { string_executable_path } from '../../types/typeAliases';
+import type { LocateAppOptions } from '../locateApp';
 /**
  * @@@
  *
  * @private within the repository
  */
-export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path>;
+export declare function locateAppOnLinux({ appName, linuxWhich, }: Pick<Required<LocateAppOptions>, 'appName' | 'linuxWhich'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnMacOs.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path>;
+export declare function locateAppOnMacOs({ appName, macOsName, }: Pick<Required<LocateAppOptions>, 'appName' | 'macOsName'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/esm/typings/src/executables/platforms/locateAppOnWindows.d.ts

@@ -5,7 +5,7 @@ import type { LocateAppOptions } from '../locateApp';
  *
  * @private within the repository
  */
-export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path>;
+export declare function locateAppOnWindows({ appName, windowsSuffix, }: Pick<Required<LocateAppOptions>, 'appName' | 'windowsSuffix'>): Promise<string_executable_path | null>;
 /**
  * TODO: [🧠][♿] Maybe export through `@promptbook/node`
  * Note: [🟢] Code in this file should never be never released in packages that could be imported into browser environment

package/package.json

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

package/umd/index.umd.js

@@ -14,7 +14,7 @@
     /**
      * The version of the Promptbook library
      */
-    var PROMPTBOOK_VERSION = '0.72.0-32';
+    var PROMPTBOOK_VERSION = '0.72.0-33';
     // TODO: [main] !!!! List here all the versions and annotate + put into script
 
     /*! *****************************************************************************
@@ -1858,11 +1858,11 @@
                                 assistant_id: this.assistantId,
                                 thread: {
                                     messages: [
-                                        // TODO:  [🗯] !!!!!! Allow threads to be passed
+                                        // TODO:  [🗯] !! Allow threads to be passed
                                         { role: 'user', content: rawPromptContent },
                                     ],
                                 },
-                                // !!!!!! user: this.options.user,
+                                // <- TODO: Add user identification here> user: this.options.user,
                             };
                             start = getCurrentIsoDate();
                             if (this.options.isVerbose) {
@@ -1913,7 +1913,7 @@
                                 throw new PipelineExecutionError("There is NOT 'text' BUT ".concat((_b = rawResponse[0].content[0]) === null || _b === void 0 ? void 0 : _b.type, " finalMessages content type from OpenAI"));
                             }
                             resultContent = (_c = rawResponse[0].content[0]) === null || _c === void 0 ? void 0 : _c.text.value;
-                            //                                                     <- TODO: !!!!!! There are also annotations, maybe use them
+                            //                                                     <- TODO: [🧠] There are also annotations, maybe use them
                             // eslint-disable-next-line prefer-const
                             complete = getCurrentIsoDate();
                             usage = UNCERTAIN_USAGE;