@promptbook/javascript 0.114.0-3 → 0.114.0-5
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 +4 -12
- package/esm/index.es.js +1 -1
- package/esm/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
- package/esm/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
- package/esm/src/cli/cli-commands/coder/generate-boilerplates.d.ts +3 -2
- package/esm/src/cli/cli-commands/coder/verify.d.ts +1 -1
- package/esm/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
- package/esm/src/commitments/META_ID/META_ID.d.ts +32 -0
- package/esm/src/commitments/index.d.ts +4 -12
- package/esm/src/llm-providers/agent/Agent.d.ts +1 -1
- package/esm/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +1 -1
- package/esm/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
- package/esm/src/version.d.ts +1 -1
- package/package.json +2 -2
- package/umd/index.umd.js +1 -1
- package/umd/src/book-2.0/agent-source/AgentBasicInformation.d.ts +3 -3
- package/umd/src/cli/cli-commands/coder/boilerplateCount.d.ts +52 -0
- package/umd/src/cli/cli-commands/coder/generate-boilerplates.d.ts +3 -2
- package/umd/src/cli/cli-commands/coder/verify.d.ts +1 -1
- package/umd/src/commitments/{COMPONENT/COMPONENT.d.ts → META_FULLNAME/META_FULLNAME.d.ts} +8 -5
- package/umd/src/commitments/META_ID/META_ID.d.ts +32 -0
- package/umd/src/commitments/index.d.ts +4 -12
- package/umd/src/llm-providers/agent/Agent.d.ts +1 -1
- package/umd/src/llm-providers/openai/OpenAiAgentKitExecutionToolsToolBuilder.d.ts +1 -1
- package/umd/src/{commitments/USE_BROWSER → scrapers/_common/utils}/fetchUrlContent.d.ts +2 -3
- package/umd/src/version.d.ts +1 -1
- package/esm/src/commitments/MEMORY/MEMORY.d.ts +0 -48
- package/esm/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
- package/esm/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
- package/esm/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
- package/esm/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
- package/esm/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
- package/esm/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
- package/esm/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/esm/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
- package/esm/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
- package/esm/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
- package/esm/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
- package/esm/src/commitments/META/META.d.ts +0 -65
- package/esm/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
- package/esm/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
- package/esm/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
- package/esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
- package/esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
- package/esm/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
- package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
- package/esm/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts +0 -1
- package/esm/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
- package/esm/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
- package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
- package/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts +0 -1
- package/esm/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
- package/esm/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts +0 -1
- package/esm/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
- package/esm/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
- package/esm/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
- package/esm/src/commitments/USE_TIME/USE_TIME.test.d.ts +0 -1
- package/esm/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
- package/esm/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
- package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
- package/esm/src/commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts +0 -1
- package/esm/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
- package/esm/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
- package/esm/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
- package/esm/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/esm/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
- package/esm/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
- package/esm/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
- package/esm/src/commitments/WALLET/WALLET.d.ts +0 -21
- package/esm/src/commitments/WALLET/WALLET.test.d.ts +0 -1
- package/esm/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
- package/esm/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
- package/esm/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
- package/esm/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
- package/esm/src/commitments/WALLET/createWalletTools.d.ts +0 -7
- package/esm/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
- package/esm/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
- package/esm/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
- package/esm/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
- package/esm/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
- package/esm/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
- package/esm/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
- package/umd/src/book-2.0/agent-source/createAgentModelRequirements.useCommitmentAggregation.test.d.ts +0 -1
- package/umd/src/commitments/MEMORY/MEMORY.d.ts +0 -48
- package/umd/src/commitments/MEMORY/MEMORY.test.d.ts +0 -1
- package/umd/src/commitments/MEMORY/MemoryToolNames.d.ts +0 -11
- package/umd/src/commitments/MEMORY/MemoryToolRuntimeAdapter.d.ts +0 -149
- package/umd/src/commitments/MEMORY/createMemorySystemMessage.d.ts +0 -6
- package/umd/src/commitments/MEMORY/createMemoryToolFunctions.d.ts +0 -8
- package/umd/src/commitments/MEMORY/createMemoryTools.d.ts +0 -14
- package/umd/src/commitments/MEMORY/getMemoryCommitmentDocumentation.d.ts +0 -6
- package/umd/src/commitments/MEMORY/getMemoryToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/umd/src/commitments/MEMORY/getMemoryToolTitles.d.ts +0 -7
- package/umd/src/commitments/MEMORY/parseMemoryToolArgs.d.ts +0 -61
- package/umd/src/commitments/MEMORY/resolveMemoryRuntimeContext.d.ts +0 -8
- package/umd/src/commitments/MEMORY/setMemoryToolRuntimeAdapter.d.ts +0 -13
- package/umd/src/commitments/META/META.d.ts +0 -65
- package/umd/src/commitments/USE/aggregateUseCommitmentSystemMessages.d.ts +0 -32
- package/umd/src/commitments/USE_BROWSER/USE_BROWSER.d.ts +0 -58
- package/umd/src/commitments/USE_BROWSER/USE_BROWSER.test.d.ts +0 -1
- package/umd/src/commitments/USE_BROWSER/fetchUrlContentViaBrowser.d.ts +0 -13
- package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.d.ts +0 -10
- package/umd/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts +0 -1
- package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts +0 -47
- package/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts +0 -1
- package/umd/src/commitments/USE_EMAIL/USE_EMAIL.d.ts +0 -38
- package/umd/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts +0 -1
- package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.d.ts +0 -21
- package/umd/src/commitments/USE_EMAIL/parseUseEmailCommitmentContent.test.d.ts +0 -1
- package/umd/src/commitments/USE_EMAIL/resolveSendEmailToolForNode.d.ts +0 -11
- package/umd/src/commitments/USE_EMAIL/sendEmailViaBrowser.d.ts +0 -13
- package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.d.ts +0 -46
- package/umd/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.test.d.ts +0 -1
- package/umd/src/commitments/USE_SPAWN/USE_SPAWN.d.ts +0 -38
- package/umd/src/commitments/USE_SPAWN/USE_SPAWN.test.d.ts +0 -1
- package/umd/src/commitments/USE_SPAWN/resolveSpawnAgentToolForNode.d.ts +0 -9
- package/umd/src/commitments/USE_SPAWN/spawnAgentViaBrowser.d.ts +0 -12
- package/umd/src/commitments/USE_TIME/USE_TIME.d.ts +0 -43
- package/umd/src/commitments/USE_TIME/USE_TIME.test.d.ts +0 -1
- package/umd/src/commitments/USE_TIMEOUT/TimeoutToolNames.d.ts +0 -11
- package/umd/src/commitments/USE_TIMEOUT/TimeoutToolRuntimeAdapter.d.ts +0 -212
- package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.d.ts +0 -38
- package/umd/src/commitments/USE_TIMEOUT/USE_TIMEOUT.test.d.ts +0 -1
- package/umd/src/commitments/USE_TIMEOUT/createTimeoutSystemMessage.d.ts +0 -6
- package/umd/src/commitments/USE_TIMEOUT/createTimeoutToolFunctions.d.ts +0 -8
- package/umd/src/commitments/USE_TIMEOUT/createTimeoutTools.d.ts +0 -7
- package/umd/src/commitments/USE_TIMEOUT/getTimeoutToolRuntimeAdapterOrDisabledResult.d.ts +0 -17
- package/umd/src/commitments/USE_TIMEOUT/parseTimeoutToolArgs.d.ts +0 -78
- package/umd/src/commitments/USE_TIMEOUT/resolveTimeoutRuntimeContext.d.ts +0 -8
- package/umd/src/commitments/USE_TIMEOUT/setTimeoutToolRuntimeAdapter.d.ts +0 -13
- package/umd/src/commitments/WALLET/WALLET.d.ts +0 -21
- package/umd/src/commitments/WALLET/WALLET.test.d.ts +0 -1
- package/umd/src/commitments/WALLET/WalletToolNames.d.ts +0 -12
- package/umd/src/commitments/WALLET/WalletToolRuntimeAdapter.d.ts +0 -163
- package/umd/src/commitments/WALLET/createWalletSystemMessage.d.ts +0 -6
- package/umd/src/commitments/WALLET/createWalletToolFunctions.d.ts +0 -8
- package/umd/src/commitments/WALLET/createWalletTools.d.ts +0 -7
- package/umd/src/commitments/WALLET/getWalletCommitmentDocumentation.d.ts +0 -6
- package/umd/src/commitments/WALLET/getWalletToolRuntimeAdapterOrDisabledResult.d.ts +0 -16
- package/umd/src/commitments/WALLET/getWalletToolTitles.d.ts +0 -7
- package/umd/src/commitments/WALLET/parseWalletToolArgs.d.ts +0 -51
- package/umd/src/commitments/WALLET/resolveWalletRuntimeContext.d.ts +0 -8
- package/umd/src/commitments/WALLET/setWalletToolRuntimeAdapter.d.ts +0 -13
- package/umd/src/commitments/_common/createSerpSearchToolFunction.d.ts +0 -12
- /package/esm/src/book-2.0/agent-source/{createAgentModelRequirements.useCommitmentAggregation.test.d.ts → createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
- /package/esm/src/{commitments/MEMORY/MEMORY.test.d.ts → cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
- /package/esm/src/{commitments/USE_BROWSER/USE_BROWSER.test.d.ts → cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
- /package/esm/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
- /package/{esm/src/commitments/USE_BROWSER/resolveRunBrowserToolForNode.test.d.ts → umd/src/book-2.0/agent-source/createAgentModelRequirements.commitmentAggregation.test.d.ts} +0 -0
- /package/{esm/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.test.d.ts → umd/src/cli/cli-commands/coder/boilerplateCount.test.d.ts} +0 -0
- /package/{esm/src/commitments/USE_EMAIL/USE_EMAIL.test.d.ts → umd/src/cli/cli-commands/coder/generate-boilerplates.test.d.ts} +0 -0
- /package/umd/src/commitments/{META → META_DESCRIPTION}/META_DESCRIPTION.d.ts +0 -0
|
@@ -45,7 +45,7 @@ export declare class Agent extends AgentLlmExecutionTools implements LlmExecutio
|
|
|
45
45
|
links: Array<string_agent_url>;
|
|
46
46
|
/**
|
|
47
47
|
* Capabilities of the agent
|
|
48
|
-
* This is parsed from commitments like USE
|
|
48
|
+
* This is parsed from commitments like USE CALENDAR, USE PROJECT, KNOWLEDGE, etc.
|
|
49
49
|
*/
|
|
50
50
|
capabilities: Array<AgentCapability>;
|
|
51
51
|
/**
|
|
@@ -73,7 +73,7 @@ export declare class OpenAiAgentKitExecutionToolsToolBuilder {
|
|
|
73
73
|
*/
|
|
74
74
|
private normalizeAgentKitToolParameters;
|
|
75
75
|
/**
|
|
76
|
-
* Creates the native Agent SDK tool used for
|
|
76
|
+
* Creates the native Agent SDK tool used for the DeepSearch capability.
|
|
77
77
|
*/
|
|
78
78
|
private createDeepSearchAgentKitTool;
|
|
79
79
|
/**
|
|
@@ -8,12 +8,11 @@
|
|
|
8
8
|
* 4. Returns the scraped markdown content
|
|
9
9
|
*
|
|
10
10
|
* WARNING: This function should NOT be used directly in browser environments.
|
|
11
|
-
* For browser environments,
|
|
12
|
-
* the Agents Server API endpoint at /api/scrape
|
|
11
|
+
* For browser environments, proxy the request through the Agents Server API endpoint at /api/scrape
|
|
13
12
|
*
|
|
14
13
|
* @param url The URL to fetch and scrape
|
|
15
14
|
* @returns Markdown content from the URL
|
|
16
15
|
*
|
|
17
|
-
* @private internal utility
|
|
16
|
+
* @private internal scraping utility
|
|
18
17
|
*/
|
|
19
18
|
export declare function fetchUrlContent(url: string): Promise<string>;
|
package/umd/src/version.d.ts
CHANGED
|
@@ -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.114.0-
|
|
18
|
+
* It follows semantic versioning (e.g., `0.114.0-4`).
|
|
19
19
|
*
|
|
20
20
|
* @generated
|
|
21
21
|
*/
|
|
@@ -1,48 +0,0 @@
|
|
|
1
|
-
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
|
|
2
|
-
import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
|
|
3
|
-
import type { string_javascript_name } from '../../types/string_person_fullname';
|
|
4
|
-
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
5
|
-
export type { MemoryToolRecord, MemoryToolRuntimeAdapter, MemoryToolRuntimeContext } from './MemoryToolRuntimeAdapter';
|
|
6
|
-
export { setMemoryToolRuntimeAdapter } from './setMemoryToolRuntimeAdapter';
|
|
7
|
-
/**
|
|
8
|
-
* MEMORY commitment definition
|
|
9
|
-
*
|
|
10
|
-
* The MEMORY commitment is similar to KNOWLEDGE but has a focus on remembering past
|
|
11
|
-
* interactions and user preferences. It helps the agent maintain context about the
|
|
12
|
-
* user's history, preferences, and previous conversations.
|
|
13
|
-
*
|
|
14
|
-
* Example usage in agent source:
|
|
15
|
-
*
|
|
16
|
-
* ```book
|
|
17
|
-
* MEMORY User prefers detailed technical explanations
|
|
18
|
-
* MEMORY Previously worked on React projects
|
|
19
|
-
* MEMORY Timezone: UTC-5 (Eastern Time)
|
|
20
|
-
* ```
|
|
21
|
-
*
|
|
22
|
-
* @private [🪔] Maybe export the commitments through some package
|
|
23
|
-
*/
|
|
24
|
-
export declare class MemoryCommitmentDefinition extends BaseCommitmentDefinition<'MEMORY' | 'MEMORIES'> {
|
|
25
|
-
constructor(type?: 'MEMORY' | 'MEMORIES');
|
|
26
|
-
get requiresContent(): boolean;
|
|
27
|
-
/**
|
|
28
|
-
* Short one-line description of MEMORY.
|
|
29
|
-
*/
|
|
30
|
-
get description(): string;
|
|
31
|
-
/**
|
|
32
|
-
* Icon for this commitment.
|
|
33
|
-
*/
|
|
34
|
-
get icon(): string;
|
|
35
|
-
/**
|
|
36
|
-
* Markdown documentation for MEMORY commitment.
|
|
37
|
-
*/
|
|
38
|
-
get documentation(): string;
|
|
39
|
-
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
|
40
|
-
/**
|
|
41
|
-
* Gets human-readable titles for MEMORY tool functions.
|
|
42
|
-
*/
|
|
43
|
-
getToolTitles(): Record<string_javascript_name, string>;
|
|
44
|
-
/**
|
|
45
|
-
* Gets MEMORY tool function implementations.
|
|
46
|
-
*/
|
|
47
|
-
getToolFunctions(): Record<string_javascript_name, ToolFunction>;
|
|
48
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Names of tools used by the MEMORY commitment.
|
|
3
|
-
*
|
|
4
|
-
* @private function of MemoryCommitmentDefinition
|
|
5
|
-
*/
|
|
6
|
-
export declare const MemoryToolNames: {
|
|
7
|
-
readonly retrieve: string;
|
|
8
|
-
readonly store: string;
|
|
9
|
-
readonly update: string;
|
|
10
|
-
readonly delete: string;
|
|
11
|
-
};
|
|
@@ -1,149 +0,0 @@
|
|
|
1
|
-
import type { TODO_any } from '../../utils/organization/TODO_any';
|
|
2
|
-
/**
|
|
3
|
-
* Tool arguments for retrieving memory.
|
|
4
|
-
*
|
|
5
|
-
* @private type of MemoryCommitmentDefinition
|
|
6
|
-
*/
|
|
7
|
-
export type RetrieveMemoryToolArgs = {
|
|
8
|
-
query?: string;
|
|
9
|
-
limit?: number;
|
|
10
|
-
[key: string]: TODO_any;
|
|
11
|
-
};
|
|
12
|
-
/**
|
|
13
|
-
* Tool arguments for storing memory.
|
|
14
|
-
*
|
|
15
|
-
* @private type of MemoryCommitmentDefinition
|
|
16
|
-
*/
|
|
17
|
-
export type StoreMemoryToolArgs = {
|
|
18
|
-
content?: string;
|
|
19
|
-
isGlobal?: boolean;
|
|
20
|
-
[key: string]: TODO_any;
|
|
21
|
-
};
|
|
22
|
-
/**
|
|
23
|
-
* Tool arguments for updating memory.
|
|
24
|
-
*
|
|
25
|
-
* @private type of MemoryCommitmentDefinition
|
|
26
|
-
*/
|
|
27
|
-
export type UpdateMemoryToolArgs = {
|
|
28
|
-
memoryId?: string;
|
|
29
|
-
content?: string;
|
|
30
|
-
isGlobal?: boolean;
|
|
31
|
-
[key: string]: TODO_any;
|
|
32
|
-
};
|
|
33
|
-
/**
|
|
34
|
-
* Tool arguments for deleting memory.
|
|
35
|
-
*
|
|
36
|
-
* @private type of MemoryCommitmentDefinition
|
|
37
|
-
*/
|
|
38
|
-
export type DeleteMemoryToolArgs = {
|
|
39
|
-
memoryId?: string;
|
|
40
|
-
[key: string]: TODO_any;
|
|
41
|
-
};
|
|
42
|
-
/**
|
|
43
|
-
* Memory record returned by runtime adapters.
|
|
44
|
-
*
|
|
45
|
-
* @private type of MemoryCommitmentDefinition
|
|
46
|
-
*/
|
|
47
|
-
export type MemoryToolRecord = {
|
|
48
|
-
id?: string;
|
|
49
|
-
content: string;
|
|
50
|
-
isGlobal: boolean;
|
|
51
|
-
createdAt?: string;
|
|
52
|
-
updatedAt?: string;
|
|
53
|
-
};
|
|
54
|
-
/**
|
|
55
|
-
* Runtime context for MEMORY tools resolved from hidden tool arguments.
|
|
56
|
-
*
|
|
57
|
-
* @private type of MemoryCommitmentDefinition
|
|
58
|
-
*/
|
|
59
|
-
export type MemoryToolRuntimeContext = {
|
|
60
|
-
readonly enabled: boolean;
|
|
61
|
-
readonly userId?: number;
|
|
62
|
-
readonly username?: string;
|
|
63
|
-
readonly agentId?: string;
|
|
64
|
-
readonly agentName?: string;
|
|
65
|
-
readonly isTeamConversation: boolean;
|
|
66
|
-
readonly isPrivateMode: boolean;
|
|
67
|
-
};
|
|
68
|
-
/**
|
|
69
|
-
* Result payload returned by retrieve memory tool.
|
|
70
|
-
*
|
|
71
|
-
* @private type of MemoryCommitmentDefinition
|
|
72
|
-
*/
|
|
73
|
-
export type RetrieveMemoryToolResult = {
|
|
74
|
-
action: 'retrieve';
|
|
75
|
-
status: 'ok' | 'disabled' | 'error';
|
|
76
|
-
query?: string;
|
|
77
|
-
memories: MemoryToolRecord[];
|
|
78
|
-
message?: string;
|
|
79
|
-
};
|
|
80
|
-
/**
|
|
81
|
-
* Result payload returned by store memory tool.
|
|
82
|
-
*
|
|
83
|
-
* @private type of MemoryCommitmentDefinition
|
|
84
|
-
*/
|
|
85
|
-
export type StoreMemoryToolResult = {
|
|
86
|
-
action: 'store';
|
|
87
|
-
status: 'stored' | 'disabled' | 'error';
|
|
88
|
-
memory?: MemoryToolRecord;
|
|
89
|
-
message?: string;
|
|
90
|
-
};
|
|
91
|
-
/**
|
|
92
|
-
* Result payload returned by update memory tool.
|
|
93
|
-
*
|
|
94
|
-
* @private type of MemoryCommitmentDefinition
|
|
95
|
-
*/
|
|
96
|
-
export type UpdateMemoryToolResult = {
|
|
97
|
-
action: 'update';
|
|
98
|
-
status: 'updated' | 'disabled' | 'error';
|
|
99
|
-
memory?: MemoryToolRecord;
|
|
100
|
-
message?: string;
|
|
101
|
-
};
|
|
102
|
-
/**
|
|
103
|
-
* Result payload returned by delete memory tool.
|
|
104
|
-
*
|
|
105
|
-
* @private type of MemoryCommitmentDefinition
|
|
106
|
-
*/
|
|
107
|
-
export type DeleteMemoryToolResult = {
|
|
108
|
-
action: 'delete';
|
|
109
|
-
status: 'deleted' | 'disabled' | 'error';
|
|
110
|
-
memoryId?: string;
|
|
111
|
-
message?: string;
|
|
112
|
-
};
|
|
113
|
-
/**
|
|
114
|
-
* Union of all MEMORY tool actions.
|
|
115
|
-
*
|
|
116
|
-
* @private type of MemoryCommitmentDefinition
|
|
117
|
-
*/
|
|
118
|
-
export type MemoryToolAction = RetrieveMemoryToolResult['action'] | StoreMemoryToolResult['action'] | UpdateMemoryToolResult['action'] | DeleteMemoryToolResult['action'];
|
|
119
|
-
/**
|
|
120
|
-
* Union of all MEMORY tool result payloads.
|
|
121
|
-
*
|
|
122
|
-
* @private type of MemoryCommitmentDefinition
|
|
123
|
-
*/
|
|
124
|
-
export type MemoryToolResult = RetrieveMemoryToolResult | StoreMemoryToolResult | UpdateMemoryToolResult | DeleteMemoryToolResult;
|
|
125
|
-
/**
|
|
126
|
-
* Runtime adapter interface used by MEMORY tools.
|
|
127
|
-
*
|
|
128
|
-
* @private type of MemoryCommitmentDefinition
|
|
129
|
-
*/
|
|
130
|
-
export type MemoryToolRuntimeAdapter = {
|
|
131
|
-
retrieveMemories(args: {
|
|
132
|
-
query?: string;
|
|
133
|
-
limit?: number;
|
|
134
|
-
}, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord[]>;
|
|
135
|
-
storeMemory(args: {
|
|
136
|
-
content: string;
|
|
137
|
-
isGlobal: boolean;
|
|
138
|
-
}, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord>;
|
|
139
|
-
updateMemory(args: {
|
|
140
|
-
memoryId: string;
|
|
141
|
-
content: string;
|
|
142
|
-
isGlobal?: boolean;
|
|
143
|
-
}, runtimeContext: MemoryToolRuntimeContext): Promise<MemoryToolRecord>;
|
|
144
|
-
deleteMemory(args: {
|
|
145
|
-
memoryId: string;
|
|
146
|
-
}, runtimeContext: MemoryToolRuntimeContext): Promise<{
|
|
147
|
-
id?: string;
|
|
148
|
-
}>;
|
|
149
|
-
};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
|
|
2
|
-
import type { string_javascript_name } from '../../types/string_person_fullname';
|
|
3
|
-
/**
|
|
4
|
-
* Gets MEMORY tool function implementations.
|
|
5
|
-
*
|
|
6
|
-
* @private function of MemoryCommitmentDefinition
|
|
7
|
-
*/
|
|
8
|
-
export declare function createMemoryToolFunctions(): Record<string_javascript_name, ToolFunction>;
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
|
|
2
|
-
/**
|
|
3
|
-
* Concrete type of tool definitions in `AgentModelRequirements`.
|
|
4
|
-
*
|
|
5
|
-
* @private type of MemoryCommitmentDefinition
|
|
6
|
-
*/
|
|
7
|
-
type AgentModelTools = NonNullable<AgentModelRequirements['tools']>;
|
|
8
|
-
/**
|
|
9
|
-
* Creates MEMORY tool definitions while preserving already-registered tools.
|
|
10
|
-
*
|
|
11
|
-
* @private function of MemoryCommitmentDefinition
|
|
12
|
-
*/
|
|
13
|
-
export declare function createMemoryTools(existingTools: AgentModelRequirements['tools']): AgentModelTools;
|
|
14
|
-
export {};
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
import type { DeleteMemoryToolResult, MemoryToolAction, MemoryToolRuntimeAdapter, MemoryToolRuntimeContext, RetrieveMemoryToolResult, StoreMemoryToolResult, UpdateMemoryToolResult } from './MemoryToolRuntimeAdapter';
|
|
2
|
-
/**
|
|
3
|
-
* Return type of MEMORY adapter resolution helper.
|
|
4
|
-
*
|
|
5
|
-
* @private type of MemoryCommitmentDefinition
|
|
6
|
-
*/
|
|
7
|
-
type MemoryToolRuntimeAdapterResolution = {
|
|
8
|
-
adapter: MemoryToolRuntimeAdapter | null;
|
|
9
|
-
disabledResult: RetrieveMemoryToolResult | StoreMemoryToolResult | UpdateMemoryToolResult | DeleteMemoryToolResult | null;
|
|
10
|
-
};
|
|
11
|
-
/**
|
|
12
|
-
* Gets the runtime adapter and returns a disabled result when unavailable.
|
|
13
|
-
*
|
|
14
|
-
* @private function of MemoryCommitmentDefinition
|
|
15
|
-
*/
|
|
16
|
-
export declare function getMemoryToolRuntimeAdapterOrDisabledResult(action: MemoryToolAction, runtimeContext: MemoryToolRuntimeContext): MemoryToolRuntimeAdapterResolution;
|
|
17
|
-
export {};
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
import type { string_javascript_name } from '../../types/string_person_fullname';
|
|
2
|
-
/**
|
|
3
|
-
* Gets human-readable titles for MEMORY tool functions.
|
|
4
|
-
*
|
|
5
|
-
* @private function of MemoryCommitmentDefinition
|
|
6
|
-
*/
|
|
7
|
-
export declare function getMemoryToolTitles(): Record<string_javascript_name, string>;
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
import type { DeleteMemoryToolArgs, RetrieveMemoryToolArgs, StoreMemoryToolArgs, UpdateMemoryToolArgs } from './MemoryToolRuntimeAdapter';
|
|
2
|
-
/**
|
|
3
|
-
* Parsed retrieve memory arguments.
|
|
4
|
-
*
|
|
5
|
-
* @private type of MemoryCommitmentDefinition
|
|
6
|
-
*/
|
|
7
|
-
type ParsedRetrieveMemoryArgs = {
|
|
8
|
-
query?: string;
|
|
9
|
-
limit?: number;
|
|
10
|
-
};
|
|
11
|
-
/**
|
|
12
|
-
* Parsed store memory arguments.
|
|
13
|
-
*
|
|
14
|
-
* @private type of MemoryCommitmentDefinition
|
|
15
|
-
*/
|
|
16
|
-
type ParsedStoreMemoryArgs = {
|
|
17
|
-
content: string;
|
|
18
|
-
isGlobal: boolean;
|
|
19
|
-
};
|
|
20
|
-
/**
|
|
21
|
-
* Parsed update memory arguments.
|
|
22
|
-
*
|
|
23
|
-
* @private type of MemoryCommitmentDefinition
|
|
24
|
-
*/
|
|
25
|
-
type ParsedUpdateMemoryArgs = {
|
|
26
|
-
memoryId: string;
|
|
27
|
-
content: string;
|
|
28
|
-
isGlobal?: boolean;
|
|
29
|
-
};
|
|
30
|
-
/**
|
|
31
|
-
* Parsed delete memory arguments.
|
|
32
|
-
*
|
|
33
|
-
* @private type of MemoryCommitmentDefinition
|
|
34
|
-
*/
|
|
35
|
-
type ParsedDeleteMemoryArgs = {
|
|
36
|
-
memoryId: string;
|
|
37
|
-
};
|
|
38
|
-
/**
|
|
39
|
-
* Collection of MEMORY tool argument parsers.
|
|
40
|
-
*
|
|
41
|
-
* @private function of MemoryCommitmentDefinition
|
|
42
|
-
*/
|
|
43
|
-
export declare const parseMemoryToolArgs: {
|
|
44
|
-
/**
|
|
45
|
-
* Parses retrieve memory arguments.
|
|
46
|
-
*/
|
|
47
|
-
retrieve(args: RetrieveMemoryToolArgs): ParsedRetrieveMemoryArgs;
|
|
48
|
-
/**
|
|
49
|
-
* Parses store memory arguments.
|
|
50
|
-
*/
|
|
51
|
-
store(args: StoreMemoryToolArgs): ParsedStoreMemoryArgs;
|
|
52
|
-
/**
|
|
53
|
-
* Parses update memory arguments.
|
|
54
|
-
*/
|
|
55
|
-
update(args: UpdateMemoryToolArgs): ParsedUpdateMemoryArgs;
|
|
56
|
-
/**
|
|
57
|
-
* Parses delete memory arguments.
|
|
58
|
-
*/
|
|
59
|
-
delete(args: DeleteMemoryToolArgs): ParsedDeleteMemoryArgs;
|
|
60
|
-
};
|
|
61
|
-
export {};
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
import type { TODO_any } from '../../utils/organization/TODO_any';
|
|
2
|
-
import type { MemoryToolRuntimeContext } from './MemoryToolRuntimeAdapter';
|
|
3
|
-
/**
|
|
4
|
-
* Resolves runtime context from hidden tool arguments.
|
|
5
|
-
*
|
|
6
|
-
* @private function of MemoryCommitmentDefinition
|
|
7
|
-
*/
|
|
8
|
-
export declare function resolveMemoryRuntimeContext(args: Record<string, TODO_any>): MemoryToolRuntimeContext;
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
import type { MemoryToolRuntimeAdapter } from './MemoryToolRuntimeAdapter';
|
|
2
|
-
/**
|
|
3
|
-
* Sets runtime adapter used by MEMORY commitment tools.
|
|
4
|
-
*
|
|
5
|
-
* @private function of MemoryCommitmentDefinition
|
|
6
|
-
*/
|
|
7
|
-
export declare function setMemoryToolRuntimeAdapter(adapter: MemoryToolRuntimeAdapter | null): void;
|
|
8
|
-
/**
|
|
9
|
-
* Gets runtime adapter used by MEMORY commitment tools.
|
|
10
|
-
*
|
|
11
|
-
* @private function of MemoryCommitmentDefinition
|
|
12
|
-
*/
|
|
13
|
-
export declare function getMemoryToolRuntimeAdapter(): MemoryToolRuntimeAdapter | null;
|
|
@@ -1,65 +0,0 @@
|
|
|
1
|
-
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
|
|
2
|
-
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
3
|
-
/**
|
|
4
|
-
* META commitment definition
|
|
5
|
-
*
|
|
6
|
-
* The META commitment handles all meta-information about the agent such as:
|
|
7
|
-
* - META AVATAR / META VISUAL: Sets the agent's built-in default avatar visual
|
|
8
|
-
* - META IMAGE: Sets the agent's avatar/profile image URL
|
|
9
|
-
* - META LINK: Provides profile/source links for the person the agent models
|
|
10
|
-
* - META DOMAIN: Sets the canonical custom domain/host of the agent
|
|
11
|
-
* - META TITLE: Sets the agent's display title
|
|
12
|
-
* - META DESCRIPTION: Sets the agent's description
|
|
13
|
-
* - META INPUT PLACEHOLDER: Sets chat input placeholder text
|
|
14
|
-
* - META THINKING MESSAGE: Adds custom thinking placeholder variants
|
|
15
|
-
* - META [ANYTHING]: Any other meta information in uppercase format
|
|
16
|
-
*
|
|
17
|
-
* These commitments are special because they don't affect the system message,
|
|
18
|
-
* but are handled separately in the parsing logic for profile display.
|
|
19
|
-
*
|
|
20
|
-
* Example usage in agent source:
|
|
21
|
-
*
|
|
22
|
-
* ```book
|
|
23
|
-
* META VISUAL pixel-art
|
|
24
|
-
* META IMAGE https://example.com/avatar.jpg
|
|
25
|
-
* META LINK https://twitter.com/username
|
|
26
|
-
* META DOMAIN my-agent.com
|
|
27
|
-
* META TITLE Professional Assistant
|
|
28
|
-
* META DESCRIPTION An AI assistant specialized in business tasks
|
|
29
|
-
* META INPUT PLACEHOLDER Write a message...
|
|
30
|
-
* META THINKING MESSAGE Thinking...
|
|
31
|
-
* META AUTHOR John Doe
|
|
32
|
-
* META VERSION 1.0
|
|
33
|
-
* ```
|
|
34
|
-
*
|
|
35
|
-
* @private [🪔] Maybe export the commitments through some package
|
|
36
|
-
*/
|
|
37
|
-
export declare class MetaCommitmentDefinition extends BaseCommitmentDefinition<`META${string}`> {
|
|
38
|
-
constructor();
|
|
39
|
-
/**
|
|
40
|
-
* Short one-line description of META commitments.
|
|
41
|
-
*/
|
|
42
|
-
get description(): string;
|
|
43
|
-
/**
|
|
44
|
-
* Icon for this commitment.
|
|
45
|
-
*/
|
|
46
|
-
get icon(): string;
|
|
47
|
-
/**
|
|
48
|
-
* Markdown documentation for META commitment.
|
|
49
|
-
*/
|
|
50
|
-
get documentation(): string;
|
|
51
|
-
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
|
52
|
-
/**
|
|
53
|
-
* Extracts meta information from the content based on the meta type
|
|
54
|
-
* This is used by the parsing logic
|
|
55
|
-
*/
|
|
56
|
-
extractMetaValue(metaType: string, content: string): string | null;
|
|
57
|
-
/**
|
|
58
|
-
* Validates if the provided content is a valid URL (for IMAGE and LINK types)
|
|
59
|
-
*/
|
|
60
|
-
isValidUrl(content: string): boolean;
|
|
61
|
-
/**
|
|
62
|
-
* Checks if this is a known meta type
|
|
63
|
-
*/
|
|
64
|
-
isKnownMetaType(metaType: string): boolean;
|
|
65
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
|
|
2
|
-
import type { ParsedCommitment } from '../_base/ParsedCommitment';
|
|
3
|
-
/**
|
|
4
|
-
* `USE` commitment types whose system-message sections are aggregated after the
|
|
5
|
-
* commitment-by-commitment application step.
|
|
6
|
-
*
|
|
7
|
-
* @private internal utility of `createAgentModelRequirementsWithCommitments`
|
|
8
|
-
*/
|
|
9
|
-
type AggregatedUseCommitmentType = 'USE BROWSER' | 'USE DEEPSEARCH' | 'USE SEARCH ENGINE' | 'USE TIME';
|
|
10
|
-
/**
|
|
11
|
-
* Adds the placeholder for an aggregated `USE` system-message section only once, preserving the section position from the first occurrence.
|
|
12
|
-
*
|
|
13
|
-
* @param requirements - Current model requirements.
|
|
14
|
-
* @param type - Aggregated `USE` commitment type being applied.
|
|
15
|
-
* @returns Requirements with the placeholder inserted when it was not already present.
|
|
16
|
-
*
|
|
17
|
-
* @private internal utility of `USE` commitments
|
|
18
|
-
*/
|
|
19
|
-
export declare function appendAggregatedUseCommitmentPlaceholder(requirements: AgentModelRequirements, type: AggregatedUseCommitmentType): AgentModelRequirements;
|
|
20
|
-
/**
|
|
21
|
-
* Replaces temporary `USE` placeholders with one aggregated system-message block per commitment type.
|
|
22
|
-
*
|
|
23
|
-
* Distinct additional-instruction blocks are merged in stable source order while the hard-coded section is emitted only once.
|
|
24
|
-
*
|
|
25
|
-
* @param requirements - Model requirements produced by commitment-by-commitment application.
|
|
26
|
-
* @param commitments - Filtered commitments in their original source order.
|
|
27
|
-
* @returns Requirements with aggregated `USE` system-message sections.
|
|
28
|
-
*
|
|
29
|
-
* @private internal utility of `createAgentModelRequirementsWithCommitments`
|
|
30
|
-
*/
|
|
31
|
-
export declare function aggregateUseCommitmentSystemMessages(requirements: AgentModelRequirements, commitments: ReadonlyArray<ParsedCommitment>): AgentModelRequirements;
|
|
32
|
-
export {};
|
|
@@ -1,58 +0,0 @@
|
|
|
1
|
-
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
|
|
2
|
-
import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
|
|
3
|
-
import type { string_javascript_name } from '../../types/string_person_fullname';
|
|
4
|
-
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
5
|
-
/**
|
|
6
|
-
* USE BROWSER commitment definition
|
|
7
|
-
*
|
|
8
|
-
* The `USE BROWSER` commitment indicates that the agent should utilize browser tools
|
|
9
|
-
* to access and retrieve up-to-date information from the internet when necessary.
|
|
10
|
-
*
|
|
11
|
-
* This commitment provides two levels of browser access:
|
|
12
|
-
* 1. One-shot URL fetching: Simple function to fetch and scrape URL content
|
|
13
|
-
* 2. Running browser: For complex tasks like scrolling, clicking, form filling, etc.
|
|
14
|
-
*
|
|
15
|
-
* The content following `USE BROWSER` is an arbitrary text that the agent should know
|
|
16
|
-
* (e.g. browsing scope or preferred sources).
|
|
17
|
-
*
|
|
18
|
-
* Example usage in agent source:
|
|
19
|
-
*
|
|
20
|
-
* ```book
|
|
21
|
-
* USE BROWSER
|
|
22
|
-
* USE BROWSER Prefer official documentation and source websites.
|
|
23
|
-
* ```
|
|
24
|
-
*
|
|
25
|
-
* @private [🪔] Maybe export the commitments through some package
|
|
26
|
-
*/
|
|
27
|
-
export declare class UseBrowserCommitmentDefinition extends BaseCommitmentDefinition<'USE BROWSER'> {
|
|
28
|
-
constructor();
|
|
29
|
-
/**
|
|
30
|
-
* The `USE BROWSER` commitment is standalone.
|
|
31
|
-
*/
|
|
32
|
-
get requiresContent(): boolean;
|
|
33
|
-
/**
|
|
34
|
-
* Short one-line description of USE BROWSER.
|
|
35
|
-
*/
|
|
36
|
-
get description(): string;
|
|
37
|
-
/**
|
|
38
|
-
* Icon for this commitment.
|
|
39
|
-
*/
|
|
40
|
-
get icon(): string;
|
|
41
|
-
/**
|
|
42
|
-
* Markdown documentation for USE BROWSER commitment.
|
|
43
|
-
*/
|
|
44
|
-
get documentation(): string;
|
|
45
|
-
/**
|
|
46
|
-
* Gets human-readable titles for tool functions provided by this commitment.
|
|
47
|
-
*/
|
|
48
|
-
getToolTitles(): Record<string_javascript_name, string>;
|
|
49
|
-
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
|
50
|
-
/**
|
|
51
|
-
* Gets the browser tool function implementations.
|
|
52
|
-
*
|
|
53
|
-
* This method automatically detects the environment and uses:
|
|
54
|
-
* - Server-side: Direct scraping via fetchUrlContent (Node.js)
|
|
55
|
-
* - Browser: Proxy through Agents Server API via fetchUrlContentViaBrowser
|
|
56
|
-
*/
|
|
57
|
-
getToolFunctions(): Record<string_javascript_name, ToolFunction>;
|
|
58
|
-
}
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Client-side safe wrapper for fetching URL content
|
|
3
|
-
*
|
|
4
|
-
* This function proxies requests to the Agents Server API endpoint for scraping,
|
|
5
|
-
* making it safe to use in browser environments.
|
|
6
|
-
*
|
|
7
|
-
* @param url The URL to fetch and scrape
|
|
8
|
-
* @param agentsServerUrl The base URL of the agents server (defaults to current origin)
|
|
9
|
-
* @returns Markdown content from the URL
|
|
10
|
-
*
|
|
11
|
-
* @private internal utility for USE BROWSER commitment
|
|
12
|
-
*/
|
|
13
|
-
export declare function fetchUrlContentViaBrowser(url: string, agentsServerUrl?: string): Promise<string>;
|
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
|
|
2
|
-
/**
|
|
3
|
-
* Resolves the server-side implementation of the `run_browser` tool for Node.js environments.
|
|
4
|
-
*
|
|
5
|
-
* This uses fully lazy resolution to keep CLI startup independent from optional browser tooling.
|
|
6
|
-
* When the server tool cannot be resolved, the fallback implementation throws a helpful error.
|
|
7
|
-
*
|
|
8
|
-
* @private internal utility for USE BROWSER commitment
|
|
9
|
-
*/
|
|
10
|
-
export declare function resolveRunBrowserToolForNode(): ToolFunction;
|
|
@@ -1,47 +0,0 @@
|
|
|
1
|
-
import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
|
|
2
|
-
import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
|
|
3
|
-
import type { string_javascript_name } from '../../types/string_person_fullname';
|
|
4
|
-
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
|
|
5
|
-
/**
|
|
6
|
-
* USE DEEPSEARCH commitment definition
|
|
7
|
-
*
|
|
8
|
-
* The `USE DEEPSEARCH` commitment indicates that the agent should use a deeper research-oriented
|
|
9
|
-
* search workflow instead of lightweight web search when it needs fresh information from the internet.
|
|
10
|
-
*
|
|
11
|
-
* The content following `USE DEEPSEARCH` is an arbitrary text that the agent should know
|
|
12
|
-
* (e.g. search scope or research instructions).
|
|
13
|
-
*
|
|
14
|
-
* Example usage in agent source:
|
|
15
|
-
*
|
|
16
|
-
* ```book
|
|
17
|
-
* USE DEEPSEARCH
|
|
18
|
-
* USE DEEPSEARCH Compare official vendor documentation with independent benchmarks.
|
|
19
|
-
* ```
|
|
20
|
-
*
|
|
21
|
-
* @private [🪔] Maybe export the commitments through some package
|
|
22
|
-
*/
|
|
23
|
-
export declare class UseDeepSearchCommitmentDefinition extends BaseCommitmentDefinition<'USE DEEPSEARCH'> {
|
|
24
|
-
constructor();
|
|
25
|
-
get requiresContent(): boolean;
|
|
26
|
-
/**
|
|
27
|
-
* Short one-line description of USE DEEPSEARCH.
|
|
28
|
-
*/
|
|
29
|
-
get description(): string;
|
|
30
|
-
/**
|
|
31
|
-
* Icon for this commitment.
|
|
32
|
-
*/
|
|
33
|
-
get icon(): string;
|
|
34
|
-
/**
|
|
35
|
-
* Markdown documentation for USE DEEPSEARCH commitment.
|
|
36
|
-
*/
|
|
37
|
-
get documentation(): string;
|
|
38
|
-
applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
|
|
39
|
-
/**
|
|
40
|
-
* Gets human-readable titles for tool functions provided by this commitment.
|
|
41
|
-
*/
|
|
42
|
-
getToolTitles(): Record<string_javascript_name, string>;
|
|
43
|
-
/**
|
|
44
|
-
* Gets the local fallback implementation for the `deep_search` tool.
|
|
45
|
-
*/
|
|
46
|
-
getToolFunctions(): Record<string_javascript_name, ToolFunction>;
|
|
47
|
-
}
|