@promptbook/openai 0.58.0 → 0.59.0-1

package/umd/typings/formats/_common/FormatDefinition.d.ts

@@ -12,6 +12,10 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @sample "JSON"
      */
     readonly name: string_name;
+    /**
+     * Aliases for the name
+     */
+    readonly aliases?: Array<string_name>;
     /**
      * The mime type of the format (if any)
      *
@@ -45,9 +49,21 @@ export type FormatDefinition<TValue extends TPartialValue, TPartialValue extends
      * @throws {Error} If the value cannot be healed
      */
     heal(value: string, scheme?: TSchema): TValue;
+    /**
+     * Parses just the values and removes structural information
+     *
+     * Note: This is useful when you want to combine format expectations with counting words, characters,...
+     *
+     * @param value The value to check, for example "{\"name\": "John Smith"}"
+     * @param schema Optional schema
+     * @example "{\"name\": "John Smith"}" -> ["John Smith"]
+     */
+    extractValues(value: string, schema?: TSchema): Array<string>;
 };
 /**
- * TODO: [👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
- * TODO: [🧠] Should execution tools be aviable to heal, canBeValid and isValid?
- * TODO: [🧠] llm Provider Bindings
- */
+ * TODO: [🍓]`name` and `aliases` should be UPPERCASE only and interpreted as case-insensitive (via normalization)
+ * TODO: [🍓][👨‍⚖️] Compute TPartialValue dynamically - PartialString<TValue>
+ * TODO: [🍓][🧠] Should execution tools be aviable to heal, canBeValid and isValid?
+ * TODO: [🍓][🧠] llm Provider Bindings
+ * TODO: [🍓]Export via some package
+ */ 

package/umd/typings/formats/csv/ListFormatDefinition.d.ts

@@ -0,0 +1,11 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for CSV spreadsheet
+ */
+export declare const CsvFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🍓] In `CsvFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `CsvFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `CsvFormatDefinition` implement `heal
+ * TODO: [🍓] In `CsvFormatDefinition` implement `extractValues`
+ */ 

package/umd/typings/formats/json/JsonFormatDefinition.d.ts

@@ -8,4 +8,8 @@ export declare const JsonFormatDefinition: FormatDefinition<string, string, obje
  * TODO: [0] Make string_serialized_json
  * TODO: [1] Make type for JSON Schema
  * TODO: [🧠] What to use for validating JSONs - JSON Schema, ZoD, typescript types/interfaces,...?
- */
+ * TODO: [🍓] In `JsonFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `JsonFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `JsonFormatDefinition` implement `heal
+ * TODO: [🍓] In `JsonFormatDefinition` implement `extractValues`
+ */ 

package/umd/typings/formats/list/ListFormatDefinition.d.ts

@@ -0,0 +1,13 @@
+import type { FormatDefinition } from '../_common/FormatDefinition';
+/**
+ * Definition for list of multiple items
+ *
+ * Note: list is just a string with multiple lines or multiple items separated by comma
+ */
+export declare const ListFormatDefinition: FormatDefinition<string, string, object>;
+/**
+ * TODO: [🍓] In `ListFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `ListFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `ListFormatDefinition` implement `heal
+ * TODO: [🍓] In `ListFormatDefinition` implement `extractValues`
+ */ 

package/umd/typings/formats/xml/XmlFormatDefinition.d.ts

@@ -8,4 +8,8 @@ export declare const XmlFormatDefinition: FormatDefinition<string, string, objec
  * TODO: [0] Make string_serialized_xml
  * TODO: [1] Make type for XML Schema
  * TODO: [🧠] What to use for validating XMLs - XSD,...
