@promptbook/openai 0.59.0-3 → 0.59.0-30

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

@@ -1,5 +1,4 @@
 import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
  * Constructs Promptbook from async sources
@@ -8,19 +7,16 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * - Factory function that returns Promise of array of PromptbookJson or PromptbookString
  *
  * Note: This is useful as internal tool for other constructor functions like
- *       `createPromptbookLibraryFromUrl` or `createPromptbookLibraryFromDirectory`
+ *       `createLibraryFromUrl` or `createLibraryFromDirectory`
  *       Consider using those functions instead of this one
  *
  * Note: The function does NOT return promise it returns the library directly which waits for the sources to be resolved
  *       when error occurs in given promise or factory function, it is thrown during `listPromptbooks` or `getPromptbookByUrl` call
  *
- * Note: Consider using  `createPromptbookLibraryFromDirectory` or `createPromptbookLibraryFromUrl`
+ * Note: Consider using  `createLibraryFromDirectory` or `createLibraryFromUrl`
  *
  * @param promptbookSourcesPromiseOrFactory
  * @returns 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
- */ 
+export declare function createLibraryFromPromise(promptbookSourcesPromiseOrFactory: Promise<Array<PromptbookJson>> | (() => Promise<Array<PromptbookJson>>)): PromptbookLibrary;

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

@@ -1,7 +1,7 @@
 import type { string_url } from '../../types/typeAliases';
 import type { PromptbookLibrary } from '../PromptbookLibrary';
 /**
- * Options for `createPromptbookLibraryFromDirectory` function
+ * Options for `createLibraryFromDirectory` function
  */
 type CreatePromptbookLibraryFromUrlyOptions = {
     /**
@@ -22,7 +22,7 @@ type CreatePromptbookLibraryFromUrlyOptions = {
 
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
+export declare function createLibraryFromUrl(url: string_url | URL, options: CreatePromptbookLibraryFromUrlyOptions): Promise<PromptbookLibrary>;
 export {};
 /**
  * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks

package/umd/typings/{promptbook-library/constructors/createPromptbookSublibrary.d.ts → src/library/constructors/createSublibrary.d.ts}

@@ -9,4 +9,4 @@ import type { PromptbookLibrary } from '../PromptbookLibrary';
  * @param promptbookSources
  * @returns PromptbookLibrary
  */
-export declare function createPromptbookSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;
+export declare function createSublibrary(library: PromptbookLibrary, predicate: (url: string_promptbook_url) => boolean): PromptbookLibrary;

package/umd/typings/src/library/libraryToJson.d.ts

@@ -0,0 +1,8 @@
+import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
+import type { PromptbookLibrary } from './PromptbookLibrary';
+/**
+ * Converts PromptbookLibrary to serialized JSON
+ *
+ * Note: Functions `libraryToJson` and `createLibraryFromJson` are complementary
+ */
+export declare function libraryToJson(library: PromptbookLibrary): Promise<Array<PromptbookJson>>;

package/umd/typings/{llm-providers → src/llm-providers}/anthropic-claude/anthropic-claude-models.d.ts

@@ -14,6 +14,7 @@ export declare const ANTHROPIC_CLAUDE_MODELS: Array<AvailableModel & {
     };
 }>;
 /**
+ * TODO: !!!! Add embedding models OR Anthropic has only chat+completion models?
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...
  * TODO: [🕚] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing

package/{esm/typings → umd/typings/src}/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -24,5 +24,6 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
     listModels(): Array<AvailableModel>;
 }
 /**
+ * TODO: [🕵️‍♀️] Maybe just remove
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params
  */

package/{esm/typings → umd/typings/src}/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -23,3 +23,6 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
      */
     listModels(): Array<AvailableModel>;
 }
+/**
+ * TODO: [🕵️‍♀️] Maybe just remove
+ */ 

