@promptbook/remote-server/umd/src/commitments/USE_DEEPSEARCH/USE_DEEPSEARCH.d.ts

Promptbook: Create persistent AI agents that turn your company's scattered knowledge into action

import type { AgentModelRequirements } from '../../book-2.0/agent-source/AgentModelRequirements';
import type { ToolFunction } from '../../scripting/javascript/JavascriptExecutionToolsOptions';
import type { string_javascript_name } from '../../types/string_person_fullname';
import { BaseCommitmentDefinition } from '../_base/BaseCommitmentDefinition';
/**
 * USE DEEPSEARCH commitment definition
 *
 * The `USE DEEPSEARCH` commitment indicates that the agent should use a deeper research-oriented
 * search workflow instead of lightweight web search when it needs fresh information from the internet.
 *
 * The content following `USE DEEPSEARCH` is an arbitrary text that the agent should know
 * (e.g. search scope or research instructions).
 *
 * Example usage in agent source:
 *
 * ```book
 * USE DEEPSEARCH
 * USE DEEPSEARCH Compare official vendor documentation with independent benchmarks.
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class UseDeepSearchCommitmentDefinition extends BaseCommitmentDefinition<'USE DEEPSEARCH'> {
    constructor();
    get requiresContent(): boolean;
    /**
     * Short one-line description of USE DEEPSEARCH.
     */
    get description(): string;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for USE DEEPSEARCH commitment.
     */
    get documentation(): string;
    applyToAgentModelRequirements(requirements: AgentModelRequirements, content: string): AgentModelRequirements;
    /**
     * Gets human-readable titles for tool functions provided by this commitment.
     */
    getToolTitles(): Record<string_javascript_name, string>;
    /**
     * Gets the local fallback implementation for the `deep_search` tool.
     */
    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
}