@promptbook/types 0.50.0-0 → 0.50.0-3

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

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
@@ -20,7 +20,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools as LlmExecutionTools, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools as LlmExecutionTools, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here

package/esm/typings/execution/LlmExecutionTools.d.ts

@@ -1,7 +1,10 @@
+import type { Promisable } from 'type-fest';
+import type { ModelVariant } from '../types/ModelRequirements';
 import type { Prompt } from '../types/Prompt';
+import type { string_model_name, string_title } from '../types/typeAliases';
 import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
 /**
- * Vontainer for all the tools needed to execute prompts to large language models like GPT-4
+ * Container for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
  *
@@ -16,9 +19,30 @@ export type LlmExecutionTools = {
      * Use a completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AvailableModel = {
+    /**
+     * The model title
+     */
+    readonly modelTitle: string_title;
+    /**
+     * The model name aviailable
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Variant of the model
+     */
+    readonly modelVariant: ModelVariant;
 };
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
  * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

package/esm/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -6,5 +6,5 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
 /**
- * TODO: [🍓][♐] Allow to list the aviable prompts in Langtail
+ * TODO: [🍓][♐] Allow to list the available prompts in Langtail
  */

package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -1,7 +1,7 @@
-import { Prompt } from '../../../../types/Prompt';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { LlmExecutionTools } from '../../../LlmExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  */
@@ -16,6 +16,10 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
      * Mocks completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available mocked-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
 }
 /**
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params

package/esm/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -1,7 +1,7 @@
-import { Prompt } from '../../../../types/Prompt';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { LlmExecutionTools } from '../../../LlmExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  */
@@ -16,4 +16,8 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
      * Fakes completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available fake-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
 }

package/esm/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -1,5 +1,6 @@
+import type { Promisable } from 'type-fest';
 import type { Prompt } from '../../../../types/Prompt';
-import type { LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
 import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
@@ -25,6 +26,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Calls OpenAI API to use a complete model.
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available OpenAI models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
 }
 /**
  * TODO: [🍓][♐] Allow to list compatible models with each variant

package/esm/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -1,7 +1,7 @@
-import { Prompt } from '../../../../types/Prompt';
-import { LlmExecutionTools } from '../../../LlmExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-import { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -29,6 +29,10 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
      * Calls remote proxy server to use both completion or chat model.
      */
     private gptCommon;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promise<Array<AvailableModel>>;
 }
 /**
  * TODO: [🍓][♐] Allow to list compatible models with each variant

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/types",
-    "version": "0.50.0-0",
+    "version": "0.50.0-3",
     "description": "Library to supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -45,7 +45,7 @@
         }
     ],
     "peerDependencies": {
-        "@promptbook/core": "0.50.0-0"
+        "@promptbook/core": "0.50.0-3"
     },
     "main": "./umd/index.umd.js",
     "module": "./esm/index.es.js",

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

@@ -1,6 +1,6 @@
 import type { CommonExecutionToolsOptions } from '../execution/CommonExecutionToolsOptions';
 import type { ExecutionTools } from '../execution/ExecutionTools';
-import type { LlmExecutionTools } from '../execution/LlmExecutionTools';
+import type { AvailableModel, LlmExecutionTools } from '../execution/LlmExecutionTools';
 import type { PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult } from '../execution/PromptResult';
 import type { PromptbookExecutor } from '../execution/PromptbookExecutor';
 import type { ScriptExecutionTools, ScriptExecutionToolsExecuteOptions } from '../execution/ScriptExecutionTools';
@@ -20,7 +20,7 @@ import type { ExecutionReportJson } from '../types/execution-report/ExecutionRep
 import type { string_char_emoji } from '../types/typeAliasEmoji';
 import type { client_id, string_char, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version } from '../types/typeAliases';
 import { FromtoItems } from '../utils/FromtoItems';
-export { client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools as LlmExecutionTools, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
+export { AvailableModel, client_id, CommonExecutionToolsOptions, ExecutionReportJson, ExecutionTools, ExecutionType, EXPECTATION_UNITS, ExpectationAmount, ExpectationUnit, FromtoItems, LlmExecutionTools as LlmExecutionTools, ModelRequirements, ModelVariant, Parameters, Prompt, PromptbookExecutor, PromptbookJson, PromptbookLibrary, PromptbookString, PromptChatResult, PromptCommonResult, PromptCompletionResult, PromptResult, PromptTemplateJson, PromptTemplateParameterJson, ScriptExecutionTools, ScriptExecutionToolsExecuteOptions, ScriptLanguage, string_char, string_char_emoji, string_chat_prompt, string_completion_prompt, string_data_url, string_domain, string_email, string_file_absolute_path, string_file_extension, string_file_path, string_file_relative_path, string_filename, string_folder_absolute_path, string_folder_path, string_folder_relative_path, string_host, string_hostname, string_href, string_html, string_javascript, string_javascript_name, string_license, string_markdown, string_markdown_text, string_mime_type, string_mime_type_with_wildcard, string_model_name, string_name, string_person_fullname, string_prompt, string_promptbook_url, string_promptbook_url_with_hashtemplate, string_script, string_sha256, string_tdl, string_template, string_text_prompt, string_title, string_token, string_translate_language, string_uri, string_uri_part, string_url, string_url_image, string_version, TaskProgress, UserInterfaceTools, UserInterfaceToolsPromptDialogOptions, };
 /**
  * TODO: [🧠][🆔] Is this the best package to export custom errors from?
  * TODO: Delete type aliases (from ../types/typeAliases) that are not exported here

package/umd/typings/execution/LlmExecutionTools.d.ts

@@ -1,7 +1,10 @@
+import type { Promisable } from 'type-fest';
+import type { ModelVariant } from '../types/ModelRequirements';
 import type { Prompt } from '../types/Prompt';
+import type { string_model_name, string_title } from '../types/typeAliases';
 import type { PromptChatResult, PromptCompletionResult } from './PromptResult';
 /**
- * Vontainer for all the tools needed to execute prompts to large language models like GPT-4
+ * Container for all the tools needed to execute prompts to large language models like GPT-4
  * On its interface it exposes common methods for prompt execution.
  * Inside (in constructor) it calls OpenAI, Azure, GPU, proxy, cache, logging,...
  *
@@ -16,9 +19,30 @@ export type LlmExecutionTools = {
      * Use a completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AvailableModel = {
+    /**
+     * The model title
+     */
+    readonly modelTitle: string_title;
+    /**
+     * The model name aviailable
+     */
+    readonly modelName: string_model_name;
+    /**
+     * Variant of the model
+     */
+    readonly modelVariant: ModelVariant;
 };
 /**
- * TODO: [🍓][♐] Allow to list compatible models with each variant
+ * TODO: [🍓][♐] Some heuristic to pick the best model in listed models
  * TODO: [🏳] gptChat -> chat, gptComplete -> complete, translate
  * TODO: [🧠] Should or should not there be a word "GPT" in both gptComplete and gptChat
  */

