@promptbook/openai 0.100.0-4 → 0.100.0-40
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.
- package/README.md +1 -0
- package/esm/index.es.js +136 -8
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/components.index.d.ts +4 -0
- package/esm/typings/src/_packages/core.index.d.ts +26 -0
- package/esm/typings/src/_packages/types.index.d.ts +30 -0
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.d.ts +30 -0
- package/esm/typings/src/book-2.0/agent-source/parseAgentSource.test.d.ts +1 -0
- package/esm/typings/src/book-2.0/agent-source/string_book.d.ts +26 -0
- package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +38 -0
- package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +39 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/FrontendRAGService.d.ts +48 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +51 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/RAGService.d.ts +54 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/BaseKnowledgeProcessor.d.ts +45 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/PdfProcessor.d.ts +31 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/ProcessorFactory.d.ts +23 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/processors/TextProcessor.d.ts +18 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/types.d.ts +56 -0
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/utils/ragHelper.d.ts +34 -0
- package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +56 -0
- package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +39 -0
- package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +49 -0
- package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +46 -0
- package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +44 -0
- package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +38 -0
- package/esm/typings/src/book-2.0/commitments/_base/BaseCommitmentDefinition.d.ts +52 -0
- package/esm/typings/src/book-2.0/commitments/_base/BookCommitment.d.ts +5 -0
- package/esm/typings/src/book-2.0/commitments/_base/CommitmentDefinition.d.ts +48 -0
- package/esm/typings/src/book-2.0/commitments/_base/NotYetImplementedCommitmentDefinition.d.ts +22 -0
- package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +19 -0
- package/esm/typings/src/book-2.0/commitments/_misc/AgentModelRequirements.d.ts +37 -0
- package/esm/typings/src/book-2.0/commitments/_misc/AgentSourceParseResult.d.ts +18 -0
- package/esm/typings/src/book-2.0/commitments/_misc/ParsedCommitment.d.ts +22 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirements.d.ts +61 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createAgentModelRequirementsWithCommitments.d.ts +35 -0
- package/esm/typings/src/book-2.0/commitments/_misc/createCommitmentRegex.d.ts +20 -0
- package/esm/typings/src/book-2.0/commitments/_misc/parseAgentSourceWithCommitments.d.ts +24 -0
- package/esm/typings/src/book-2.0/commitments/_misc/removeCommentsFromSystemMessage.d.ts +11 -0
- package/esm/typings/src/book-2.0/commitments/index.d.ts +56 -0
- package/esm/typings/src/book-2.0/utils/profileImageUtils.d.ts +39 -0
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +30 -0
- package/esm/typings/src/book-components/_common/react-utils/classNames.d.ts +7 -0
- package/esm/typings/src/config.d.ts +6 -0
- package/esm/typings/src/execution/AvailableModel.d.ts +4 -0
- package/esm/typings/src/execution/ExecutionTask.d.ts +27 -0
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +6 -1
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +0 -5
- package/esm/typings/src/llm-providers/anthropic-claude/anthropic-claude-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/deepseek/deepseek-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/google/google-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/ollama/ollama-models.d.ts +1 -1
- package/esm/typings/src/llm-providers/openai/openai-models.d.ts +1 -1
- package/esm/typings/src/pipeline/book-notation.d.ts +2 -1
- package/esm/typings/src/types/ModelRequirements.d.ts +0 -2
- package/esm/typings/src/types/typeAliases.d.ts +6 -0
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +136 -8
- package/umd/index.umd.js.map +1 -1
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { BookCommitment } from './_base/BookCommitment';
|
|
2
|
+
import type { CommitmentDefinition } from './_base/CommitmentDefinition';
|
|
3
|
+
import { ActionCommitmentDefinition } from './ACTION/ACTION';
|
|
4
|
+
import { FormatCommitmentDefinition } from './FORMAT/FORMAT';
|
|
5
|
+
import { KnowledgeCommitmentDefinition } from './KNOWLEDGE/KNOWLEDGE';
|
|
6
|
+
import { MetaImageCommitmentDefinition } from './META_IMAGE/META_IMAGE';
|
|
7
|
+
import { MetaLinkCommitmentDefinition } from './META_LINK/META_LINK';
|
|
8
|
+
import { ModelCommitmentDefinition } from './MODEL/MODEL';
|
|
9
|
+
import { NoteCommitmentDefinition } from './NOTE/NOTE';
|
|
10
|
+
import { PersonaCommitmentDefinition } from './PERSONA/PERSONA';
|
|
11
|
+
import { RuleCommitmentDefinition } from './RULE/RULE';
|
|
12
|
+
import { SampleCommitmentDefinition } from './SAMPLE/SAMPLE';
|
|
13
|
+
import { StyleCommitmentDefinition } from './STYLE/STYLE';
|
|
14
|
+
import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplementedCommitmentDefinition';
|
|
15
|
+
/**
|
|
16
|
+
* Registry of all available commitment definitions
|
|
17
|
+
* This array contains instances of all commitment definitions
|
|
18
|
+
* This is the single source of truth for all commitments in the system
|
|
19
|
+
*
|
|
20
|
+
* @private Use functions to access commitments instead of this array directly
|
|
21
|
+
*/
|
|
22
|
+
export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaImageCommitmentDefinition, MetaLinkCommitmentDefinition, NoteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"SCENARIO">, NotYetImplementedCommitmentDefinition<"SCENARIOS">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"GOAL">, NotYetImplementedCommitmentDefinition<"GOALS">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
|
|
23
|
+
/**
|
|
24
|
+
* Gets a commitment definition by its type
|
|
25
|
+
* @param type The commitment type to look up
|
|
26
|
+
* @returns The commitment definition or null if not found
|
|
27
|
+
*
|
|
28
|
+
* @public exported from `@promptbook/core`
|
|
29
|
+
*/
|
|
30
|
+
export declare function getCommitmentDefinition(type: BookCommitment): CommitmentDefinition | null;
|
|
31
|
+
/**
|
|
32
|
+
* Gets all available commitment definitions
|
|
33
|
+
* @returns Array of all commitment definitions
|
|
34
|
+
*
|
|
35
|
+
* @public exported from `@promptbook/core`
|
|
36
|
+
*/
|
|
37
|
+
export declare function getAllCommitmentDefinitions(): ReadonlyArray<CommitmentDefinition>;
|
|
38
|
+
/**
|
|
39
|
+
* Gets all available commitment types
|
|
40
|
+
* @returns Array of all commitment types
|
|
41
|
+
*
|
|
42
|
+
* @public exported from `@promptbook/core`
|
|
43
|
+
*/
|
|
44
|
+
export declare function getAllCommitmentTypes(): ReadonlyArray<BookCommitment>;
|
|
45
|
+
/**
|
|
46
|
+
* Checks if a commitment type is supported
|
|
47
|
+
* @param type The commitment type to check
|
|
48
|
+
* @returns True if the commitment type is supported
|
|
49
|
+
*
|
|
50
|
+
* @public exported from `@promptbook/core`
|
|
51
|
+
*/
|
|
52
|
+
export declare function isCommitmentSupported(type: BookCommitment): boolean;
|
|
53
|
+
/**
|
|
54
|
+
* TODO: !!!! Maybe create through standardized $register
|
|
55
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
56
|
+
*/
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import type { string_url_image } from '../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* Extracts profile image URL from agent definition text and returns cleaned system message
|
|
4
|
+
* @param systemMessage The original system message that may contain META IMAGE line
|
|
5
|
+
* @returns Object with profileImageUrl (if found) and cleanedSystemMessage (without META IMAGE line)
|
|
6
|
+
*
|
|
7
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
8
|
+
*/
|
|
9
|
+
export declare function extractProfileImageFromSystemMessage(systemMessage: string): {
|
|
10
|
+
profileImageUrl?: string_url_image;
|
|
11
|
+
cleanedSystemMessage: string;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* Extracts persona, examples, and profile image from agent definition text
|
|
15
|
+
* @param systemMessage The original system message that may contain PERSONA, EXAMPLE, and META IMAGE lines
|
|
16
|
+
* @returns Object with extracted information and cleaned system message
|
|
17
|
+
*
|
|
18
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
19
|
+
*/
|
|
20
|
+
export declare function extractAgentMetadata(systemMessage: string): {
|
|
21
|
+
persona?: {
|
|
22
|
+
name: string;
|
|
23
|
+
description?: string;
|
|
24
|
+
};
|
|
25
|
+
examples: string[];
|
|
26
|
+
profileImageUrl?: string_url_image;
|
|
27
|
+
cleanedSystemMessage: string;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Generates a gravatar URL based on agent name for fallback avatar
|
|
31
|
+
* @param name The agent name to generate avatar for
|
|
32
|
+
* @returns Gravatar URL
|
|
33
|
+
*
|
|
34
|
+
* @private - TODO: [🧠] Maybe should be public?
|
|
35
|
+
*/
|
|
36
|
+
export declare function generateGravatarUrl(name?: string | null): string;
|
|
37
|
+
/**
|
|
38
|
+
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
39
|
+
*/
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { string_book } from '../../book-2.0/agent-source/string_book';
|
|
2
|
+
export interface BookEditorProps {
|
|
3
|
+
/**
|
|
4
|
+
* Additional CSS classes to apply to the editor container.
|
|
5
|
+
*/
|
|
6
|
+
readonly className?: string;
|
|
7
|
+
/**
|
|
8
|
+
* CSS className for a font (e.g. from next/font) to style the editor text.
|
|
9
|
+
* If omitted, defaults to system serif fonts.
|
|
10
|
+
*/
|
|
11
|
+
readonly fontClassName?: string;
|
|
12
|
+
/**
|
|
13
|
+
* The book which is being edited.
|
|
14
|
+
*/
|
|
15
|
+
readonly value?: string_book;
|
|
16
|
+
/**
|
|
17
|
+
* Callback function to handle changes in the book content.
|
|
18
|
+
*/
|
|
19
|
+
onChange?(value: string_book): void;
|
|
20
|
+
/**
|
|
21
|
+
* If true, logs verbose debug info to the console and shows additional visual cues
|
|
22
|
+
*/
|
|
23
|
+
readonly isVerbose?: boolean;
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* Renders a book editor
|
|
27
|
+
*
|
|
28
|
+
* @public exported from `@promptbook/components`
|
|
29
|
+
*/
|
|
30
|
+
export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { string_css_class } from '../../../types/typeAliases';
|
|
2
|
+
/**
|
|
3
|
+
* Utility function for joining multiple truthy class names into one string
|
|
4
|
+
*
|
|
5
|
+
* @private within the `@promptbook/components`
|
|
6
|
+
*/
|
|
7
|
+
export declare function classNames(...classes: Array<string_css_class | undefined | false | null>): string_css_class;
|
|
@@ -281,6 +281,12 @@ export declare function SET_IS_VERBOSE(isVerbose: boolean): void;
|
|
|
281
281
|
* @public exported from `@promptbook/core`
|
|
282
282
|
*/
|
|
283
283
|
export declare const DEFAULT_IS_AUTO_INSTALLED = false;
|
|
284
|
+
/**
|
|
285
|
+
* Default simulated duration for a task in milliseconds (used for progress reporting)
|
|
286
|
+
*
|
|
287
|
+
* @public exported from `@promptbook/core`
|
|
288
|
+
*/
|
|
289
|
+
export declare const DEFAULT_TASK_SIMULATED_DURATION_MS: number;
|
|
284
290
|
/**
|
|
285
291
|
* Function name for generated function via `ptbk make` to get the pipeline collection
|
|
286
292
|
*
|
|
@@ -40,6 +40,10 @@ export type AvailableModel = {
|
|
|
40
40
|
readonly prompt: number_usd;
|
|
41
41
|
readonly output: number_usd;
|
|
42
42
|
};
|
|
43
|
+
/**
|
|
44
|
+
* If the model is deprecated, it should not be used for new tasks
|
|
45
|
+
*/
|
|
46
|
+
readonly isDeprecated?: boolean;
|
|
43
47
|
};
|
|
44
48
|
/**
|
|
45
49
|
* TODO: [🧠] Maybe rename to something else - like `ModelInformation` or `ModelMetadata`
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { Observable } from 'rxjs';
|
|
2
2
|
import { PartialDeep } from 'type-fest';
|
|
3
|
+
import type { number_percent } from '../types/typeAliases';
|
|
3
4
|
import type { task_id } from '../types/typeAliases';
|
|
4
5
|
import type { string_SCREAMING_CASE } from '../utils/normalization/normalizeTo_SCREAMING_CASE';
|
|
5
6
|
import type { string_promptbook_version } from '../version';
|
|
@@ -28,6 +29,19 @@ type CreateTaskOptions<TTaskResult extends AbstractTaskResult> = {
|
|
|
28
29
|
*/
|
|
29
30
|
readonly title?: AbstractTask<TTaskResult>['title'];
|
|
30
31
|
}) => void): Promise<TTaskResult>;
|
|
32
|
+
/**
|
|
33
|
+
* Optional callback to provide custom tldr information
|
|
34
|
+
* @param createdAt When the task was created
|
|
35
|
+
* @param status Current task status
|
|
36
|
+
* @param currentValue Current partial result
|
|
37
|
+
* @param errors Current errors
|
|
38
|
+
* @param warnings Current warnings
|
|
39
|
+
* @returns Custom tldr information
|
|
40
|
+
*/
|
|
41
|
+
tldrProvider?(createdAt: Date, status: task_status, currentValue: PartialDeep<TTaskResult>, errors: Array<Error>, warnings: Array<Error>): {
|
|
42
|
+
readonly percent: number_percent;
|
|
43
|
+
readonly message: string;
|
|
44
|
+
};
|
|
31
45
|
};
|
|
32
46
|
/**
|
|
33
47
|
* Helper to create a new task
|
|
@@ -80,6 +94,19 @@ export type AbstractTask<TTaskResult extends AbstractTaskResult> = {
|
|
|
80
94
|
* Status of the task
|
|
81
95
|
*/
|
|
82
96
|
readonly status: task_status;
|
|
97
|
+
/**
|
|
98
|
+
* Short summary of the task status for quick overview in the UI
|
|
99
|
+
*/
|
|
100
|
+
readonly tldr: {
|
|
101
|
+
/**
|
|
102
|
+
* Progress in percentage from 0 to 1 (100%) that can be used to display a progress bar
|
|
103
|
+
*/
|
|
104
|
+
readonly percent: number_percent;
|
|
105
|
+
/**
|
|
106
|
+
* Short summary message of the task status that can be displayed in the UI
|
|
107
|
+
*/
|
|
108
|
+
readonly message: string;
|
|
109
|
+
};
|
|
83
110
|
/**
|
|
84
111
|
* Date when the task was created
|
|
85
112
|
*/
|
|
@@ -1,10 +1,11 @@
|
|
|
1
|
-
import type { ReadonlyDeep, WritableDeep } from 'type-fest';
|
|
1
|
+
import type { PartialDeep, Promisable, ReadonlyDeep, WritableDeep } from 'type-fest';
|
|
2
2
|
import type { PipelineJson } from '../../pipeline/PipelineJson/PipelineJson';
|
|
3
3
|
import type { TaskJson } from '../../pipeline/PipelineJson/TaskJson';
|
|
4
4
|
import type { Parameters } from '../../types/typeAliases';
|
|
5
5
|
import type { string_parameter_name } from '../../types/typeAliases';
|
|
6
6
|
import type { TODO_string } from '../../utils/organization/TODO_string';
|
|
7
7
|
import type { ExecutionReportJson } from '../execution-report/ExecutionReportJson';
|
|
8
|
+
import type { PipelineExecutorResult } from '../PipelineExecutorResult';
|
|
8
9
|
import type { CreatePipelineExecutorOptions } from './00-CreatePipelineExecutorOptions';
|
|
9
10
|
/**
|
|
10
11
|
* Options for executing attempts of a pipeline task, including configuration for jokers, priority,
|
|
@@ -46,6 +47,10 @@ export type ExecuteAttemptsOptions = Required<Omit<CreatePipelineExecutorOptions
|
|
|
46
47
|
* The pipeline structure prepared for execution, as a deeply immutable PipelineJson object.
|
|
47
48
|
*/
|
|
48
49
|
readonly preparedPipeline: ReadonlyDeep<PipelineJson>;
|
|
50
|
+
/**
|
|
51
|
+
* Callback invoked with partial results as the execution progresses.
|
|
52
|
+
*/
|
|
53
|
+
onProgress(newOngoingResult: PartialDeep<PipelineExecutorResult>): Promisable<void>;
|
|
49
54
|
/**
|
|
50
55
|
* The execution report object, which is updated during execution.
|
|
51
56
|
*/
|
|
@@ -2,7 +2,6 @@ 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';
|
|
6
5
|
import type { Prompt } from '../../types/Prompt';
|
|
7
6
|
import type { string_markdown } from '../../types/typeAliases';
|
|
8
7
|
import type { string_markdown_text } from '../../types/typeAliases';
|
|
@@ -42,10 +41,6 @@ export declare class AnthropicClaudeExecutionTools implements LlmExecutionTools
|
|
|
42
41
|
* Calls Anthropic Claude API to use a chat model.
|
|
43
42
|
*/
|
|
44
43
|
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>;
|
|
49
44
|
/**
|
|
50
45
|
* Get the model that should be used as default
|
|
51
46
|
*/
|
|
@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
|
|
|
3
3
|
/**
|
|
4
4
|
* List of available Anthropic Claude models with pricing
|
|
5
5
|
*
|
|
6
|
-
* Note:
|
|
6
|
+
* Note: Synced with official API docs at 2025-08-20
|
|
7
7
|
*
|
|
8
8
|
* @see https://docs.anthropic.com/en/docs/models-overview
|
|
9
9
|
* @public exported from `@promptbook/anthropic-claude`
|
|
@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
|
|
|
3
3
|
/**
|
|
4
4
|
* List of available Deepseek models with descriptions
|
|
5
5
|
*
|
|
6
|
-
* Note:
|
|
6
|
+
* Note: Synced with official API docs at 2025-08-20
|
|
7
7
|
*
|
|
8
8
|
* @see https://www.deepseek.com/models
|
|
9
9
|
* @public exported from `@promptbook/deepseek`
|
|
@@ -3,7 +3,7 @@ import type { number_usd } from '../../types/typeAliases';
|
|
|
3
3
|
/**
|
|
4
4
|
* List of available Google models with descriptions
|
|
5
5
|
*
|
|
6
|
-
* Note:
|
|
6
|
+
* Note: Synced with official API docs at 2025-08-20
|
|
7
7
|
*
|
|
8
8
|
* @see https://ai.google.dev/models/gemini
|
|
9
9
|
* @public exported from `@promptbook/google`
|
|
@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
|
|
|
2
2
|
/**
|
|
3
3
|
* List of available models in Ollama library
|
|
4
4
|
*
|
|
5
|
-
* Note:
|
|
5
|
+
* Note: Synced with official API docs at 2025-08-20
|
|
6
6
|
*
|
|
7
7
|
* @see https://ollama.com/library
|
|
8
8
|
* @public exported from `@promptbook/ollama`
|
|
@@ -2,7 +2,7 @@ import type { AvailableModel } from '../../execution/AvailableModel';
|
|
|
2
2
|
/**
|
|
3
3
|
* List of available OpenAI models with pricing
|
|
4
4
|
*
|
|
5
|
-
* Note:
|
|
5
|
+
* Note: Synced with official API docs at 2025-08-20
|
|
6
6
|
*
|
|
7
7
|
* @see https://platform.openai.com/docs/models/
|
|
8
8
|
* @see https://openai.com/api/pricing/
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { string_book } from '../book-2.0/agent-source/string_book';
|
|
1
2
|
import type { PipelineString } from './PipelineString';
|
|
2
3
|
/**
|
|
3
4
|
* Tag function for notating a pipeline with a book\`...\ notation as template literal
|
|
@@ -12,7 +13,7 @@ import type { PipelineString } from './PipelineString';
|
|
|
12
13
|
* @returns the pipeline string
|
|
13
14
|
* @public exported from `@promptbook/core`
|
|
14
15
|
*/
|
|
15
|
-
export declare function book(strings: TemplateStringsArray, ...values: Array<string>): PipelineString;
|
|
16
|
+
export declare function book(strings: TemplateStringsArray, ...values: Array<string>): string_book & PipelineString;
|
|
16
17
|
/**
|
|
17
18
|
* TODO: [🧠][🈴] Where is the best location for this file
|
|
18
19
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -136,6 +136,12 @@ export type ReservedParameters = Record<string_reserved_parameter_name, string_p
|
|
|
136
136
|
* For example `"Ai*nautes"`
|
|
137
137
|
*/
|
|
138
138
|
export type string_title = string;
|
|
139
|
+
/**
|
|
140
|
+
* Semantic helper
|
|
141
|
+
*
|
|
142
|
+
* For example `"My AI Assistant"`
|
|
143
|
+
*/
|
|
144
|
+
export type string_agent_name = string;
|
|
139
145
|
/**
|
|
140
146
|
* Unstructured description of the persona
|
|
141
147
|
*
|
|
@@ -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.100.0-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.100.0-39`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@promptbook/openai",
|
|
3
|
-
"version": "0.100.0-
|
|
3
|
+
"version": "0.100.0-40",
|
|
4
4
|
"description": "Promptbook: Run AI apps in plain human language across multiple models and platforms",
|
|
5
5
|
"private": false,
|
|
6
6
|
"sideEffects": false,
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
"module": "./esm/index.es.js",
|
|
103
103
|
"typings": "./esm/typings/src/_packages/openai.index.d.ts",
|
|
104
104
|
"peerDependencies": {
|
|
105
|
-
"@promptbook/core": "0.100.0-
|
|
105
|
+
"@promptbook/core": "0.100.0-40"
|
|
106
106
|
},
|
|
107
107
|
"dependencies": {
|
|
108
108
|
"bottleneck": "^2.19.5",
|
package/umd/index.umd.js
CHANGED
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
* @generated
|
|
26
26
|
* @see https://github.com/webgptorg/promptbook
|
|
27
27
|
*/
|
|
28
|
-
const PROMPTBOOK_ENGINE_VERSION = '0.100.0-
|
|
28
|
+
const PROMPTBOOK_ENGINE_VERSION = '0.100.0-40';
|
|
29
29
|
/**
|
|
30
30
|
* TODO: string_promptbook_version should be constrained to the all versions of Promptbook engine
|
|
31
31
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
|
@@ -1289,7 +1289,7 @@
|
|
|
1289
1289
|
/**
|
|
1290
1290
|
* List of available OpenAI models with pricing
|
|
1291
1291
|
*
|
|
1292
|
-
* Note:
|
|
1292
|
+
* Note: Synced with official API docs at 2025-08-20
|
|
1293
1293
|
*
|
|
1294
1294
|
* @see https://platform.openai.com/docs/models/
|
|
1295
1295
|
* @see https://openai.com/api/pricing/
|
|
@@ -1298,6 +1298,138 @@
|
|
|
1298
1298
|
const OPENAI_MODELS = exportJson({
|
|
1299
1299
|
name: 'OPENAI_MODELS',
|
|
1300
1300
|
value: [
|
|
1301
|
+
/**/
|
|
1302
|
+
{
|
|
1303
|
+
modelVariant: 'CHAT',
|
|
1304
|
+
modelTitle: 'gpt-5',
|
|
1305
|
+
modelName: 'gpt-5',
|
|
1306
|
+
modelDescription: "OpenAI's most advanced language model with unprecedented reasoning capabilities and 200K context window. Features revolutionary improvements in complex problem-solving, scientific reasoning, and creative tasks. Demonstrates human-level performance across diverse domains with enhanced safety measures and alignment. Represents the next generation of AI with superior understanding, nuanced responses, and advanced multimodal capabilities.",
|
|
1307
|
+
pricing: {
|
|
1308
|
+
prompt: pricing(`$1.25 / 1M tokens`),
|
|
1309
|
+
output: pricing(`$10.00 / 1M tokens`),
|
|
1310
|
+
},
|
|
1311
|
+
},
|
|
1312
|
+
/**/
|
|
1313
|
+
/**/
|
|
1314
|
+
{
|
|
1315
|
+
modelVariant: 'CHAT',
|
|
1316
|
+
modelTitle: 'gpt-5-mini',
|
|
1317
|
+
modelName: 'gpt-5-mini',
|
|
1318
|
+
modelDescription: "A faster, cost-efficient version of GPT-5 for well-defined tasks with 200K context window. Maintains core GPT-5 capabilities while offering 5x faster inference and significantly lower costs. Features enhanced instruction following and reduced latency for production applications requiring quick responses with high quality.",
|
|
1319
|
+
pricing: {
|
|
1320
|
+
prompt: pricing(`$0.25 / 1M tokens`),
|
|
1321
|
+
output: pricing(`$2.00 / 1M tokens`),
|
|
1322
|
+
},
|
|
1323
|
+
},
|
|
1324
|
+
/**/
|
|
1325
|
+
/**/
|
|
1326
|
+
{
|
|
1327
|
+
modelVariant: 'CHAT',
|
|
1328
|
+
modelTitle: 'gpt-5-nano',
|
|
1329
|
+
modelName: 'gpt-5-nano',
|
|
1330
|
+
modelDescription: "The fastest, most cost-efficient version of GPT-5 with 200K context window. Optimized for summarization, classification, and simple reasoning tasks. Features 10x faster inference than base GPT-5 while maintaining good quality for straightforward applications. Ideal for high-volume, cost-sensitive deployments.",
|
|
1331
|
+
pricing: {
|
|
1332
|
+
prompt: pricing(`$0.05 / 1M tokens`),
|
|
1333
|
+
output: pricing(`$0.40 / 1M tokens`),
|
|
1334
|
+
},
|
|
1335
|
+
},
|
|
1336
|
+
/**/
|
|
1337
|
+
/**/
|
|
1338
|
+
{
|
|
1339
|
+
modelVariant: 'CHAT',
|
|
1340
|
+
modelTitle: 'gpt-4.1',
|
|
1341
|
+
modelName: 'gpt-4.1',
|
|
1342
|
+
modelDescription: "Smartest non-reasoning model with 128K context window. Enhanced version of GPT-4 with improved instruction following, better factual accuracy, and reduced hallucinations. Features advanced function calling capabilities and superior performance on coding tasks. Ideal for applications requiring high intelligence without reasoning overhead.",
|
|
1343
|
+
pricing: {
|
|
1344
|
+
prompt: pricing(`$3.00 / 1M tokens`),
|
|
1345
|
+
output: pricing(`$12.00 / 1M tokens`),
|
|
1346
|
+
},
|
|
1347
|
+
},
|
|
1348
|
+
/**/
|
|
1349
|
+
/**/
|
|
1350
|
+
{
|
|
1351
|
+
modelVariant: 'CHAT',
|
|
1352
|
+
modelTitle: 'gpt-4.1-mini',
|
|
1353
|
+
modelName: 'gpt-4.1-mini',
|
|
1354
|
+
modelDescription: "Smaller, faster version of GPT-4.1 with 128K context window. Balances intelligence and efficiency with 3x faster inference than base GPT-4.1. Maintains strong capabilities across text generation, reasoning, and coding while offering better cost-performance ratio for most applications.",
|
|
1355
|
+
pricing: {
|
|
1356
|
+
prompt: pricing(`$0.80 / 1M tokens`),
|
|
1357
|
+
output: pricing(`$3.20 / 1M tokens`),
|
|
1358
|
+
},
|
|
1359
|
+
},
|
|
1360
|
+
/**/
|
|
1361
|
+
/**/
|
|
1362
|
+
{
|
|
1363
|
+
modelVariant: 'CHAT',
|
|
1364
|
+
modelTitle: 'gpt-4.1-nano',
|
|
1365
|
+
modelName: 'gpt-4.1-nano',
|
|
1366
|
+
modelDescription: "Fastest, most cost-efficient version of GPT-4.1 with 128K context window. Optimized for high-throughput applications requiring good quality at minimal cost. Features 5x faster inference than GPT-4.1 while maintaining adequate performance for most general-purpose tasks.",
|
|
1367
|
+
pricing: {
|
|
1368
|
+
prompt: pricing(`$0.20 / 1M tokens`),
|
|
1369
|
+
output: pricing(`$0.80 / 1M tokens`),
|
|
1370
|
+
},
|
|
1371
|
+
},
|
|
1372
|
+
/**/
|
|
1373
|
+
/**/
|
|
1374
|
+
{
|
|
1375
|
+
modelVariant: 'CHAT',
|
|
1376
|
+
modelTitle: 'o3',
|
|
1377
|
+
modelName: 'o3',
|
|
1378
|
+
modelDescription: "Advanced reasoning model with 128K context window specializing in complex logical, mathematical, and analytical tasks. Successor to o1 with enhanced step-by-step problem-solving capabilities and superior performance on STEM-focused problems. Ideal for professional applications requiring deep analytical thinking and precise reasoning.",
|
|
1379
|
+
pricing: {
|
|
1380
|
+
prompt: pricing(`$15.00 / 1M tokens`),
|
|
1381
|
+
output: pricing(`$60.00 / 1M tokens`),
|
|
1382
|
+
},
|
|
1383
|
+
},
|
|
1384
|
+
/**/
|
|
1385
|
+
/**/
|
|
1386
|
+
{
|
|
1387
|
+
modelVariant: 'CHAT',
|
|
1388
|
+
modelTitle: 'o3-pro',
|
|
1389
|
+
modelName: 'o3-pro',
|
|
1390
|
+
modelDescription: "Enhanced version of o3 with more compute allocated for better responses on the most challenging problems. Features extended reasoning time and improved accuracy on complex analytical tasks. Designed for applications where maximum reasoning quality is more important than response speed.",
|
|
1391
|
+
pricing: {
|
|
1392
|
+
prompt: pricing(`$30.00 / 1M tokens`),
|
|
1393
|
+
output: pricing(`$120.00 / 1M tokens`),
|
|
1394
|
+
},
|
|
1395
|
+
},
|
|
1396
|
+
/**/
|
|
1397
|
+
/**/
|
|
1398
|
+
{
|
|
1399
|
+
modelVariant: 'CHAT',
|
|
1400
|
+
modelTitle: 'o4-mini',
|
|
1401
|
+
modelName: 'o4-mini',
|
|
1402
|
+
modelDescription: "Fast, cost-efficient reasoning model with 128K context window. Successor to o1-mini with improved analytical capabilities while maintaining speed advantages. Features enhanced mathematical reasoning and logical problem-solving at significantly lower cost than full reasoning models.",
|
|
1403
|
+
pricing: {
|
|
1404
|
+
prompt: pricing(`$4.00 / 1M tokens`),
|
|
1405
|
+
output: pricing(`$16.00 / 1M tokens`),
|
|
1406
|
+
},
|
|
1407
|
+
},
|
|
1408
|
+
/**/
|
|
1409
|
+
/**/
|
|
1410
|
+
{
|
|
1411
|
+
modelVariant: 'CHAT',
|
|
1412
|
+
modelTitle: 'o3-deep-research',
|
|
1413
|
+
modelName: 'o3-deep-research',
|
|
1414
|
+
modelDescription: "Most powerful deep research model with 128K context window. Specialized for comprehensive research tasks, literature analysis, and complex information synthesis. Features advanced citation capabilities and enhanced factual accuracy for academic and professional research applications.",
|
|
1415
|
+
pricing: {
|
|
1416
|
+
prompt: pricing(`$25.00 / 1M tokens`),
|
|
1417
|
+
output: pricing(`$100.00 / 1M tokens`),
|
|
1418
|
+
},
|
|
1419
|
+
},
|
|
1420
|
+
/**/
|
|
1421
|
+
/**/
|
|
1422
|
+
{
|
|
1423
|
+
modelVariant: 'CHAT',
|
|
1424
|
+
modelTitle: 'o4-mini-deep-research',
|
|
1425
|
+
modelName: 'o4-mini-deep-research',
|
|
1426
|
+
modelDescription: "Faster, more affordable deep research model with 128K context window. Balances research capabilities with cost efficiency, offering good performance on literature review, fact-checking, and information synthesis tasks at a more accessible price point.",
|
|
1427
|
+
pricing: {
|
|
1428
|
+
prompt: pricing(`$12.00 / 1M tokens`),
|
|
1429
|
+
output: pricing(`$48.00 / 1M tokens`),
|
|
1430
|
+
},
|
|
1431
|
+
},
|
|
1432
|
+
/**/
|
|
1301
1433
|
/*/
|
|
1302
1434
|
{
|
|
1303
1435
|
modelTitle: 'dall-e-3',
|
|
@@ -1880,7 +2012,6 @@
|
|
|
1880
2012
|
const modelSettings = {
|
|
1881
2013
|
model: modelName,
|
|
1882
2014
|
max_tokens: modelRequirements.maxTokens,
|
|
1883
|
-
// <- TODO: [🌾] Make some global max cap for maxTokens
|
|
1884
2015
|
temperature: modelRequirements.temperature,
|
|
1885
2016
|
// <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
|
|
1886
2017
|
// <- Note: [🧆]
|
|
@@ -1976,8 +2107,7 @@
|
|
|
1976
2107
|
const modelName = modelRequirements.modelName || this.getDefaultCompletionModel().modelName;
|
|
1977
2108
|
const modelSettings = {
|
|
1978
2109
|
model: modelName,
|
|
1979
|
-
max_tokens: modelRequirements.maxTokens
|
|
1980
|
-
// <- TODO: [🌾] Make some global max cap for maxTokens
|
|
2110
|
+
max_tokens: modelRequirements.maxTokens,
|
|
1981
2111
|
temperature: modelRequirements.temperature,
|
|
1982
2112
|
// <- TODO: [🈁] Use `seed` here AND/OR use is `isDeterministic` for entire execution tools
|
|
1983
2113
|
// <- Note: [🧆]
|
|
@@ -2168,7 +2298,7 @@
|
|
|
2168
2298
|
* Default model for chat variant.
|
|
2169
2299
|
*/
|
|
2170
2300
|
getDefaultChatModel() {
|
|
2171
|
-
return this.getDefaultModel('gpt-
|
|
2301
|
+
return this.getDefaultModel('gpt-5');
|
|
2172
2302
|
}
|
|
2173
2303
|
/**
|
|
2174
2304
|
* Default model for completion variant.
|
|
@@ -2236,8 +2366,6 @@
|
|
|
2236
2366
|
const modelName = modelRequirements.modelName || this.getDefaultChatModel().modelName;
|
|
2237
2367
|
const modelSettings = {
|
|
2238
2368
|
model: modelName,
|
|
2239
|
-
max_tokens: modelRequirements.maxTokens,
|
|
2240
|
-
// <- TODO: [🌾] Make some global max cap for maxTokens
|
|
2241
2369
|
|
|
2242
2370
|
temperature: modelRequirements.temperature,
|
|
2243
2371
|
|