@promptbook/types 0.49.1 → 0.50.0-1

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 } 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,26 @@ export type LlmExecutionTools = {
      * Use a completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AviableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AviableModel = {
+    /**
+     * 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/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 { AviableModel, 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<AviableModel>;
 }
 /**
  * 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 { AviableModel, 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<AviableModel>;
 }

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 { AviableModel, 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<AviableModel>>;
 }
 /**
  * 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 { AviableModel, 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<AviableModel>>;
 }
 /**
  * TODO: [🍓][♐] Allow to list compatible models with each variant

package/package.json

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

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 } 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,26 @@ export type LlmExecutionTools = {
      * Use a completion model
      */
     gptComplete(prompt: Prompt): Promise<PromptCompletionResult>;
+    /**
+     * List all available models that can be used
+     */
+    listModels(): Promisable<Array<AviableModel>>;
+};
+/**
+ * Represents a model that can be used for prompt execution
+ */
+export type AviableModel = {
+    /**
+     * 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/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 { AviableModel, 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<AviableModel>;
 }
 /**
  * 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 { AviableModel, 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<AviableModel>;
 }

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 { AviableModel, 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<AviableModel>>;
 }
 /**
  * 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 { AviableModel, 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<AviableModel>>;
 }
 /**
  * TODO: [🍓][♐] Allow to list compatible models with each variant