@promptbook/editable 0.101.0-8 → 0.101.0
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 +0 -4
- package/esm/index.es.js +1 -1
- package/esm/index.es.js.map +1 -1
- package/esm/typings/src/_packages/components.index.d.ts +14 -0
- package/esm/typings/src/_packages/core.index.d.ts +12 -0
- package/esm/typings/src/_packages/types.index.d.ts +8 -0
- package/esm/typings/src/book-2.0/agent-source/AgentBasicInformation.d.ts +11 -4
- package/esm/typings/src/book-2.0/agent-source/AgentModelRequirements.d.ts +3 -0
- package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirements.d.ts +4 -22
- package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments.d.ts +1 -26
- package/esm/typings/src/book-2.0/commitments/ACTION/ACTION.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/DELETE/DELETE.d.ts +0 -24
- package/esm/typings/src/book-2.0/commitments/FORMAT/FORMAT.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/GOAL/GOAL.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/KNOWLEDGE/KNOWLEDGE.d.ts +0 -6
- package/esm/typings/src/book-2.0/commitments/MEMORY/MEMORY.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/MESSAGE/MESSAGE.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/META/META.d.ts +0 -6
- package/esm/typings/src/book-2.0/commitments/META_IMAGE/META_IMAGE.d.ts +0 -6
- package/esm/typings/src/book-2.0/commitments/META_LINK/META_LINK.d.ts +0 -6
- package/esm/typings/src/book-2.0/commitments/MODEL/MODEL.d.ts +25 -10
- package/esm/typings/src/book-2.0/commitments/NOTE/NOTE.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/PERSONA/PERSONA.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/RULE/RULE.d.ts +0 -12
- package/esm/typings/src/book-2.0/commitments/SAMPLE/SAMPLE.d.ts +0 -12
- package/esm/typings/src/book-2.0/commitments/SCENARIO/SCENARIO.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/STYLE/STYLE.d.ts +2 -8
- package/esm/typings/src/book-2.0/commitments/_base/createEmptyAgentModelRequirements.d.ts +1 -1
- package/esm/typings/src/book-2.0/commitments/index.d.ts +1 -1
- package/esm/typings/src/book-2.0/utils/generatePlaceholderAgentProfileImageUrl.d.ts +3 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarChip/AvatarChip.d.ts +5 -2
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/AvatarProfile.d.ts +3 -0
- package/esm/typings/src/book-components/AvatarProfile/AvatarProfile/MockedChat.d.ts +18 -1
- package/esm/typings/src/book-components/BookEditor/BookEditor.d.ts +8 -0
- package/esm/typings/src/book-components/BookEditor/BookEditorInner.d.ts +2 -15
- package/esm/typings/src/book-components/Chat/Chat/ChatProps.d.ts +9 -0
- package/esm/typings/src/book-components/Chat/LlmChat/LlmChatProps.d.ts +13 -0
- package/esm/typings/src/book-components/Chat/hooks/index.d.ts +2 -0
- package/esm/typings/src/book-components/Chat/hooks/useChatAutoScroll.d.ts +41 -0
- package/esm/typings/src/book-components/Chat/hooks/useSendMessageToLlmChat.d.ts +44 -0
- package/esm/typings/src/book-components/Chat/utils/parseMessageButtons.d.ts +22 -0
- package/esm/typings/src/book-components/icons/PauseIcon.d.ts +8 -0
- package/esm/typings/src/book-components/icons/PlayIcon.d.ts +8 -0
- package/esm/typings/src/execution/PromptResult.d.ts +2 -4
- package/esm/typings/src/execution/createPipelineExecutor/40-executeAttempts.d.ts +1 -2
- package/esm/typings/src/execution/createPipelineExecutor/getKnowledgeForTask.d.ts +1 -3
- package/esm/typings/src/formats/csv/CsvFormatError.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsConfigurationFromEnv.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForTestingAndScriptsAndPlayground.d.ts +1 -1
- package/esm/typings/src/llm-providers/_common/register/$provideLlmToolsForWizardOrCli.d.ts +1 -2
- package/esm/typings/src/llm-providers/_common/register/createLlmToolsFromConfiguration.d.ts +8 -2
- package/esm/typings/src/llm-providers/_common/utils/removeUnsupportedModelRequirements.d.ts +25 -0
- package/esm/typings/src/llm-providers/_multiple/MultipleLlmExecutionTools.d.ts +7 -18
- package/esm/typings/src/llm-providers/_multiple/getSingleLlmExecutionTools.d.ts +11 -0
- package/esm/typings/src/llm-providers/_multiple/joinLlmExecutionTools.d.ts +2 -1
- package/esm/typings/src/llm-providers/agent/AgentLlmExecutionTools.d.ts +58 -0
- package/esm/typings/src/llm-providers/agent/createAgentLlmExecutionTools.d.ts +29 -0
- package/esm/typings/src/llm-providers/agent/playground/playground.d.ts +8 -0
- package/esm/typings/src/llm-providers/agent/register-configuration.d.ts +11 -0
- package/esm/typings/src/llm-providers/agent/register-constructor.d.ts +13 -0
- package/esm/typings/src/llm-providers/anthropic-claude/AnthropicClaudeExecutionTools.d.ts +3 -8
- package/esm/typings/src/llm-providers/azure-openai/AzureOpenAiExecutionTools.d.ts +4 -5
- package/esm/typings/src/llm-providers/mocked/$fakeTextToExpectations.d.ts +1 -0
- package/esm/typings/src/llm-providers/mocked/MockedEchoLlmExecutionTools.d.ts +4 -10
- package/esm/typings/src/llm-providers/mocked/MockedFackedLlmExecutionTools.d.ts +4 -6
- package/esm/typings/src/llm-providers/ollama/OllamaExecutionTools.d.ts +3 -3
- package/esm/typings/src/llm-providers/openai/OpenAiCompatibleExecutionTools.d.ts +16 -8
- package/esm/typings/src/llm-providers/openai/OpenAiExecutionTools.d.ts +3 -8
- package/esm/typings/src/llm-providers/remote/RemoteLlmExecutionTools.d.ts +5 -14
- package/esm/typings/src/personas/preparePersona.d.ts +1 -0
- package/esm/typings/src/remote-server/openapi-types.d.ts +31 -31
- package/esm/typings/src/scrapers/markdown/MarkdownScraper.d.ts +1 -2
- package/esm/typings/src/types/ModelRequirements.d.ts +2 -4
- package/esm/typings/src/utils/color/utils/colorSaturation.d.ts +1 -1
- package/esm/typings/src/utils/editable/edit-pipeline-string/addPipelineCommand.d.ts +1 -1
- package/esm/typings/src/utils/markdown/humanizeAiText.d.ts +0 -1
- package/esm/typings/src/utils/markdown/promptbookifyAiText.d.ts +2 -2
- package/esm/typings/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +1 -1
- package/umd/index.umd.js.map +1 -1
- package/esm/typings/src/book-2.0/utils/extractAgentMetadata.d.ts +0 -17
- package/esm/typings/src/book-2.0/utils/extractProfileImageFromSystemMessage.d.ts +0 -12
- package/esm/typings/src/book-components/Chat/examples/ChatMarkdownDemo.d.ts +0 -16
- package/esm/typings/src/expectations/drafts/isDomainNameFree.d.ts +0 -10
- package/esm/typings/src/expectations/drafts/isGithubNameFree.d.ts +0 -10
- package/esm/typings/src/llm-providers/_common/profiles/llmProviderProfiles.d.ts +0 -81
- /package/esm/typings/src/llm-providers/_common/{profiles/test/llmProviderProfiles.test.d.ts → utils/removeUnsupportedModelRequirements.test.d.ts} +0 -0
@@ -1,36 +1,18 @@
|
|
1
|
+
import type { AvailableModel } from '../../execution/AvailableModel';
|
2
|
+
import { LlmExecutionTools } from '../../execution/LlmExecutionTools';
|
1
3
|
import type { string_model_name } from '../../types/typeAliases';
|
2
4
|
import type { AgentModelRequirements } from './AgentModelRequirements';
|
3
5
|
import type { string_book } from './string_book';
|
4
6
|
/**
|
5
7
|
* Creates model requirements for an agent based on its source
|
6
|
-
* Results are cached to improve performance for repeated calls with the same agentSource and modelName
|
7
8
|
*
|
8
9
|
* There are 2 similar functions:
|
9
10
|
* - `parseAgentSource` which is a lightweight parser for agent source, it parses basic information and its purpose is to be quick and synchronous. The commitments there are hardcoded.
|
10
|
-
* - `createAgentModelRequirements` which is an asynchronous function that creates model requirements it applies each commitment one by one and works
|
11
|
+
* - `createAgentModelRequirements` which is an asynchronous function that creates model requirements it applies each commitment one by one and works asynchronous.
|
11
12
|
*
|
12
13
|
* @public exported from `@promptbook/core`
|
13
14
|
*/
|
14
|
-
export declare function createAgentModelRequirements(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
|
15
|
-
/**
|
16
|
-
* Clears the cache for createAgentModelRequirements
|
17
|
-
* Useful when agent sources are updated and cached results should be invalidated
|
18
|
-
*
|
19
|
-
* @private
|
20
|
-
*/
|
21
|
-
export declare function clearAgentModelRequirementsCache(): void;
|
22
|
-
/**
|
23
|
-
* Removes cache entries for a specific agent source (all model variants)
|
24
|
-
* @param agentSource The agent source to remove from cache
|
25
|
-
* @private
|
26
|
-
*/
|
27
|
-
export declare function invalidateAgentModelRequirementsCache(agentSource: string_book): void;
|
28
|
-
/**
|
29
|
-
* Gets the current cache size (for debugging/monitoring)
|
30
|
-
*
|
31
|
-
* @private
|
32
|
-
*/
|
33
|
-
export declare function getAgentModelRequirementsCacheSize(): number;
|
15
|
+
export declare function createAgentModelRequirements(agentSource: string_book, modelName?: string_model_name, availableModels?: readonly AvailableModel[], llmTools?: LlmExecutionTools): Promise<AgentModelRequirements>;
|
34
16
|
/**
|
35
17
|
* Extracts MCP servers from agent source
|
36
18
|
*
|
package/esm/typings/src/book-2.0/agent-source/createAgentModelRequirementsWithCommitments.d.ts
CHANGED
@@ -6,31 +6,6 @@ import type { string_book } from './string_book';
|
|
6
6
|
* This function uses a reduce-like pattern where each commitment applies its changes
|
7
7
|
* to build the final requirements starting from a basic empty model
|
8
8
|
*
|
9
|
-
* @
|
9
|
+
* @public exported from `@promptbook/core`
|
10
10
|
*/
|
11
11
|
export declare function createAgentModelRequirementsWithCommitments(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
|
12
|
-
/**
|
13
|
-
* Cached version of createAgentModelRequirementsWithCommitments
|
14
|
-
* This maintains the same caching behavior as the original function
|
15
|
-
*
|
16
|
-
* @private
|
17
|
-
*/
|
18
|
-
export declare function createAgentModelRequirementsWithCommitmentsCached(agentSource: string_book, modelName?: string_model_name): Promise<AgentModelRequirements>;
|
19
|
-
/**
|
20
|
-
* Clears the cache for createAgentModelRequirementsWithCommitments
|
21
|
-
*
|
22
|
-
* @private
|
23
|
-
*/
|
24
|
-
export declare function clearAgentModelRequirementsWithCommitmentsCache(): void;
|
25
|
-
/**
|
26
|
-
* Removes cache entries for a specific agent source
|
27
|
-
*
|
28
|
-
* @private
|
29
|
-
*/
|
30
|
-
export declare function invalidateAgentModelRequirementsWithCommitmentsCache(agentSource: string_book): void;
|
31
|
-
/**
|
32
|
-
* Gets the current cache size
|
33
|
-
*
|
34
|
-
* @private
|
35
|
-
*/
|
36
|
-
export declare function getAgentModelRequirementsWithCommitmentsCacheSize(): number;
|
@@ -15,8 +15,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
15
15
|
*
|
16
16
|
* @private [🪔] Maybe export the commitments through some package
|
17
17
|
*/
|
18
|
-
export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION'> {
|
19
|
-
constructor();
|
18
|
+
export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition<'ACTION' | 'ACTIONS'> {
|
19
|
+
constructor(type?: 'ACTION' | 'ACTIONS');
|
20
20
|
/**
|
21
21
|
* Short one-line description of ACTION.
|
22
22
|
*/
|
@@ -27,12 +27,6 @@ export declare class ActionCommitmentDefinition extends BaseCommitmentDefinition
|
|
27
27
|
get documentation(): string;
|
28
28
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
29
29
|
}
|
30
|
-
/**
|
31
|
-
* Singleton instance of the ACTION commitment definition
|
32
|
-
*
|
33
|
-
* @private [🪔] Maybe export the commitments through some package
|
34
|
-
*/
|
35
|
-
export declare const ActionCommitment: ActionCommitmentDefinition;
|
36
30
|
/**
|
37
31
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
38
32
|
*/
|
@@ -30,30 +30,6 @@ export declare class DeleteCommitmentDefinition extends BaseCommitmentDefinition
|
|
30
30
|
get documentation(): string;
|
31
31
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
32
32
|
}
|
33
|
-
/**
|
34
|
-
* Singleton instances of the DELETE commitment definitions with aliases
|
35
|
-
*
|
36
|
-
* @private [🪔] Maybe export the commitments through some package
|
37
|
-
*/
|
38
|
-
export declare const DeleteCommitment: DeleteCommitmentDefinition;
|
39
|
-
/**
|
40
|
-
* Singleton instances of the DELETE commitment definitions with aliases
|
41
|
-
*
|
42
|
-
* @private [🪔] Maybe export the commitments through some package
|
43
|
-
*/
|
44
|
-
export declare const CancelCommitment: DeleteCommitmentDefinition;
|
45
|
-
/**
|
46
|
-
* Singleton instances of the DELETE commitment definitions with aliases
|
47
|
-
*
|
48
|
-
* @private [🪔] Maybe export the commitments through some package
|
49
|
-
*/
|
50
|
-
export declare const DiscardCommitment: DeleteCommitmentDefinition;
|
51
|
-
/**
|
52
|
-
* Singleton instances of the DELETE commitment definitions with aliases
|
53
|
-
*
|
54
|
-
* @private [🪔] Maybe export the commitments through some package
|
55
|
-
*/
|
56
|
-
export declare const RemoveCommitment: DeleteCommitmentDefinition;
|
57
33
|
/**
|
58
34
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
59
35
|
*/
|
@@ -16,8 +16,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
16
16
|
*
|
17
17
|
* @private [🪔] Maybe export the commitments through some package
|
18
18
|
*/
|
19
|
-
export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT'> {
|
20
|
-
constructor();
|
19
|
+
export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition<'FORMAT' | 'FORMATS'> {
|
20
|
+
constructor(type?: 'FORMAT' | 'FORMATS');
|
21
21
|
/**
|
22
22
|
* Short one-line description of FORMAT.
|
23
23
|
*/
|
@@ -28,12 +28,6 @@ export declare class FormatCommitmentDefinition extends BaseCommitmentDefinition
|
|
28
28
|
get documentation(): string;
|
29
29
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
30
30
|
}
|
31
|
-
/**
|
32
|
-
* Singleton instance of the FORMAT commitment definition
|
33
|
-
*
|
34
|
-
* @private [🪔] Maybe export the commitments through some package
|
35
|
-
*/
|
36
|
-
export declare const FormatCommitment: FormatCommitmentDefinition;
|
37
31
|
/**
|
38
32
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
39
33
|
*/
|
@@ -16,8 +16,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
16
16
|
*
|
17
17
|
* @private [🪔] Maybe export the commitments through some package
|
18
18
|
*/
|
19
|
-
export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'GOAL'> {
|
20
|
-
constructor();
|
19
|
+
export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'GOAL' | 'GOALS'> {
|
20
|
+
constructor(type?: 'GOAL' | 'GOALS');
|
21
21
|
/**
|
22
22
|
* Short one-line description of GOAL.
|
23
23
|
*/
|
@@ -28,12 +28,6 @@ export declare class GoalCommitmentDefinition extends BaseCommitmentDefinition<'
|
|
28
28
|
get documentation(): string;
|
29
29
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
30
30
|
}
|
31
|
-
/**
|
32
|
-
* Singleton instance of the GOAL commitment definition
|
33
|
-
*
|
34
|
-
* @private [🪔] Maybe export the commitments through some package
|
35
|
-
*/
|
36
|
-
export declare const GoalCommitment: GoalCommitmentDefinition;
|
37
31
|
/**
|
38
32
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
39
33
|
*/
|
@@ -34,12 +34,6 @@ export declare class KnowledgeCommitmentDefinition extends BaseCommitmentDefinit
|
|
34
34
|
*/
|
35
35
|
private isUrl;
|
36
36
|
}
|
37
|
-
/**
|
38
|
-
* Singleton instance of the KNOWLEDGE commitment definition
|
39
|
-
*
|
40
|
-
* @private [🪔] Maybe export the commitments through some package
|
41
|
-
*/
|
42
|
-
export declare const KnowledgeCommitment: KnowledgeCommitmentDefinition;
|
43
37
|
/**
|
44
38
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
45
39
|
*/
|
@@ -17,8 +17,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
17
17
|
*
|
18
18
|
* @private [🪔] Maybe export the commitments through some package
|
19
19
|
*/
|
20
|
-
export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY'> {
|
21
|
-
constructor();
|
20
|
+
export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
|
21
|
+
constructor(type?: 'MEMORY' | 'MEMORIES');
|
22
22
|
/**
|
23
23
|
* Short one-line description of MEMORY.
|
24
24
|
*/
|
@@ -29,12 +29,6 @@ export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition
|
|
29
29
|
get documentation(): string;
|
30
30
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
31
31
|
}
|
32
|
-
/**
|
33
|
-
* Singleton instance of the MEMORY commitment definition
|
34
|
-
*
|
35
|
-
* @private [🪔] Maybe export the commitments through some package
|
36
|
-
*/
|
37
|
-
export declare const MemoryCommitment: MemoryCommitmentDefinition;
|
38
32
|
/**
|
39
33
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
40
34
|
*/
|
@@ -18,8 +18,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
18
18
|
*
|
19
19
|
* @private [🪔] Maybe export the commitments through some package
|
20
20
|
*/
|
21
|
-
export declare class MessageCommitmentDefinition extends BaseCommitmentDefinition<'MESSAGE'> {
|
22
|
-
constructor();
|
21
|
+
export declare class MessageCommitmentDefinition extends BaseCommitmentDefinition<'MESSAGE' | 'MESSAGES'> {
|
22
|
+
constructor(type?: 'MESSAGE' | 'MESSAGES');
|
23
23
|
/**
|
24
24
|
* Short one-line description of MESSAGE.
|
25
25
|
*/
|
@@ -30,12 +30,6 @@ export declare class MessageCommitmentDefinition extends BaseCommitmentDefinitio
|
|
30
30
|
get documentation(): string;
|
31
31
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
32
32
|
}
|
33
|
-
/**
|
34
|
-
* Singleton instance of the MESSAGE commitment definition
|
35
|
-
*
|
36
|
-
* @private [🪔] Maybe export the commitments through some package
|
37
|
-
*/
|
38
|
-
export declare const MessageCommitment: MessageCommitmentDefinition;
|
39
33
|
/**
|
40
34
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
41
35
|
*/
|
@@ -51,12 +51,6 @@ export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`
|
|
51
51
|
*/
|
52
52
|
isKnownMetaType(metaType: string): boolean;
|
53
53
|
}
|
54
|
-
/**
|
55
|
-
* Singleton instance of the META commitment definition
|
56
|
-
*
|
57
|
-
* @private [🪔] Maybe export the commitments through some package
|
58
|
-
*/
|
59
|
-
export declare const MetaCommitment: MetaCommitmentDefinition;
|
60
54
|
/**
|
61
55
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
62
56
|
*/
|
@@ -33,12 +33,6 @@ export declare class MetaImageCommitmentDefinition extends BaseCommitmentDefinit
|
|
33
33
|
*/
|
34
34
|
extractProfileImageUrl(content: string): string | null;
|
35
35
|
}
|
36
|
-
/**
|
37
|
-
* Singleton instance of the META IMAGE commitment definition
|
38
|
-
*
|
39
|
-
* @private [🪔] Maybe export the commitments through some package
|
40
|
-
*/
|
41
|
-
export declare const MetaImageCommitment: MetaImageCommitmentDefinition;
|
42
36
|
/**
|
43
37
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
44
38
|
*/
|
@@ -45,12 +45,6 @@ export declare class MetaLinkCommitmentDefinition extends BaseCommitmentDefiniti
|
|
45
45
|
*/
|
46
46
|
isValidUrl(content: string): boolean;
|
47
47
|
}
|
48
|
-
/**
|
49
|
-
* Singleton instance of the META LINK commitment definition
|
50
|
-
*
|
51
|
-
* @private [🪔] Maybe export the commitments through some package
|
52
|
-
*/
|
53
|
-
export declare const MetaLinkCommitment: MetaLinkCommitmentDefinition;
|
54
48
|
/**
|
55
49
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
56
50
|
*/
|
@@ -4,20 +4,29 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
4
4
|
* MODEL commitment definition
|
5
5
|
*
|
6
6
|
* The MODEL commitment specifies which AI model to use and can also set
|
7
|
-
* model-specific parameters like temperature, topP, and
|
7
|
+
* model-specific parameters like temperature, topP, topK, and maxTokens.
|
8
8
|
*
|
9
|
-
*
|
9
|
+
* Supports multiple syntax variations:
|
10
10
|
*
|
11
|
+
* Single-line format:
|
11
12
|
* ```book
|
12
13
|
* MODEL gpt-4
|
13
14
|
* MODEL claude-3-opus temperature=0.3
|
14
15
|
* MODEL gpt-3.5-turbo temperature=0.8 topP=0.9
|
15
16
|
* ```
|
16
17
|
*
|
18
|
+
* Multi-line named parameter format:
|
19
|
+
* ```book
|
20
|
+
* MODEL NAME gpt-4
|
21
|
+
* MODEL TEMPERATURE 0.7
|
22
|
+
* MODEL TOP_P 0.9
|
23
|
+
* MODEL MAX_TOKENS 2048
|
24
|
+
* ```
|
25
|
+
*
|
17
26
|
* @private [🪔] Maybe export the commitments through some package
|
18
27
|
*/
|
19
|
-
export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL'> {
|
20
|
-
constructor();
|
28
|
+
export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<'MODEL' | 'MODELS'> {
|
29
|
+
constructor(type?: 'MODEL' | 'MODELS');
|
21
30
|
/**
|
22
31
|
* Short one-line description of MODEL.
|
23
32
|
*/
|
@@ -27,13 +36,19 @@ export declare class ModelCommitmentDefinition extends BaseCommitmentDefinition<
|
|
27
36
|
*/
|
28
37
|
get documentation(): string;
|
29
38
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
39
|
+
/**
|
40
|
+
* Check if the first part is a known named parameter
|
41
|
+
*/
|
42
|
+
private isNamedParameter;
|
43
|
+
/**
|
44
|
+
* Parse the new named parameter format: "MODEL TEMPERATURE 0.7"
|
45
|
+
*/
|
46
|
+
private parseNamedParameter;
|
47
|
+
/**
|
48
|
+
* Parse the legacy format: "MODEL gpt-4 temperature=0.3 topP=0.9"
|
49
|
+
*/
|
50
|
+
private parseLegacyFormat;
|
30
51
|
}
|
31
|
-
/**
|
32
|
-
* Singleton instance of the MODEL commitment definition
|
33
|
-
*
|
34
|
-
* @private [🪔] Maybe export the commitments through some package
|
35
|
-
*/
|
36
|
-
export declare const ModelCommitment: ModelCommitmentDefinition;
|
37
52
|
/**
|
38
53
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
39
54
|
*/
|
@@ -26,8 +26,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
26
26
|
*
|
27
27
|
* @private [🪔] Maybe export the commitments through some package
|
28
28
|
*/
|
29
|
-
export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE'> {
|
30
|
-
constructor();
|
29
|
+
export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'NOTE' | 'NOTES' | 'COMMENT' | 'NONCE'> {
|
30
|
+
constructor(type?: 'NOTE' | 'NOTES' | 'COMMENT' | 'NONCE');
|
31
31
|
/**
|
32
32
|
* Short one-line description of NOTE.
|
33
33
|
*/
|
@@ -38,12 +38,6 @@ export declare class NoteCommitmentDefinition extends BaseCommitmentDefinition<'
|
|
38
38
|
get documentation(): string;
|
39
39
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
40
40
|
}
|
41
|
-
/**
|
42
|
-
* Singleton instance of the NOTE commitment definition
|
43
|
-
*
|
44
|
-
* @private [🪔] Maybe export the commitments through some package
|
45
|
-
*/
|
46
|
-
export declare const NoteCommitment: NoteCommitmentDefinition;
|
47
41
|
/**
|
48
42
|
* [💞] Ignore a discrepancy between file name and entity name
|
49
43
|
*/
|
@@ -23,8 +23,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
23
23
|
*
|
24
24
|
* @private [🪔] Maybe export the commitments through some package
|
25
25
|
*/
|
26
|
-
export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA'> {
|
27
|
-
constructor();
|
26
|
+
export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinition<'PERSONA' | 'PERSONAE'> {
|
27
|
+
constructor(type?: 'PERSONA' | 'PERSONAE');
|
28
28
|
/**
|
29
29
|
* Short one-line description of PERSONA.
|
30
30
|
*/
|
@@ -35,12 +35,6 @@ export declare class PersonaCommitmentDefinition extends BaseCommitmentDefinitio
|
|
35
35
|
get documentation(): string;
|
36
36
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
37
37
|
}
|
38
|
-
/**
|
39
|
-
* Singleton instance of the PERSONA commitment definition
|
40
|
-
*
|
41
|
-
* @private [🪔] Maybe export the commitments through some package
|
42
|
-
*/
|
43
|
-
export declare const PersonaCommitment: PersonaCommitmentDefinition;
|
44
38
|
/**
|
45
39
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
46
40
|
*/
|
@@ -27,18 +27,6 @@ export declare class RuleCommitmentDefinition extends BaseCommitmentDefinition<'
|
|
27
27
|
get documentation(): string;
|
28
28
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
29
29
|
}
|
30
|
-
/**
|
31
|
-
* Singleton instances of the RULE commitment definitions
|
32
|
-
*
|
33
|
-
* @private [🪔] Maybe export the commitments through some package
|
34
|
-
*/
|
35
|
-
export declare const RuleCommitment: RuleCommitmentDefinition;
|
36
|
-
/**
|
37
|
-
* Singleton instances of the RULE commitment definitions
|
38
|
-
*
|
39
|
-
* @private [🪔] Maybe export the commitments through some package
|
40
|
-
*/
|
41
|
-
export declare const RulesCommitment: RuleCommitmentDefinition;
|
42
30
|
/**
|
43
31
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
44
32
|
*/
|
@@ -27,18 +27,6 @@ export declare class SampleCommitmentDefinition extends BaseCommitmentDefinition
|
|
27
27
|
get documentation(): string;
|
28
28
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
29
29
|
}
|
30
|
-
/**
|
31
|
-
* Singleton instances of the SAMPLE commitment definitions
|
32
|
-
*
|
33
|
-
* @private [🪔] Maybe export the commitments through some package
|
34
|
-
*/
|
35
|
-
export declare const SampleCommitment: SampleCommitmentDefinition;
|
36
|
-
/**
|
37
|
-
* Singleton instances of the SAMPLE commitment definitions
|
38
|
-
*
|
39
|
-
* @private [🪔] Maybe export the commitments through some package
|
40
|
-
*/
|
41
|
-
export declare const ExampleCommitment: SampleCommitmentDefinition;
|
42
30
|
/**
|
43
31
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
44
32
|
*/
|
@@ -17,8 +17,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
17
17
|
*
|
18
18
|
* @private [🪔] Maybe export the commitments through some package
|
19
19
|
*/
|
20
|
-
export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefinition<'SCENARIO'> {
|
21
|
-
constructor();
|
20
|
+
export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefinition<'SCENARIO' | 'SCENARIOS'> {
|
21
|
+
constructor(type?: 'SCENARIO' | 'SCENARIOS');
|
22
22
|
/**
|
23
23
|
* Short one-line description of SCENARIO.
|
24
24
|
*/
|
@@ -29,12 +29,6 @@ export declare class ScenarioCommitmentDefinition extends BaseCommitmentDefiniti
|
|
29
29
|
get documentation(): string;
|
30
30
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
31
31
|
}
|
32
|
-
/**
|
33
|
-
* Singleton instance of the SCENARIO commitment definition
|
34
|
-
*
|
35
|
-
* @private [🪔] Maybe export the commitments through some package
|
36
|
-
*/
|
37
|
-
export declare const ScenarioCommitment: ScenarioCommitmentDefinition;
|
38
32
|
/**
|
39
33
|
* Note: [💞] Ignore a discrepancy between file name and entity name
|
40
34
|
*/
|
@@ -15,8 +15,8 @@ import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
15
15
|
*
|
16
16
|
* @private [🪔] Maybe export the commitments through some package
|
17
17
|
*/
|
18
|
-
export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE'> {
|
19
|
-
constructor();
|
18
|
+
export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<'STYLE' | 'STYLES'> {
|
19
|
+
constructor(type?: 'STYLE' | 'STYLES');
|
20
20
|
/**
|
21
21
|
* Short one-line description of STYLE.
|
22
22
|
*/
|
@@ -27,12 +27,6 @@ export declare class StyleCommitmentDefinition extends BaseCommitmentDefinition<
|
|
27
27
|
get documentation(): string;
|
28
28
|
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
29
29
|
}
|
30
|
-
/**
|
31
|
-
* Singleton instance of the STYLE commitment definition
|
32
|
-
*
|
33
|
-
* @private [🪔] Maybe export the commitments through some package
|
34
|
-
*/
|
35
|
-
export declare const StyleCommitment: StyleCommitmentDefinition;
|
36
30
|
/**
|
37
31
|
* [💞] Ignore a discrepancy between file name and entity name
|
38
32
|
*/
|
@@ -15,5 +15,5 @@ export declare function createEmptyAgentModelRequirements(): AgentModelRequireme
|
|
15
15
|
*/
|
16
16
|
export declare function createBasicAgentModelRequirements(agentName: string | null): AgentModelRequirements;
|
17
17
|
/**
|
18
|
-
* TODO:
|
18
|
+
* TODO: [🐤] Deduplicate `AgentModelRequirements` and `ModelRequirements` model requirements
|
19
19
|
*/
|
@@ -23,7 +23,7 @@ import { NotYetImplementedCommitmentDefinition } from './_base/NotYetImplemented
|
|
23
23
|
*
|
24
24
|
* @private Use functions to access commitments instead of this array directly
|
25
25
|
*/
|
26
|
-
export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"
|
26
|
+
export declare const COMMITMENT_REGISTRY: readonly [PersonaCommitmentDefinition, PersonaCommitmentDefinition, KnowledgeCommitmentDefinition, MemoryCommitmentDefinition, MemoryCommitmentDefinition, StyleCommitmentDefinition, StyleCommitmentDefinition, RuleCommitmentDefinition, RuleCommitmentDefinition, SampleCommitmentDefinition, SampleCommitmentDefinition, FormatCommitmentDefinition, FormatCommitmentDefinition, ModelCommitmentDefinition, ModelCommitmentDefinition, ActionCommitmentDefinition, ActionCommitmentDefinition, MetaCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, NoteCommitmentDefinition, GoalCommitmentDefinition, GoalCommitmentDefinition, MessageCommitmentDefinition, MessageCommitmentDefinition, ScenarioCommitmentDefinition, ScenarioCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, DeleteCommitmentDefinition, NotYetImplementedCommitmentDefinition<"EXPECT">, NotYetImplementedCommitmentDefinition<"BEHAVIOUR">, NotYetImplementedCommitmentDefinition<"BEHAVIOURS">, NotYetImplementedCommitmentDefinition<"AVOID">, NotYetImplementedCommitmentDefinition<"AVOIDANCE">, NotYetImplementedCommitmentDefinition<"CONTEXT">];
|
27
27
|
/**
|
28
28
|
* Gets a commitment definition by its type
|
29
29
|
* @param type The commitment type to look up
|
@@ -8,3 +8,6 @@ import { string_agent_name, string_url_image } from '../../types/typeAliases';
|
|
8
8
|
* @public exported from `@promptbook/core`
|
9
9
|
*/
|
10
10
|
export declare function generatePlaceholderAgentProfileImageUrl(agentName?: string_agent_name): string_url_image;
|
11
|
+
/**
|
12
|
+
* TODO: [🤹] Figure out best placeholder image generator https://i.pravatar.cc/1000?u=568
|
13
|
+
*/
|
@@ -9,7 +9,7 @@ export type AvatarChipProps = {
|
|
9
9
|
/**
|
10
10
|
* Avatar to be shown
|
11
11
|
*/
|
12
|
-
readonly avatarBasicInformation: AgentBasicInformation
|
12
|
+
readonly avatarBasicInformation: Omit<AgentBasicInformation, 'parameters'>;
|
13
13
|
/**
|
14
14
|
* Whether this chip is a template avatar
|
15
15
|
*/
|
@@ -21,7 +21,7 @@ export type AvatarChipProps = {
|
|
21
21
|
/**
|
22
22
|
* Called when chip is clicked
|
23
23
|
*/
|
24
|
-
readonly onSelect?: (avatar: AgentBasicInformation) => void;
|
24
|
+
readonly onSelect?: (avatar: Omit<AgentBasicInformation, 'parameters'>) => void;
|
25
25
|
/**
|
26
26
|
* Whether this chip is selected
|
27
27
|
*/
|
@@ -33,3 +33,6 @@ export type AvatarChipProps = {
|
|
33
33
|
* @public exported from `@promptbook/components`
|
34
34
|
*/
|
35
35
|
export declare function AvatarChip(props: AvatarChipProps): import("react/jsx-runtime").JSX.Element;
|
36
|
+
/**
|
37
|
+
* TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
|
38
|
+
*/
|
@@ -21,3 +21,6 @@ export type AvatarProfileProps = {
|
|
21
21
|
* @public exported from `@promptbook/components`
|
22
22
|
*/
|
23
23
|
export declare function AvatarProfile(props: AvatarProfileProps): import("react/jsx-runtime").JSX.Element;
|
24
|
+
/**
|
25
|
+
* TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
|
26
|
+
*/
|
@@ -31,11 +31,28 @@ export type MockedChatDelayConfig = {
|
|
31
31
|
*
|
32
32
|
* @public exported from `@promptbook/components`
|
33
33
|
*/
|
34
|
-
export type MockedChatProps = ChatProps & {
|
34
|
+
export type MockedChatProps = Omit<ChatProps, 'onReset' | /*'onMessage' | */ 'onUseTemplate' | 'isVoiceRecognitionButtonShown'> & {
|
35
|
+
/**
|
36
|
+
* Whether the chat can be reset via the "New chat" button.
|
37
|
+
*
|
38
|
+
* When true (default), the reset button is shown and clicking it restarts the simulated flow.
|
39
|
+
* When false, the reset button is hidden (read-only simulation without manual restart).
|
40
|
+
*
|
41
|
+
* @default true
|
42
|
+
*/
|
43
|
+
isResettable?: boolean;
|
35
44
|
/**
|
36
45
|
* Optional delays configuration for emulating typing behavior
|
37
46
|
*/
|
38
47
|
delayConfig?: MockedChatDelayConfig;
|
48
|
+
/**
|
49
|
+
* When true, shows Pause/Resume control and allows pausing the simulated flow.
|
50
|
+
* Pausing finishes the currently typing message first (transitions via PAUSING state),
|
51
|
+
* then prevents new messages from starting until resumed.
|
52
|
+
*
|
53
|
+
* @default true
|
54
|
+
*/
|
55
|
+
isPausable?: boolean;
|
39
56
|
};
|
40
57
|
/**
|
41
58
|
* MockedChat component that shows the same chat as Chat but emulates ongoing discussion
|
@@ -41,6 +41,11 @@ export type BookEditorProps = {
|
|
41
41
|
* If true, disables border radius making the editor have sharp corners
|
42
42
|
*/
|
43
43
|
readonly isBorderRadiusDisabled?: boolean;
|
44
|
+
/**
|
45
|
+
* If true, shows the footer with book title and version information.
|
46
|
+
* By default, the footer is hidden.
|
47
|
+
*/
|
48
|
+
readonly isFooterShown?: boolean;
|
44
49
|
};
|
45
50
|
/**
|
46
51
|
* Renders a book editor
|
@@ -48,3 +53,6 @@ export type BookEditorProps = {
|
|
48
53
|
* @public exported from `@promptbook/components`
|
49
54
|
*/
|
50
55
|
export declare function BookEditor(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
|
56
|
+
/**
|
57
|
+
* TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
|
58
|
+
*/
|
@@ -1,18 +1,5 @@
|
|
1
|
-
import {
|
2
|
-
import type { string_book } from '../../book-2.0/agent-source/string_book';
|
1
|
+
import { BookEditorProps } from './BookEditor';
|
3
2
|
/**
|
4
3
|
* @private util of `<BookEditor />`
|
5
4
|
*/
|
6
|
-
export
|
7
|
-
className?: string;
|
8
|
-
fontClassName?: string;
|
9
|
-
value?: string_book;
|
10
|
-
onChange?(value: string_book): void;
|
11
|
-
onFileUpload?(file: File): Promisable<string>;
|
12
|
-
isVerbose?: boolean;
|
13
|
-
isBorderRadiusDisabled?: boolean;
|
14
|
-
};
|
15
|
-
/**
|
16
|
-
* @private util of `<BookEditor />`
|
17
|
-
*/
|
18
|
-
export declare function BookEditorInner(props: BookEditorInnerProps): import("react/jsx-runtime").JSX.Element;
|
5
|
+
export declare function BookEditorInner(props: BookEditorProps): import("react/jsx-runtime").JSX.Element;
|
@@ -66,6 +66,12 @@ export type ChatProps = {
|
|
66
66
|
* If not provided, the chat bar will not be rendered
|
67
67
|
*/
|
68
68
|
readonly children?: ReactNode;
|
69
|
+
/**
|
70
|
+
* Extra action buttons/elements rendered in the actions toolbar
|
71
|
+
* (next to reset / template buttons). Keeps consumers DRY when
|
72
|
+
* adding feature–specific controls (e.g. Pause / Resume in MockedChat).
|
73
|
+
*/
|
74
|
+
readonly extraActions?: ReactNode;
|
69
75
|
/**
|
70
76
|
* Optional CSS class name which will be added to root <div/> element
|
71
77
|
*/
|
@@ -140,3 +146,6 @@ export type ChatProps = {
|
|
140
146
|
url: string;
|
141
147
|
}): Promisable<void>;
|
142
148
|
};
|
149
|
+
/**
|
150
|
+
* TODO: [☁️] Export component prop types only to `@promptbook/components` (not `@promptbook/types`)
|
151
|
+
*/
|