+ * TODO: [🍓] In `XmlFormatDefinition` implement simple `isValid`
+ * TODO: [🍓] In `XmlFormatDefinition` implement partial `canBeValid`
+ * TODO: [🍓] In `XmlFormatDefinition` implement `heal
+ * TODO: [🍓] In `XmlFormatDefinition` implement `extractValues`
  */

package/{esm/typings/knowledgebase → umd/typings/knowledge}/dialogs/simple-prompt/SimplePromptInterfaceTools.d.ts

@@ -9,7 +9,7 @@ import type { UserInterfaceToolsPromptDialogOptions } from '../../../execution/U
  */
 export declare class SimplePromptInterfaceTools implements UserInterfaceTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options?: CommonExecutionToolsOptions);
     /**
      * Trigger window.PROMPT DIALOG
      */

package/umd/typings/knowledge/prepare-knowledge/_common/IndexPreparer.d.ts

@@ -0,0 +1,4 @@
+export type IndexPreparer = {};
+/**
+ * TODO: Export via some package
+ */ 

package/umd/typings/knowledge/prepare-knowledge/markdown/playground/markdown-knowledge-playground.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env ts-node
+export {};

package/umd/typings/knowledge/prepare-knowledge/markdown/prepareKnowledgeFromMarkdown.d.ts

@@ -0,0 +1,7 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { string_markdown } from '../../../types/typeAliases';
+export declare function prepareKnowledgeFromMarkdown(options: {
+    content: string_markdown;
+    llmTools: LlmExecutionTools;
+}): Promise<KnowledgeJson>;

package/umd/typings/knowledge/prepare-knowledge/pdf/prepareKnowledgeFromPdf.d.ts

@@ -0,0 +1,16 @@
+import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
+import type { KnowledgeJson } from '../../../types/PromptbookJson/KnowledgeJson';
+import type { string_base64 } from '../../../types/typeAliases';
+type PrepareKnowledgeFromPdfOptions = {
+    /**
+     * The source of the knowledge in PDF format
+     */
+    content: string_base64;
+    llmTools: LlmExecutionTools;
+};
+export declare function prepareKnowledgeFromPdf(options: PrepareKnowledgeFromPdfOptions): Promise<KnowledgeJson>;
+export {};
+/**
+ * TODO: [🧺] In future, content can be alse File or Blob BUT for now for wider compatibility its only base64
+ *       @see https://stackoverflow.com/questions/14653349/node-js-cant-create-blobs
+ */

package/umd/typings/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts

@@ -18,7 +18,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
      *
      * @param options which are relevant are directly passed to the Anthropic Claude client
      */
-    constructor(options: AnthropicClaudeExecutionToolsOptions);
+    constructor(options?: AnthropicClaudeExecutionToolsOptions);
     /**
      * Calls Anthropic Claude API to use a chat model.
      */
@@ -37,6 +37,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
     listModels(): Array<AvailableModel>;
 }
 /**
+ * TODO: !!!! [🍆] JSON mode
  * TODO: [🧠] Maybe handle errors via transformAnthropicError (like transformAzureError)
  * TODO: Maybe Create some common util for gptChat and gptComplete
  * TODO: Maybe make custom OpenaiError

package/umd/typings/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -9,7 +9,7 @@ import type { Prompt } from '../../types/Prompt';
  */
 export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options?: CommonExecutionToolsOptions);
     /**
      * Mocks chat model
      */

package/umd/typings/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -9,7 +9,7 @@ import type { Prompt } from '../../types/Prompt';
  */
 export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options?: CommonExecutionToolsOptions);
     /**
      * Fakes chat model
      */

package/umd/typings/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -18,7 +18,7 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      *
      * @param options which are relevant are directly passed to the OpenAI client
      */
-    constructor(options: OpenAiExecutionToolsOptions);
+    constructor(options?: OpenAiExecutionToolsOptions);
     /**
      * Calls OpenAI API to use a chat model.
      */

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

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../../../execution/CommonExecutionToolsOptions';
 import type { LlmExecutionTools } from '../../../execution/LlmExecutionTools';
-import type { PromptbookLibrary } from '../../../library/PromptbookLibrary';
+import type { PromptbookLibrary } from '../../../promptbook-library/PromptbookLibrary';
 import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {

package/{esm/typings/library → umd/typings/promptbook-library}/constructors/createPromptbookLibraryFromDirectory.d.ts

@@ -41,3 +41,6 @@ type CreatePromptbookLibraryFromDirectoryOptions = {
  */
 export declare function createPromptbookLibraryFromDirectory(path: string_folder_path, options?: CreatePromptbookLibraryFromDirectoryOptions): Promise<PromptbookLibrary>;
 export {};
+/**
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */

package/umd/typings/{library → promptbook-library}/constructors/createPromptbookLibraryFromPromise.d.ts

@@ -21,3 +21,6 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * @deprecated Do not use, it will became internal tool for other constructor functions
  */
 export declare function createPromptbookLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson | PromptbookString>> | (() => Promise<Array<PromptbookJson | PromptbookString>>)): PromptbookLibrary;
+/**
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */ 

package/{esm/typings/library → umd/typings/promptbook-library}/constructors/createPromptbookLibraryFromSources.d.ts

@@ -10,4 +10,7 @@ import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): SimplePromptbookLibrary;
+export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
+/**
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */ 

package/umd/typings/{library → promptbook-library}/constructors/createPromptbookLibraryFromUrl.d.ts

@@ -24,3 +24,6 @@ type CreatePromptbookLibraryFromUrlyOptions = {
  */
 export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
 export {};
+/**
+ * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
+ */

package/umd/typings/scripting/python/PythonExecutionTools.d.ts

@@ -8,7 +8,7 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  */
 export declare class PythonExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options?: CommonExecutionToolsOptions);
     /**
      * Executes a Python
      */

package/umd/typings/scripting/typescript/TypescriptExecutionTools.d.ts

@@ -8,7 +8,7 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  */
 export declare class TypescriptExecutionTools implements ScriptExecutionTools {
     private readonly options;
-    constructor(options: CommonExecutionToolsOptions);
+    constructor(options?: CommonExecutionToolsOptions);
     /**
      * Executes a TypeScript
      */

package/umd/typings/types/PromptbookJson/KnowledgeJson.d.ts

@@ -0,0 +1,6 @@
+import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
+export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
+/**
+ * !!!! Annotate
+ * TODO: [🦪]
+ */

package/umd/typings/types/PromptbookJson/MaterialKnowledgePieceJson.d.ts

@@ -0,0 +1,27 @@
+import { IVectorData } from 'xyzt';
+import type { string_keyword } from '../../utils/normalization/IKeywords';
+import type { string_href } from '../typeAliases';
+import type { string_markdown } from '../typeAliases';
+import type { string_markdown_text } from '../typeAliases';
+import type { string_model_name } from '../typeAliases';
+import type { string_name } from '../typeAliases';
+export type MaterialKnowledgePieceJson = {
+    readonly name: string_name;
+    readonly title: string_markdown_text;
+    readonly content: string_markdown;
+    readonly keywords: Array<string_keyword>;
+    readonly index: Array<{
+        modelName: string_model_name;
+        position: IVectorData;
+    }>;
+    readonly sources: Array<{
+        title: string_markdown_text;
+        href: string_href;
+    }>;
+};
+/**
+ * !!!! Annotate
+ * TODO: [🧠][🦪] Maybe allow internal linkes between (Material)KnowledgePieces withing the KnowledgeJson and maybe require to explicitelly reference the source of the knowledge
+ * TODO: [🧠] Make some non-material sources like external search engine or dialog to user
+ * TODO: [🧠] Make some non-material (and maybe non-knowledge-like but tool-like) sources like calculator, code interpreter
+ */

package/umd/typings/types/PromptbookJson/PromptbookJson.d.ts

@@ -1,6 +1,7 @@
 import type { string_markdown_text } from '../typeAliases';
 import type { string_promptbook_url } from '../typeAliases';
 import type { string_version } from '../typeAliases';
+import type { KnowledgeJson } from './KnowledgeJson';
 import type { PromptTemplateJson } from './PromptTemplateJson';
 import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
@@ -42,12 +43,13 @@ export type PromptbookJson = {
      * Sequence of prompt templates that are chained together to form a pipeline
      */
     readonly promptTemplates: Array<PromptTemplateJson>;
+    /**
+     * Set of information that are used as external knowledge in the pipeline
+     */
+    readonly knowledge: KnowledgeJson;
 };
 /**
- * TODO: [🧠] Best format of this code?
- *             There must be possible to make
- *             - Branching
- *             - Loops
- *             - Paralelization
- *             - ...and more
+ * Note: There was a proposal for multiple types of promptbook objects 78816ff33e2705ee1a187aa2eb8affd976d4ea1a
+ *       But then immediately reverted back to the single type
+ *       With knowledge as part of the promptbook and library just as a collection of promptbooks
  */

package/umd/typings/types/typeAliases.d.ts

@@ -193,7 +193,13 @@ export type string_promptbook_url_with_hashtemplate = string;
  *
  * For example `"data:text/plain;base64,SGVsbG8sIFdvcmxkIQ=="`
  */
-export type string_data_url = string;
+export type string_data_url = `data:${string_mime_type};base64,${string_base64}`;
+/**
+ * Semantic helper
+ *
+ * For example `"SGVsbG8sIFdvcmxkIQ=="`
+ */
+export type string_base64 = string;
 /**
  * Semantic helper
  *

package/esm/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts

@@ -1 +0,0 @@
-export {};

package/esm/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/custom-function-async.test.ts.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/custom-function-missing.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/custom-function-with-dependencies.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/custom-function.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/postprocessing.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/script-execution-errors.test.d.ts

@@ -1 +0,0 @@
-export {};

package/umd/typings/execution/plugins/script-execution-tools/script-execution-tools.test.d.ts

@@ -1 +0,0 @@
-export {};