@promptbook/types 0.67.0-2 → 0.67.0-4

package/README.md

@@ -65,37 +65,23 @@ Rest of the documentation is common for **entire promptbook ecosystem**:
 
 ## 🤍 The Promptbook Whitepaper
 
-When you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how it is integrated. Whether it's the direct calling of a REST API, using the SDK, hardcoding the prompt in 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 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 need something more advanced or want to extend the capabilities of LLMs, you generally have three ways to proceed:
+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:
 
 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. Use **multiple prompts** in a pipeline to get the best result.
-
-In any of these situations, but especially in (3), the Promptbook library can make your life easier and make **orchestraror for your prompts**.
-
--   **Separation of concerns** between prompt engineer and programmer; between code files and prompt files; and between prompts and their execution logic.
--   Set up a **common format** for prompts that is interchangeable between projects and language/technology stacks.
--   **Preprocessing** and cleaning the input data from the user.
--   Use default values - **Jokers** to bypass some parts of the pipeline.
--   **Expect** some specific output from the model.
--   **Retry** mismatched outputs.
--   **Combine** multiple models together.
--   Interactive **User interaction** with the model and the user.
--   Leverage **external** sources (like ChatGPT plugins or OpenAI's GPTs).
--   Simplify your code to be **DRY** and not repeat all the boilerplate code for each prompt.
--   **Versioning** of promptbooks
--   **Reuse** parts of promptbooks in/between projects.
--   Run the LLM **optimally** in parallel, with the best _cost/quality_ ratio or _speed/quality_ ratio.
--   **Execution report** to see what happened during the execution.
--   **Logging** the results of the promptbooks.
--   _(Not ready yet)_ **Caching** calls to LLMs to save money and time.
--   _(Not ready yet)_ Extend one prompt book from another one.
--   _(Not ready yet)_ Leverage the **streaming** to make super cool UI/UX.
--   _(Not ready yet)_ **A/B testing** to determine which prompt works best for the job.
+3. Use **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.
 
+-   [**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.
+-   **Forget** about **low-level details** like choosing the right model, tokens, context size, temperature, top-k, top-p, or kernel sampling. **Just write your intent** and [**persona**](https://github.com/webgptorg/promptbook/discussions/22) who should be responsible for the task and let the library do the rest.
+-   Has built-in **orchestration** of [pipeline](https://github.com/webgptorg/promptbook/discussions/64) execution and many tools to make the process easier, more reliable, and more efficient, such as caching, [compilation+preparation](https://github.com/webgptorg/promptbook/discussions/78), [just-in-time fine-tuning](https://github.com/webgptorg/promptbook/discussions/33), [expectation-aware generation](https://github.com/webgptorg/promptbook/discussions/37), [agent adversary expectations](https://github.com/webgptorg/promptbook/discussions/39), and more.
+-   Sometimes even the best prompts with the best framework like Promptbook `:)` can't avoid the problems. In this case, the library has built-in **[anomaly detection](https://github.com/webgptorg/promptbook/discussions/40) and logging** to help you find and fix the problems.
+-   Promptbook has built in versioning. You can test multiple **A/B versions** of pipelines and see which one works best.
+-   Promptbook is designed to do [**RAG** (Retrieval-Augmented Generation)](https://github.com/webgptorg/promptbook/discussions/41) and other advanced techniques. You can use **knowledge** to improve the quality of the output.
 
 ## 🧔 Promptbook _(for prompt-engeneers)_
 
@@ -139,9 +125,7 @@ File `write-website-content.ptbk.md`:
 >
 > ## ✨ Improving the title
 >
-> -   MODEL VARIANT Chat
-> -   MODEL NAME `gpt-4`
-> -   POSTPROCESSING `unwrapResult`
+> -   PERSONA Jane, Copywriter and Marketing Specialist.
 >
 > ```
 > As an experienced marketing specialist, you have been entrusted with improving the name of your client's business.
@@ -175,9 +159,7 @@ File `write-website-content.ptbk.md`:
 >
 > ## 🐰 Cunning subtitle
 >
-> -   MODEL VARIANT Chat
-> -   MODEL NAME `gpt-4`
-> -   POSTPROCESSING `unwrapResult`
+> -   PERSONA Josh, a copywriter, tasked with creating a claim for the website.
 >
 > ```
 > As an experienced copywriter, you have been entrusted with creating a claim for the "{title}" web page.
@@ -197,8 +179,7 @@ File `write-website-content.ptbk.md`:
 >
 > ## 🚦 Keyword analysis
 >
-> -   MODEL VARIANT Chat
-> -   MODEL NAME `gpt-4`
+> -   PERSONA Paul, extremely creative SEO specialist.
 >
 > ```
 > As an experienced SEO specialist, you have been entrusted with creating keywords for the website "{title}".
@@ -242,8 +223,7 @@ File `write-website-content.ptbk.md`:
 >
 > ## 🖋 Write the content
 >
-> -   MODEL VARIANT Completion
-> -   MODEL NAME `gpt-3.5-turbo-instruct`
+> -   PERSONA Jane
 >
 > ```
 > As an experienced copywriter and web designer, you have been entrusted with creating text for a new website {title}.
@@ -422,7 +402,12 @@ The following glossary is used to clarify certain concepts:
 
 ### ➖ When not to use
 
--   When you are writing just a simple chatbot without any extra logic, just system messages
+-   When you have already implemented single simple prompt and it works fine for your job
+-   When [OpenAI Assistant (GPTs)](https://help.openai.com/en/articles/8673914-gpts-vs-assistants) is enough for you
+-   When you need streaming _(this may be implemented in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/102))_.
+-   When you need to use something other than JavaScript or TypeScript _(other languages are on the way, [see the discussion](https://github.com/webgptorg/promptbook/discussions/101))_
+-   When your main focus is on something other than text - like images, audio, video, spreadsheets _(other media types may be added in the future, [see discussion](https://github.com/webgptorg/promptbook/discussions/103))_
+-   When you need to use recursion _([see the discussion](https://github.com/webgptorg/promptbook/discussions/38))_
 
 ## 🐜 Known issues
 
@@ -431,7 +416,6 @@ The following glossary is used to clarify certain concepts:
 
 ## 🧼 Intentionally not implemented features
 
-
 -   [➿ No recursion](https://github.com/webgptorg/promptbook/discussions/38)
 -   [🏳 There are no types, just strings](https://github.com/webgptorg/promptbook/discussions/52)
 

package/esm/typings/src/_packages/types.index.d.ts

@@ -157,7 +157,7 @@ import type { string_protocol } from '../types/typeAliases';
 import type { string_email } from '../types/typeAliases';
 import type { string_emails } from '../types/typeAliases';
 import type { string_uuid } from '../types/typeAliases';
-import type { client_id } from '../types/typeAliases';
+import type { string_user_id } from '../types/typeAliases';
 import type { string_sha256 } from '../types/typeAliases';
 import type { string_semantic_version } from '../types/typeAliases';
 import type { string_version_dependency } from '../types/typeAliases';
@@ -383,7 +383,7 @@ export type { string_protocol };
 export type { string_email };
 export type { string_emails };
 export type { string_uuid };
-export type { client_id };
+export type { string_user_id };
 export type { string_sha256 };
 export type { string_semantic_version };
 export type { string_version_dependency };

package/esm/typings/src/config.d.ts

@@ -30,6 +30,18 @@ export declare const LOOP_LIMIT = 1000;
  * @private within the repository - too low-level in comparison with other `MAX_...`
  */
 export declare const CHARACTER_LOOP_LIMIT = 100000;
+/**
+ * Timeout for the connections in milliseconds
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CONNECTION_TIMEOUT_MS: number;
+/**
+ * How many times to retry the connections
+ *
+ * @private within the repository - too low-level in comparison with other `MAX_...`
+ */
+export declare const CONNECTION_RETRIES_LIMIT = 5;
 /**
  * The maximum number of (LLM) tasks running in parallel
  *

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_ListModels_Request.d.ts

@@ -1,4 +1,3 @@
-import type { client_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
 /**
  * Socket.io progress for remote text generation
@@ -11,10 +10,6 @@ export type PromptbookServer_ListModels_CollectionRequest = {
      * Collection mode
      */
     isAnonymous: false;
-    /**
-     * Client responsible for the requests
-     */
-    readonly clientId: client_id;
 };
 export type PromptbookServer_ListModels_AnonymousRequest = {
     /**
@@ -29,6 +24,6 @@ export type PromptbookServer_ListModels_AnonymousRequest = {
 /**
  * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- * TODO: [🧠][🤺] Pass `clientId` in `PromptbookServer_ListModels_Request`
+ * TODO: [🧠][🤺] Pass `userId` in `PromptbookServer_ListModels_Request`
  * TODO: [👒] Listing models (and checking configuration) probbably should go through REST API not Socket.io
  */

package/esm/typings/src/llm-providers/remote/interfaces/PromptbookServer_Prompt_Request.d.ts

@@ -1,5 +1,5 @@
 import type { Prompt } from '../../../types/Prompt';
-import type { client_id } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
 /**
  * Socket.io progress for remote text generation
@@ -11,11 +11,14 @@ export type PromptbookServer_Prompt_CollectionRequest = {
     /**
      * Collection mode
      */
-    isAnonymous: false;
+    readonly isAnonymous: false;
     /**
-     * Client responsible for the requests
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
      */
-    readonly clientId: client_id;
+    readonly userId: string_user_id;
     /**
      * The Prompt to execute
      */
@@ -25,7 +28,14 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
     /**
      * Anonymous mode
      */
-    isAnonymous: true;
+    readonly isAnonymous: true;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId?: string_user_id;
     /**
      * Configuration for the LLM tools
      */
@@ -38,4 +48,4 @@ export type PromptbookServer_Prompt_AnonymousRequest = {
 /**
  * TODO: [👡] DRY `PromptbookServer_Prompt_Request` and `PromptbookServer_ListModels_Request`
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`
- */ 
+ */

package/esm/typings/src/llm-providers/remote/interfaces/RemoteLlmExecutionToolsOptions.d.ts

@@ -1,7 +1,7 @@
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
-import type { client_id } from '../../../types/typeAliases';
 import type { string_base_url } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
 import type { LlmToolsConfiguration } from '../../_common/LlmToolsConfiguration';
 /**
  * Options for `RemoteLlmExecutionTools`
@@ -34,15 +34,24 @@ export type RemoteLlmExecutionToolsOptions = CommonExecutionToolsOptions & {
      * Configuration for the LLM tools
      */
     readonly llmToolsConfiguration: LlmToolsConfiguration;
+    /**
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
+     * Note: In anonymous mode it is not required to identify
+     */
+    readonly userId?: string_user_id;
 } | {
     /**
      * Use anonymous server with client identification and fixed collection
      */
     isAnonymous: false;
     /**
-     * Your client ID
+     * Identifier of the end user
+     *
+     * Note: this is passed to the certain model providers to identify misuse
      */
-    readonly clientId: client_id;
+    readonly userId: string_user_id;
 });
 /**
  * TODO: [🧠][🛍] Maybe not `isAnonymous: boolean` BUT `mode: 'ANONYMOUS'|'COLLECTION'`

package/esm/typings/src/llm-providers/remote/interfaces/RemoteServerOptions.d.ts

@@ -1,8 +1,8 @@
 import type { PipelineCollection } from '../../../collection/PipelineCollection';
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
+import type { string_user_id } from '../../../types/typeAliases';
 /**
  * @@@
  *
@@ -50,7 +50,7 @@ export type CollectionRemoteServerOptions = {
     /**
      * Creates llm execution tools for each client
      */
-    createLlmExecutionTools(clientId: client_id): LlmExecutionTools;
+    createLlmExecutionTools(userId: string_user_id | undefined): LlmExecutionTools;
 };
 /**
  * TODO: Constrain anonymous mode for specific models / providers

package/esm/typings/src/llm-providers/remote/playground/playground.d.ts

@@ -1,2 +1,2 @@
 #!/usr/bin/env ts-node
-export {};
+import '../../openai/register-constructor';

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

@@ -391,11 +391,9 @@ export type string_uuid = string & {
     readonly _type: 'uuid';
 };
 /**
- * Branded type client id
+ * End user identifier;
  */
-export type client_id = string & {
-    readonly _type: 'client_id';
-};
+export type string_user_id = string;
 /**
  * Semantic helper
  *

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.67.0-2",
+    "version": "0.67.0-4",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,6 +45,6 @@
     ],
     "typings": "./esm/typings/src/_packages/types.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.67.0-2"
+        "@promptbook/core": "0.67.0-4"
     }
 }