@promptbook/utils 0.44.0 → 0.46.0-0

package/umd/typings/execution/plugins/natural-execution-tools/openai/OpenAiExecutionToolsOptions.d.ts

@@ -1,13 +1,13 @@
-import { string_token } from '../../../.././types/typeAliases';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { ClientOptions } from 'openai';
+import type { string_token } from '../../../.././types/typeAliases';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 /**
  * Options for OpenAiExecutionTools
+ *
+ * This extends OpenAI's `ClientOptions` with are directly passed to the OpenAI client.
+ * Rest is used by the `OpenAiExecutionTools`.
  */
-export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & {
-    /**
-     * OpenAI API key
-     */
-    openAiApiKey: string_token;
+export type OpenAiExecutionToolsOptions = CommonExecutionToolsOptions & ClientOptions & {
     /**
      * A unique identifier representing your end-user, which can help OpenAI to monitor
      * and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).

package/umd/typings/execution/plugins/natural-execution-tools/remote/RemoteNaturalExecutionToolsOptions.d.ts

@@ -1,5 +1,5 @@
 import type { client_id, string_uri } from '../../../.././types/typeAliases';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
 /**
  * Options for RemoteNaturalExecutionTools
  */

package/umd/typings/execution/plugins/user-interface-execution-tools/callback/CallbackInterfaceToolsOptions.d.ts

@@ -1,6 +1,6 @@
-import { Promisable } from 'type-fest';
-import { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
-import { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
+import type { Promisable } from 'type-fest';
+import type { CommonExecutionToolsOptions } from '../../../CommonExecutionToolsOptions';
+import type { UserInterfaceToolsPromptDialogOptions } from '../../../UserInterfaceTools';
 /**
  * Options for CallbackInterfaceTools
  */

package/umd/typings/execution/translation/automatic-translate/automatic-translators/AutomaticTranslator.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
+import type { Promisable } from 'type-fest';
 export type AutomaticTranslator = {
     translate(message: string): Promisable<string>;
 };

package/umd/typings/library/PromptbookLibrary.d.ts

@@ -1,4 +1,4 @@
-import { Promisable } from 'type-fest';
+import type { Promisable } from 'type-fest';
 import type { Prompt } from '../types/Prompt';
 import type { PromptbookJson } from '../types/PromptbookJson/PromptbookJson';
 import type { string_promptbook_url } from '../types/typeAliases';

package/umd/typings/types/ExecutionTypes.d.ts

@@ -1,4 +1,4 @@
-import { TupleToUnion } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 /**
  * Execution type describes the way how the block is executed
  *

package/umd/typings/types/ModelRequirements.d.ts

@@ -1,4 +1,4 @@
-import { string_model_name } from './typeAliases';
+import type { string_model_name } from './typeAliases';
 export declare const MODEL_VARIANTS: readonly ["COMPLETION", "CHAT"];
 /**
  * Model variant describes the very general type of the model

package/umd/typings/types/Prompt.d.ts

@@ -1,5 +1,5 @@
 import type { string_name, string_prompt, string_promptbook_url_with_hashtemplate, string_title } from '.././types/typeAliases';
-import { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
+import type { PostprocessingFunction } from '../execution/plugins/script-execution-tools/javascript/JavascriptExecutionToolsOptions';
 import type { ModelRequirements } from './ModelRequirements';
 import type { Expectations } from './PromptbookJson/PromptTemplateJson';
 /**

package/umd/typings/types/PromptbookJson/PromptTemplateJson.d.ts

@@ -1,8 +1,8 @@
-import { ExpectFormatCommand } from '../Command';
-import { ExecutionType } from '../ExecutionTypes';
-import { ModelRequirements } from '../ModelRequirements';
-import { ScriptLanguage } from '../ScriptLanguage';
-import { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
+import type { ExpectFormatCommand } from '../Command';
+import type { ExecutionType } from '../ExecutionTypes';
+import type { ModelRequirements } from '../ModelRequirements';
+import type { ScriptLanguage } from '../ScriptLanguage';
+import type { number_integer, number_positive_or_zero, string_javascript, string_javascript_name, string_markdown, string_name, string_prompt, string_template } from '../typeAliases';
 /**
  * Describes one prompt template in the promptbook
  */

package/umd/typings/types/PromptbookJson/PromptTemplateParameterJson.d.ts

@@ -1,4 +1,4 @@
-import { string_name } from '../typeAliases';
+import type { string_name } from '../typeAliases';
 /**
  * Describes one parameter of the promptbook
  */

package/umd/typings/types/PromptbookJson/PromptbookJson.d.ts

@@ -1,6 +1,6 @@
-import { string_promptbook_url, string_version } from '../typeAliases';
-import { PromptTemplateJson } from './PromptTemplateJson';
-import { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
+import type { string_promptbook_url, string_version } from '../typeAliases';
+import type { PromptTemplateJson } from './PromptTemplateJson';
+import type { PromptTemplateParameterJson } from './PromptTemplateParameterJson';
 /**
  * Promptbook is the **core concept of this library**.
  * It represents a series of prompt templates chained together to form a pipeline / one big prompt template with input and result parameters.

package/umd/typings/types/ScriptLanguage.d.ts

@@ -1,4 +1,4 @@
-import { TupleToUnion } from 'type-fest';
+import type { TupleToUnion } from 'type-fest';
 /**
  * Supported script languages
  */

package/umd/typings/types/TaskProgress.d.ts

@@ -1,5 +1,5 @@
-import { ExecutionType } from './ExecutionTypes';
-import { string_markdown_text, string_name } from './typeAliases';
+import type { ExecutionType } from './ExecutionTypes';
+import type { string_markdown_text, string_name } from './typeAliases';
 /**
  * TaskProgress represents the progress of a Promptbook execution.
  */

package/umd/typings/types/execution-report/ExecutionReportStringOptions.d.ts

@@ -1,4 +1,4 @@
-import { number_percent } from '../typeAliases';
+import type { number_percent } from '../typeAliases';
 /**
  * Options for generating an execution report string
  */

package/umd/typings/utils/markdown/extractAllBlocksFromMarkdown.d.ts

@@ -1,4 +1,4 @@
-import { string_markdown } from '../../types/typeAliases';
+import type { string_markdown } from '../../types/typeAliases';
 /**
  * Single code block inside markdown.
  */