@promptbook/openai 0.71.0-0 → 0.72.0-1

package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts

@@ -13,7 +13,7 @@ import type { string_title } from '../../types/typeAliases';
  * @public exported from `@promptbook/fake-llm`
  */
 export declare class MockedEchoLlmExecutionTools implements LlmExecutionTools {
-    private readonly options;
+    protected readonly options: CommonExecutionToolsOptions;
     constructor(options?: CommonExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;

package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts

@@ -14,7 +14,7 @@ import type { string_title } from '../../types/typeAliases';
  * @public exported from `@promptbook/fake-llm`
  */
 export declare class MockedFackedLlmExecutionTools implements LlmExecutionTools {
-    private readonly options;
+    protected readonly options: CommonExecutionToolsOptions;
     constructor(options?: CommonExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionTools.d.ts

@@ -0,0 +1,37 @@
+import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
+import type { ChatPromptResult } from '../../execution/PromptResult';
+import type { Prompt } from '../../types/Prompt';
+import type { string_markdown } from '../../types/typeAliases';
+import type { string_markdown_text } from '../../types/typeAliases';
+import type { string_title } from '../../types/typeAliases';
+import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
+import { OpenAiExecutionTools } from './OpenAiExecutionTools';
+/**
+ * Execution Tools for calling OpenAI API Assistants
+ *
+ * This is usefull for calling OpenAI API with a single assistant, for more wide usage use `OpenAiExecutionTools`.
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare class OpenAiAssistantExecutionTools extends OpenAiExecutionTools implements LlmExecutionTools {
+    private readonly assistantId?;
+    /**
+     * Creates OpenAI Execution Tools.
+     *
+     * @param options which are relevant are directly passed to the OpenAI client
+     */
+    constructor(options: OpenAiAssistantExecutionToolsOptions);
+    get title(): string_title & string_markdown_text;
+    get description(): string_markdown;
+    /**
+     * Calls OpenAI API to use a chat model.
+     */
+    callChatModel(prompt: Pick<Prompt, 'content' | 'parameters' | 'modelRequirements' | 'format'>): Promise<ChatPromptResult>;
+}
+/**
+ * TODO: !!!!!! DO not use colors - can be used in browser
+ * TODO: [🧠][🧙‍♂️] Maybe there can be some wizzard for thoose who want to use just OpenAI
+ * TODO: Maybe make custom OpenAiError
+ * TODO: [🧠][🈁] Maybe use `isDeterministic` from options
+ * TODO: [🧠][🌰] Allow to pass `title` for tracking purposes
+ */

package/esm/typings/src/llm-providers/openai/OpenAiAssistantExecutionToolsOptions.d.ts

@@ -0,0 +1,14 @@
+import type { ClientOptions } from 'openai';
+import type { string_token } from '../../types/typeAliases';
+import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
+/**
+ * Options for `OpenAiAssistantExecutionTools`
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export type OpenAiAssistantExecutionToolsOptions = OpenAiExecutionToolsOptions & ClientOptions & {
+    /**
+     * Which assistant to use
+     */
+    assistantId: string_token;
+};

package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts

@@ -1,3 +1,4 @@
+import OpenAI from 'openai';
 import type { AvailableModel } from '../../execution/AvailableModel';
 import type { LlmExecutionTools } from '../../execution/LlmExecutionTools';
 import type { ChatPromptResult } from '../../execution/PromptResult';
@@ -7,6 +8,8 @@ import type { Prompt } from '../../types/Prompt';
 import type { string_markdown } from '../../types/typeAliases';
 import type { string_markdown_text } from '../../types/typeAliases';
 import type { string_title } from '../../types/typeAliases';
+import type { string_token } from '../../types/typeAliases';
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
 import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions';
 /**
  * Execution Tools for calling OpenAI API
@@ -14,7 +17,7 @@ import type { OpenAiExecutionToolsOptions } from './OpenAiExecutionToolsOptions'
  * @public exported from `@promptbook/openai`
  */
 export declare class OpenAiExecutionTools implements LlmExecutionTools {
-    private readonly options;
+    protected readonly options: OpenAiExecutionToolsOptions;
     /**
      * OpenAI API client.
      */
@@ -27,7 +30,14 @@ export declare class OpenAiExecutionTools implements LlmExecutionTools {
     constructor(options?: OpenAiExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;
-    private getClient;
+    getClient(): Promise<OpenAI>;
+    /**
+     * Create (sub)tools for calling OpenAI API Assistants
+     *
+     * @param assistantId Which assistant to use
+     * @returns Tools for calling OpenAI API Assistants with same token
+     */
+    createAssistantSubtools(assistantId: string_token): OpenAiAssistantExecutionTools;
     /**
      * Check the `options` passed to `constructor`
      */

package/esm/typings/src/llm-providers/openai/createOpenAiAssistantExecutionTools.d.ts

@@ -0,0 +1,15 @@
+import { OpenAiAssistantExecutionTools } from './OpenAiAssistantExecutionTools';
+import type { OpenAiAssistantExecutionToolsOptions } from './OpenAiAssistantExecutionToolsOptions';
+/**
+ * Execution Tools for calling OpenAI API
+ *
+ * @public exported from `@promptbook/openai`
+ */
+export declare const createOpenAiAssistantExecutionTools: ((options: OpenAiAssistantExecutionToolsOptions) => OpenAiAssistantExecutionTools) & {
+    packageName: string;
+    className: string;
+};
+/**
+ * TODO: [🦺] Is there some way how to put `packageName` and `className` on top and function definition on bottom?
+ * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
+ */

package/esm/typings/src/llm-providers/openai/register-configuration.d.ts

@@ -7,3 +7,12 @@
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiMetadataRegistration: void;
+/**
+ * @@@ registration1 of default configuration for Open AI
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/core`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantMetadataRegistration: void;

package/esm/typings/src/llm-providers/openai/register-constructor.d.ts

@@ -7,6 +7,15 @@
  * @public exported from `@promptbook/cli`
  */
 export declare const _OpenAiRegistration: void;
+/**
+ * @@@ registration2
+ *
+ * Note: [🏐] Configurations registrations are done in @@@ BUT constructor @@@
+ *
+ * @public exported from `@promptbook/openai`
+ * @public exported from `@promptbook/cli`
+ */
+export declare const _OpenAiAssistantRegistration: void;
 /**
  * TODO: [🎶] Naming "constructor" vs "creator" vs "factory"
  */

package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts

@@ -20,7 +20,7 @@ import type { RemoteLlmExecutionToolsOptions } from './interfaces/RemoteLlmExecu
  * @public exported from `@promptbook/remote-client`
  */
 export declare class RemoteLlmExecutionTools implements LlmExecutionTools {
-    private readonly options;
+    protected readonly options: RemoteLlmExecutionToolsOptions;
     constructor(options: RemoteLlmExecutionToolsOptions);
     get title(): string_title & string_markdown_text;
     get description(): string_markdown;

package/esm/typings/src/scripting/javascript/JavascriptEvalExecutionTools.d.ts

@@ -9,7 +9,7 @@ import type { JavascriptExecutionToolsOptions } from './JavascriptExecutionTools
  * @public exported from `@promptbook/execute-javascript`
  */
 export declare class JavascriptEvalExecutionTools implements ScriptExecutionTools {
-    private readonly options;
+    protected readonly options: JavascriptExecutionToolsOptions;
     constructor(options?: JavascriptExecutionToolsOptions);
     /**
      * Executes a JavaScript

package/esm/typings/src/scripting/python/PythonExecutionTools.d.ts

@@ -9,7 +9,7 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * @private still in development
  */
 export declare class PythonExecutionTools implements ScriptExecutionTools {
-    private readonly options;
+    protected readonly options: CommonExecutionToolsOptions;
     constructor(options?: CommonExecutionToolsOptions);
     /**
      * Executes a Python

package/esm/typings/src/scripting/typescript/TypescriptExecutionTools.d.ts

@@ -9,7 +9,7 @@ import type { ScriptExecutionToolsExecuteOptions } from '../../execution/ScriptE
  * @private still in development
  */
 export declare class TypescriptExecutionTools implements ScriptExecutionTools {
-    private readonly options;
+    protected readonly options: CommonExecutionToolsOptions;
     constructor(options?: CommonExecutionToolsOptions);
     /**
      * Executes a TypeScript

package/esm/typings/src/storage/files-storage/FilesStorage.d.ts

@@ -6,7 +6,7 @@ import type { FilesStorageOptions } from './FilesStorageOptions';
  * @public exported from `@promptbook/node`
  */
 export declare class FilesStorage<TItem> implements PromptbookStorage<TItem> {
-    private readonly options;
+    protected readonly options: FilesStorageOptions;
     constructor(options: FilesStorageOptions);
     /**
      * @@@

package/esm/typings/src/types/PipelineJson/KnowledgeSourceJson.d.ts

@@ -11,18 +11,11 @@ import type { string_name } from '../typeAliases';
  */
 export type KnowledgeSourceJson = {
     /**
-     * Unique identifier of the knowledge source
+     * @@@
      */
     readonly name: string_name;
     /**
-     * Source of one knowledge
-     *
-     * It can be a link, a relative path to file or direct text or combination of those
-     *
-     * For example `"https://pavolhejny.com/"`
-     * For example `"./pavol-hejny-cv.pdf"`
-     * For example `"Pavol Hejný has web https://pavolhejny.com/"`
-     * For example `"Pavol Hejný is web developer and creator of Promptbook and Collboard"`
+     * @@@
      */
     readonly sourceContent: string_knowledge_source_content;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@promptbook/openai",
-    "version": "0.71.0-0",
+    "version": "0.72.0-1",
     "description": "Supercharge your use of large language models",
     "private": false,
     "sideEffects": false,
@@ -51,7 +51,7 @@
     "module": "./esm/index.es.js",
     "typings": "./esm/typings/src/_packages/openai.index.d.ts",
     "peerDependencies": {
-        "@promptbook/core": "0.71.0-0"
+        "@promptbook/core": "0.72.0-1"
     },
     "dependencies": {
         "colors": "1.4.0",