@promptbook/core 0.92.0-31 β†’ 0.92.0-33

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -134,6 +134,7 @@ import type { JavascriptExecutionToolsOptions } from '../scripting/javascript/Ja
134
134
  import type { PostprocessingFunction } from '../scripting/javascript/JavascriptExecutionToolsOptions';
135
135
  import type { PromptbookStorage } from '../storage/_common/PromptbookStorage';
136
136
  import type { FileCacheStorageOptions } from '../storage/file-cache-storage/FileCacheStorageOptions';
137
+ import type { IndexedDbStorageOptions } from '../storage/local-storage/utils/IndexedDbStorageOptions';
137
138
  import type { IntermediateFilesStrategy } from '../types/IntermediateFilesStrategy';
138
139
  import type { ModelRequirements } from '../types/ModelRequirements';
139
140
  import type { CompletionModelRequirements } from '../types/ModelRequirements';
@@ -431,6 +432,7 @@ export type { JavascriptExecutionToolsOptions };
431
432
  export type { PostprocessingFunction };
432
433
  export type { PromptbookStorage };
433
434
  export type { FileCacheStorageOptions };
435
+ export type { IndexedDbStorageOptions };
434
436
  export type { IntermediateFilesStrategy };
435
437
  export type { ModelRequirements };
436
438
  export type { CompletionModelRequirements };
@@ -2,6 +2,7 @@ import type { Observable } from 'rxjs';
2
2
  import { PartialDeep } from 'type-fest';
3
3
  import type { task_id } from '../types/typeAliases';
4
4
  import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
5
+ import type { string_promptbook_version } from '../version';
5
6
  import type { AbstractTaskResult } from './AbstractTaskResult';
6
7
  import type { PipelineExecutorResult } from './PipelineExecutorResult';
7
8
  /**
@@ -12,12 +13,21 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
12
13
  * The type of task to create
13
14
  */
14
15
  readonly taskType: AbstractTask<TTaskResult>['taskType'];
16
+ /**
17
+ * Human-readable title of the task - used for displaying in the UI
18
+ */
19
+ readonly title: AbstractTask<TTaskResult>['title'];
15
20
  /**
16
21
  * Callback that processes the task and updates the ongoing result
17
22
  * @param ongoingResult The partial result of the task processing
18
23
  * @returns The final task result
19
24
  */
20
- taskProcessCallback(updateOngoingResult: (newOngoingResult: PartialDeep<TTaskResult>) => void): Promise<TTaskResult>;
25
+ taskProcessCallback(updateOngoingResult: (newOngoingResult: PartialDeep<TTaskResult> & {
26
+ /**
27
+ * Optional update of the task title
28
+ */
29
+ readonly title?: AbstractTask<TTaskResult>['title'];
30
+ }) => void): Promise<TTaskResult>;
21
31
  };
22
32
  /**
23
33
  * Helper to create a new task
@@ -52,10 +62,18 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
52
62
  * Type of the task
53
63
  */
54
64
  readonly taskType: string_SCREAMING_CASE;
65
+ /**
66
+ * Version of the promptbook used to run the task
67
+ */
68
+ readonly promptbookVersion: string_promptbook_version;
55
69
  /**
56
70
  * Unique identifier for the task
57
71
  */
58
72
  readonly taskId: task_id;
73
+ /**
74
+ * Human-readable title of the task - used for displaying in the UI
75
+ */
76
+ readonly title: string;
59
77
  /**
60
78
  * Status of the task
61
79
  */
@@ -2,6 +2,7 @@ import Anthropic from '@anthropic-ai/sdk';
2
2
  import type { AvailableModel } from '../../execution/AvailableModel';
3
3
  import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
4
4
  import type { ChatPromptResult } from '../../execution/PromptResult';
5
+ import type { CompletionPromptResult } from '../../execution/PromptResult';
5
6
  import type { Prompt } from '../../types/Prompt';