package/umd/typings/execution/plugins/llm-execution-tools/langtail/LangtailExecutionTools.d.ts

@@ -6,5 +6,5 @@ import { OpenAiExecutionTools } from '../openai/OpenAiExecutionTools';
 export declare class LangtailExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
 }
 /**
- * TODO: [🍓][♐] Allow to list the aviable prompts in Langtail
+ * TODO: [🍓][♐] Allow to list the available prompts in Langtail
  */

package/umd/typings/execution/plugins/llm-execution-tools/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -1,7 +1,7 @@
-import { Prompt } from '../../../../types/Prompt';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { LlmExecutionTools } from '../../../LlmExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just echoing the requests for testing purposes.
  */
@@ -16,6 +16,10 @@ export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
      * Mocks completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available mocked-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
 }
 /**
  * TODO: Allow in spaceTrim: nesting with > ${block(prompt.request)}, same as replace params

package/umd/typings/execution/plugins/llm-execution-tools/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -1,7 +1,7 @@
-import { Prompt } from '../../../../types/Prompt';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { LlmExecutionTools } from '../../../LlmExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { Prompt } from '../../../../types/Prompt';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 /**
  * Mocked execution Tools for just faking expected responses for testing purposes
  */
@@ -16,4 +16,8 @@ export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools
      * Fakes completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available fake-models that can be used
+     */
+    listModels(): Array<AvailableModel>;
 }

package/umd/typings/execution/plugins/llm-execution-tools/openai/OpenAiExecutionTools.d.ts

@@ -1,5 +1,6 @@
+import type { Promisable } from 'type-fest';
 import type { Prompt } from '../../../../types/Prompt';
-import type { LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
 import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
@@ -25,6 +26,10 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
      * Calls OpenAI API to use a complete model.
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available OpenAI models that can be used
+     */
+    listModels(): Promisable<Array<AvailableModel>>;
 }
 /**
  * TODO: [🍓][♐] Allow to list compatible models with each variant

package/umd/typings/execution/plugins/llm-execution-tools/remote/RemoteLlmExecutionTools.d.ts

@@ -1,7 +1,7 @@
-import { Prompt } from '../../../../types/Prompt';
-import { LlmExecutionTools } from '../../../LlmExecutionTools';
-import { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
-import { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
+import type { Prompt } from '../../../../types/Prompt';
+import type { AvailableModel, LlmExecutionTools } from '../../../LlmExecutionTools';
+import type { PromptChatResult, PromptCompletionResult } from '../../../PromptResult';
+import type { RemoteLlmExecutionToolsOptions } from './RemoteLlmExecutionToolsOptions';
 /**
  * Remote server is a proxy server that uses its execution tools internally and exposes the executor interface externally.
  *
@@ -29,6 +29,10 @@ export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
      * Calls remote proxy server to use both completion or chat model.
      */
     private gptCommon;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promise<Array<AvailableModel>>;
 }
 /**
  * TODO: [🍓][♐] Allow to list compatible models with each variant