@promptbook/remote-client 0.59.0-8 → 0.59.0

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/openai/OpenAiExecutionTools.d.ts

@@ -2,6 +2,7 @@ import type { AvailableModel } from '../../execution/LlmExecutionTools';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { PromptChatResult } from '../../execution/PromptResult';
 import type { PromptCompletionResult } from '../../execution/PromptResult';
+import type { PromptEmbeddingResult } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
@@ -27,6 +28,14 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Calls OpenAI API to use a complete model.
      */
     gptComplete(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptCompletionResult>;
+    /**
+     * Calls OpenAI API to use a embedding model
+     */
+    embed(prompt: Pick<Prompt, 'content' | 'modelRequirements'>): Promise<PromptEmbeddingResult>;
+    /**
+     * Get the model that should be used as default
+     */
+    private getDefaultModel;
     /**
      * Default model for chat variant.
      */
@@ -35,6 +44,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/umd/typings/{llm-providers → src/llm-providers}/openai/computeOpenaiUsage.d.ts

@@ -1,12 +1,14 @@
 import type OpenAI from 'openai';
-import type { PromptResult } from '../../execution/PromptResult';
 import type { PromptResultUsage } from '../../execution/PromptResult';
 import type { Prompt } from '../../types/Prompt';
 /**
  * Computes the usage of the OpenAI API based on the response from OpenAI
  *
+ * @param promptContent The content of the prompt
+ * @param resultContent The content of the result (for embedding prompts or failed prompts pass empty string)
+ * @param rawResponse The raw response from OpenAI API
  * @throws {PromptbookExecutionError} If the usage is not defined in the response from OpenAI
  * @private internal util of `OpenAiExecutionTools`
  */
 export declare function computeOpenaiUsage(promptContent: Prompt['content'], // <- Note: Intentionally using [] to access type properties to bring jsdoc from Prompt/PromptResult to consumer
-resultContent: PromptResult['content'], rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion, 'model' | 'usage'>): PromptResultUsage;
+resultContent: string, rawResponse: Pick<OpenAI.Chat.Completions.ChatCompletion | OpenAI.Completions.Completion | OpenAI.Embeddings.CreateEmbeddingResponse, 'model' | 'usage'>): PromptResultUsage;

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/KnowledgeJson.d.ts

@@ -2,5 +2,5 @@ import type { MaterialKnowledgePieceJson } from './MaterialKnowledgePieceJson';
 export type KnowledgeJson = Array<MaterialKnowledgePieceJson>;
 /**
  * !!!! Annotate
- * TODO: [🦪]
+ * TODO: [🦪] Internal links between (Material)KnowledgePieces withing the KnowledgeJson
  */

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

@@ -1,4 +1,4 @@
-import type { IVectorData } from 'xyzt';
+import type { EmbeddingVector } from '../../execution/EmbeddingVector';
 import type { string_keyword } from '../../utils/normalization/IKeywords';
 import type { string_href } from '../typeAliases';
 import type { string_markdown } from '../typeAliases';
@@ -12,7 +12,7 @@ export type MaterialKnowledgePieceJson = {
     readonly keywords: Array<string_keyword>;
     readonly index: Array<{
         modelName: string_model_name;
-        position: IVectorData;
+        position: EmbeddingVector;
     }>;
     readonly sources: Array<{
         title: string_markdown_text;
@@ -20,8 +20,9 @@ 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: [🧠][🦪] Maybe allow internal links 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/src/utils/trimCodeBlock.test.d.ts

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

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

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

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/_common/IndexPreparer.d.ts

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

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/_common/IndexPreparer.d.ts

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

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
- */