6
7
  import type { string_markdown } from '../../types/typeAliases';
7
8
  import type { string_markdown_text } from '../../types/typeAliases';
@@ -19,6 +20,7 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
19
20
  * Anthropic Claude API client.
20
21
  */
21
22
  private client;
23
+ private limiter;
22
24
  /**
23
25
  * Creates Anthropic Claude Execution Tools.
24
26
  *
@@ -40,6 +42,10 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
40
42
  * Calls Anthropic Claude API to use a chat model.
41
43
  */
42
44
  callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<ChatPromptResult>;
45
+ /**
46
+ * Calls Anthropic Claude API to use a completion model.
47
+ */
48
+ callCompletionModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements'>): Promise<CompletionPromptResult>;
43
49
  /**
44
50
  * Get the model that should be used as default
45
51
  */
@@ -9,6 +9,10 @@ import type { string_user_id } from '../../types/typeAliases';
9
9
  * @public exported from `@promptbook/azure-openai`
10
10
  */
11
11
  export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
12
+ /**
13
+ * The API key of the Azure OpenAI resource
14
+ */
15
+ readonly apiKey: string_token;
12
16
  /**
13
17
  * The resource name of the Azure OpenAI resource
14
18
  *
@@ -23,10 +27,6 @@ export type AzureOpenAiExecutionToolsOptions = CommonToolsOptions & {
23
27
  * Note: Typically you have one resource and multiple deployments.
24
28
  */
25
29
  readonly deploymentName: string_name;
26
- /**
27
- * The API key of the Azure OpenAI resource
28
- */
29
- readonly apiKey: string_token;
30
30
  /**
31
31
  * A unique identifier representing your end-user, which can help Azure OpenAI to monitor
32
32
  * and detect abuse.
@@ -1,10 +1,11 @@
1
1
  import type { PromptbookStorage } from '../_common/PromptbookStorage';
2
+ import type { IndexedDbStorageOptions } from './utils/IndexedDbStorageOptions';
2
3
  /**
3
4
  * Gets wrapper around IndexedDB which can be used as PromptbookStorage
4
5
  *
5
6
  * @public exported from `@promptbook/browser`
6
7
  */
7
- export declare function getIndexedDbStorage<TItem>(): PromptbookStorage<TItem>;
8
+ export declare function getIndexedDbStorage<TItem>(options: IndexedDbStorageOptions): PromptbookStorage<TItem>;
8
9
  /**
9
10
  * Note: [πŸ”΅] Code in this file should never be published outside of `@promptbook/browser`
10
11
  */
@@ -0,0 +1,14 @@
1
+ import type { string_name } from '../../../types/typeAliases';
2
+ /**
3
+ * Options for IndexedDB storage
4
+ */
5
+ export type IndexedDbStorageOptions = {
6
+ /**
7
+ * Name of the database
8
+ */
9
+ databaseName: string_name;
10
+ /**
11
+ * Name of the object store (table) in the database
12
+ */
13
+ storeName: string_name;
14
+ };
@@ -1,7 +1,8 @@
1
1
  import type { PromptbookStorage } from '../../_common/PromptbookStorage';
2
+ import type { IndexedDbStorageOptions } from './IndexedDbStorageOptions';
2
3
  /**
3
4
  * Creates a PromptbookStorage backed by IndexedDB.
4
5
  * Uses a single object store named 'promptbook'.
5
6
  * @private for `getIndexedDbStorage`
6
7
  */
7
- export declare function makePromptbookStorageFromIndexedDb<TValue>(dbName?: string, storeName?: string): PromptbookStorage<TValue>;
8
+ export declare function makePromptbookStorageFromIndexedDb<TValue>(options: IndexedDbStorageOptions): PromptbookStorage<TValue>;
@@ -15,7 +15,7 @@ export declare const BOOK_LANGUAGE_VERSION: string_semantic_version;
15
15
  export declare const PROMPTBOOK_ENGINE_VERSION: string_promptbook_version;