package/{esm/typings → umd/typings/src}/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -27,6 +27,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Calls OpenAI API to use a complete model.
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * !!!!
+     */
+    embed(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
     /**
      * Default model for chat variant.
      */
@@ -35,6 +39,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Default model for completion variant.
      */
     private getDefaultCompletionModel;
+    /**
+     * Default model for completion variant.
+     */
+    private getDefaultEmbeddingModel;
     /**
      * List all available OpenAI models that can be used
      */

package/{esm/typings → umd/typings/src}/llm-providers/openai/openai-models.d.ts

@@ -15,6 +15,7 @@ export declare const OPENAI_MODELS: Array<AvailableModel & {
     };
 }>;
 /**
+ * TODO: !!!! Add embedding models
  * TODO: [🧠] Some mechanism to propagate unsureness
  * TODO: [🕚][👮‍♀️] Make this list dynamic - dynamically can be listed modelNames but not modelVariant, legacy status, context length and pricing
  * TODO: [🧠][👮‍♀️] Put here more info like description, isVision, trainingDateCutoff, languages, strengths (	Top-level performance, intelligence, fluency, and understanding), contextWindow,...

package/{esm/typings → umd/typings/src}/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 '../../../promptbook-library/PromptbookLibrary';
+import type { PromptbookLibrary } from '../../../library/PromptbookLibrary';
 import type { client_id } from '../../../types/typeAliases';
 import type { string_uri } from '../../../types/typeAliases';
 export type RemoteServerOptions = CommonExecutionToolsOptions & {

package/umd/typings/{llm-providers → src/llm-providers}/remote/startRemoteServer.d.ts

@@ -10,7 +10,7 @@ import type { RemoteServerOptions } from './interfaces/RemoteServerOptions';
  */
 export declare function startRemoteServer(options: RemoteServerOptions): IDestroyable;
 /**
- * TODO: [⚖] Expose the library to be able to connect to same library via createPromptbookLibraryFromUrl
+ * TODO: [⚖] Expose the library to be able to connect to same library via createLibraryFromUrl
  * TODO: Handle progress - support streaming
  * TODO: [🤹‍♂️] Do not hang up immediately but wait until client closes OR timeout
  * TODO: [🤹‍♂️] Timeout on chat to free up resources

package/{esm/typings → umd/typings/src}/types/ModelRequirements.d.ts

@@ -1,5 +1,5 @@
 import type { string_model_name } from './typeAliases';
-export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
+export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT", "EMBEDDING"];
 /**
  * Model variant describes the very general type of the model
  *

package/umd/typings/{types → src/types}/PromptbookJson/MaterialKnowledgePieceJson.d.ts

@@ -1,4 +1,3 @@
-import { IVectorData } from 'xyzt';
 import type { string_keyword } from '../../utils/normalization/IKeywords';
 import type { string_href } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
@@ -12,7 +11,7 @@ export type MaterialKnowledgePieceJson = {
     readonly keywords: Array<string_keyword>;
     readonly index: Array<{
         modelName: string_model_name;
-        position: IVectorData;
+        position: Array<number>;
     }>;
     readonly sources: Array<{
         title: string_markdown_text;
@@ -20,6 +19,7 @@ export type MaterialKnowledgePieceJson = {
     }>;
 };
 /**
+ * TODO: !!! Use or uninstall xyzt
  * !!!! 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

package/umd/typings/src/utils/unwrapResult.test.d.ts

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

package/umd/typings/src/utils/validators/url/isValidUrl.test.d.ts

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

package/esm/typings/_packages/cli.index.d.ts

@@ -1,10 +0,0 @@
-import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-/**
- * Hidden utilities which should not be used by external consumers.
- */
-declare const __: {
-    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
-};
-export { __ };

package/esm/typings/_packages/node.index.d.ts

@@ -1,4 +0,0 @@
-import { createPromptbookLibraryFromDirectory } from '../promptbook-library/constructors/createPromptbookLibraryFromDirectory';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromDirectory };

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

@@ -1,7 +0,0 @@
-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/esm/typings/promptbook-library/constructors/createPromptbookLibraryFromSources.d.ts

@@ -1,16 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-/**
- * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
- *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */ 

package/umd/typings/_packages/cli.index.d.ts

@@ -1,10 +0,0 @@
-import { prettifyPromptbookStringCli } from '../conversion/prettify/prettifyPromptbookStringCli';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-/**
- * Hidden utilities which should not be used by external consumers.
- */
-declare const __: {
-    prettifyPromptbookStringCli: typeof prettifyPromptbookStringCli;
-};
-export { __ };

package/umd/typings/_packages/node.index.d.ts

@@ -1,4 +0,0 @@
-import { createPromptbookLibraryFromDirectory } from '../promptbook-library/constructors/createPromptbookLibraryFromDirectory';
-import { PROMPTBOOK_VERSION } from '../version';
-export { PROMPTBOOK_VERSION };
-export { createPromptbookLibraryFromDirectory };

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

@@ -1,7 +0,0 @@
-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/promptbook-library/constructors/createPromptbookLibraryFromSources.d.ts

@@ -1,16 +0,0 @@
-import type { PromptbookJson } from '../../types/PromptbookJson/PromptbookJson';
-import type { PromptbookString } from '../../types/PromptbookString';
-import { SimplePromptbookLibrary } from '../SimplePromptbookLibrary';
-/**
- * Creates PromptbookLibrary from array of PromptbookJson or PromptbookString
- *
- * Note: You can combine `PromptbookString` (`.ptbk.md`) with `PromptbookJson` BUT it is not recommended
- * Note: During the construction syntax and logic of all sources are validated
- *
- * @param promptbookSources
- * @returns PromptbookLibrary
- */
-export declare function createPromptbookLibraryFromSources(...promptbookSources: Array<PromptbookJson | PromptbookString>): Promise<SimplePromptbookLibrary>;
-/**
- * TODO: !!!! [🧠] Library precompilation and do not mix markdown and json promptbooks
- */