16
16
  /**
17
17
  * Represents the version string of the Promptbook engine.
18
- * It follows semantic versioning (e.g., `0.92.0-30`).
18
+ * It follows semantic versioning (e.g., `0.92.0-32`).
19
19
  *
20
20
  * @generated
21
21
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@promptbook/core",
3
- "version": "0.92.0-31",
3
+ "version": "0.92.0-33",
4
4
  "description": "It's time for a paradigm shift. The future of software in plain English, French or Latin",
5
5
  "private": false,
6
6
  "sideEffects": false,
package/umd/index.umd.js CHANGED
@@ -27,7 +27,7 @@
27
27
  * @generated
28
28
  * @see https://github.com/webgptorg/promptbook
29
29
  */
30
- const PROMPTBOOK_ENGINE_VERSION = '0.92.0-31';
30
+ const PROMPTBOOK_ENGINE_VERSION = '0.92.0-33';
31
31
  /**
32
32
  * TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
33
33
  * Note: [πŸ’ž] Ignore a discrepancy between file name and entity name
@@ -2368,6 +2368,7 @@
2368
2368
  */
2369
2369
  function createTask(options) {
2370
2370
  const { taskType, taskProcessCallback } = options;
2371
+ let { title } = options;
2371
2372
  // TODO: [πŸ™] DRY
2372
2373
  const taskId = `${taskType.toLowerCase().substring(0, 4)}-${$randomToken(8 /* <- TODO: To global config + Use Base58 to avoid simmilar char conflicts */)}`;
2373
2374
  let status = 'RUNNING';
@@ -2379,6 +2380,10 @@
2379
2380
  const partialResultSubject = new rxjs.Subject();
2380
2381
  // <- Note: Not using `BehaviorSubject` because on error we can't access the last value
2381
2382
  const finalResultPromise = /* not await */ taskProcessCallback((newOngoingResult) => {
2383
+ if (newOngoingResult.title) {
2384
+ title = newOngoingResult.title;
2385
+ }
2386
+ updatedAt = new Date();
2382
2387
  Object.assign(currentValue, newOngoingResult);
2383
2388
  // <- TODO: assign deep
2384
2389
  partialResultSubject.next(newOngoingResult);
@@ -2424,17 +2429,24 @@
2424
2429
  return {
2425
2430
  taskType,
2426
2431
  taskId,
2432
+ get promptbookVersion() {
2433
+ return PROMPTBOOK_ENGINE_VERSION;
2434
+ },
2435
+ get title() {
2436
+ return title;
2437
+ // <- Note: [1] Theese must be getters to allow changing the value in the future
2438
+ },
2427
2439
  get status() {
2428
2440
  return status;
2429
- // <- Note: [1] Theese must be getters to allow changing the value in the future
2441
+ // <- Note: [1] --||--
2430
2442
  },
2431
2443
  get createdAt() {
2432
2444
  return createdAt;
2433
- // <- Note: [1]
2445
+ // <- Note: [1] --||--
2434
2446
  },
2435
2447
  get updatedAt() {
2436
2448
  return updatedAt;
2437
- // <- Note: [1]
2449
+ // <- Note: [1] --||--
2438
2450
  },
2439
2451
  asPromise,
2440
2452
  asObservable() {
@@ -2442,15 +2454,15 @@
2442
2454
  },
2443
2455
  get errors() {
2444
2456
  return errors;
2445
- // <- Note: [1]
2457
+ // <- Note: [1] --||--
2446
2458
  },
2447
2459
  get warnings() {
2448
2460
  return warnings;
2449
- // <- Note: [1]
2461
+ // <- Note: [1] --||--
2450
2462
  },
2451
2463
  get currentValue() {
2452
2464
  return currentValue;
2453
- // <- Note: [1]
2465
+ // <- Note: [1] --||--
2454
2466
  },
2455
2467
  };
2456
2468
  }
@@ -3198,23 +3210,17 @@
3198
3210
  * Check the configuration of all execution tools
3199
3211
  */
3200
3212
  async checkConfiguration() {
3201
- // TODO: Maybe do it in parallel
3202
- for (const llmExecutionTools of this.llmExecutionTools) {
3203
- await llmExecutionTools.checkConfiguration();
3204
- }
3213
+ // Note: Run checks in parallel
3214
+ await Promise.all(this.llmExecutionTools.map((tools) => tools.checkConfiguration()));
3205
3215
  }
3206
3216
  /**
3207
3217
  * List all available models that can be used
3208
3218
  * This lists is a combination of all available models from all execution tools
3209
3219
  */
3210
3220
  async listModels() {
3211
- const availableModels = [];
3212
- for (const llmExecutionTools of this.llmExecutionTools) {
3213
- // TODO: [πŸͺ‚] Obtain models in parallel
3214
- const models = await llmExecutionTools.listModels();
3215
- availableModels.push(...models);
3216
- }
3217
- return availableModels;
3221
+ // Obtain all models in parallel and flatten
3222
+ const modelArrays = await Promise.all(this.llmExecutionTools.map((tools) => tools.listModels()));
3223
+ return modelArrays.flat();
3218
3224
  }
3219
3225
  /**
3220
3226
  * Calls the best available chat model
@@ -4590,7 +4596,7 @@
4590
4596
  });
4591
4597
  const knowledgePiecesSorted = knowledgePiecesWithRelevance.sort((a, b) => a.relevance - b.relevance);
4592
4598
  const knowledgePiecesLimited = knowledgePiecesSorted.slice(0, 5);
4593
- console.log('!!! Embedding', {
4599
+ console.log('!!! `getKnowledgeForTask` Embedding', {
4594
4600
  task,
4595
4601
  taskEmbeddingPrompt,
4596
4602
  taskEmbeddingResult,
@@ -4626,6 +4632,7 @@
4626
4632
  */
4627
4633
  async function getReservedParametersForTask(options) {
4628
4634
  const { tools, preparedPipeline, task, parameters, pipelineIdentification } = options;
4635
+ console.log('!!! getReservedParametersForTask', options);
4629
4636
  const context = await getContextForTask(); // <- [🏍]
4630
4637
  const knowledge = await getKnowledgeForTask({ tools, preparedPipeline, task, parameters });
4631
4638
  const examples = await getExamplesForTask();
@@ -4662,6 +4669,7 @@
4662
4669
  */
4663
4670
  async function executeTask(options) {
4664
4671
  const { currentTask, preparedPipeline, parametersToPass, tools, onProgress, $executionReport, pipelineIdentification, maxExecutionAttempts, maxParallelCount, csvSettings, isVerbose, rootDirname, cacheDirname, intermediateFilesStrategy, isAutoInstalled, isNotPreparedWarningSupressed, } = options;
4672
+ console.log('!!! executeTask', options);
4665
4673
  const priority = preparedPipeline.tasks.length - preparedPipeline.tasks.indexOf(currentTask);
4666
4674
  // Note: Check consistency of used and dependent parameters which was also done in `validatePipeline`, but it’s good to doublecheck
4667
4675
  const usedParameterNames = extractParameterNamesFromTask(currentTask);
@@ -4685,14 +4693,15 @@
4685
4693
 
4686
4694
  `));
4687
4695
  }
4696
+ const reservedParameters = await getReservedParametersForTask({
4697
+ tools,
4698
+ preparedPipeline,
4699
+ task: currentTask,
4700
+ pipelineIdentification,
4701
+ parameters: parametersToPass,
4702
+ });
4688
4703
  const definedParameters = Object.freeze({
4689
- ...(await getReservedParametersForTask({
4690
- tools,
4691
- preparedPipeline,
4692
- task: currentTask,
4693
- pipelineIdentification,
4694
- parameters: parametersToPass,
4695
- })),
4704
+ ...reservedParameters,
4696
4705
  ...parametersToPass,
4697
4706
  });
4698
4707
  const definedParameterNames = new Set(Object.keys(definedParameters));
@@ -5139,6 +5148,7 @@
5139
5148
  };
5140
5149
  const pipelineExecutor = (inputParameters) => createTask({
5141
5150
  taskType: 'EXECUTION',
5151
+ title: pipeline.title,
5142
5152
  taskProcessCallback(updateOngoingResult) {
5143
5153
  return pipelineExecutorWithCallback(inputParameters, async (newOngoingResult) => {
5144
5154
  updateOngoingResult(newOngoingResult);
@@ -10870,6 +10880,7 @@
10870
10880
  apiKey: 'sk-ant-api03-',
10871
10881
  isProxied: true,
10872
10882
  remoteServerUrl: DEFAULT_REMOTE_SERVER_URL,
10883
+ maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
10873
10884
  },
10874
10885
  };
10875
10886
  },
@@ -10905,7 +10916,7 @@
10905
10916
  title: 'Azure Open AI',
10906
10917
  packageName: '@promptbook/azure-openai',
10907
10918
  className: 'AzureOpenAiExecutionTools',
10908
- envVariables: ['AZUREOPENAI_RESOURCE_NAME', 'AZUREOPENAI_DEPLOYMENT_NAME', 'AZUREOPENAI_API_KEY'],
10919
+ envVariables: ['AZUREOPENAI_API_KEY', 'AZUREOPENAI_RESOURCE_NAME', 'AZUREOPENAI_DEPLOYMENT_NAME'],
10909
10920
  trustLevel: 'CLOSED_BUSINESS',
10910
10921
  order: MODEL_ORDERS.NORMAL,
10911
10922
  getBoilerplateConfiguration() {
@@ -10915,6 +10926,9 @@
10915
10926
  className: 'AzureOpenAiExecutionTools',
10916
10927
  options: {
10917
10928
  apiKey: 'sk-',
10929
+ resourceName: 'my-resource-name',
10930
+ deploymentName: 'my-deployment-name',
10931
+ maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
10918
10932
  },
10919
10933
  };
10920
10934
  },
@@ -10928,15 +10942,15 @@
10928
10942
  packageName: '@promptbook/azure-openai',
10929
10943
  className: 'AzureOpenAiExecutionTools',
10930
10944
  options: {
10945
+ apiKey: env.AZUREOPENAI_API_KEY,
10931
10946
  resourceName: env.AZUREOPENAI_RESOURCE_NAME,
10932
10947
  deploymentName: env.AZUREOPENAI_DEPLOYMENT_NAME,
10933
- apiKey: env.AZUREOPENAI_API_KEY,
10934
10948
  },
10935
10949
  };
10936
10950
  }
10937
- else if (typeof env.AZUREOPENAI_RESOURCE_NAME === 'string' ||
10938
- typeof env.AZUREOPENAI_DEPLOYMENT_NAME === 'string' ||
10939
- typeof env.AZUREOPENAI_API_KEY === 'string') {
10951
+ else if (typeof env.AZUREOPENAI_API_KEY === 'string' ||
10952
+ typeof env.AZUREOPENAI_RESOURCE_NAME === 'string' ||
10953
+ typeof env.AZUREOPENAI_DEPLOYMENT_NAME === 'string') {
10940
10954
  return null;
10941
10955
  /*
10942
10956
  Note: [πŸ—¨] Partial configuration is handled more gracefully elsewhere
@@ -11149,6 +11163,7 @@
11149
11163
  options: {
11150
11164
  apiKey: 'sk-',
11151
11165
  assistantId: 'asst_',
11166
+ maxRequestsPerMinute: DEFAULT_MAX_REQUESTS_PER_MINUTE,
11152
11167
  },
11153
11168
  };
11154
11169
  },