@promptbook/remote-server/esm/src/commitments/USE_SEARCH_ENGINE/USE_SEARCH_ENGINE.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 SEARCH ENGINE commitment definition
 *
 * The `USE SEARCH ENGINE` commitment indicates that the agent should utilize a search engine tool
 * to access and retrieve up-to-date information from the internet when necessary.
 *
 * The content following `USE SEARCH ENGINE` is an arbitrary text that the agent should know (e.g. search scope or instructions).
 *
 * Example usage in agent source:
 *
 * ```book
 * USE SEARCH ENGINE
 * USE SEARCH ENGINE Hledej informace o Přemyslovcích
 * ```
 *
 * @private [🪔] Maybe export the commitments through some package
 */
export declare class UseSearchEngineCommitmentDefinition extends BaseCommitmentDefinition<'USE SEARCH ENGINE'> {
    constructor();
    get requiresContent(): boolean;
    /**
     * Short one-line description of USE SEARCH ENGINE.
     */
    get description(): string;
    /**
     * Icon for this commitment.
     */
    get icon(): string;
    /**
     * Markdown documentation for USE SEARCH ENGINE 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 `web_search` tool function implementation.
     */
    getToolFunctions(): Record<string_javascript_name, ToolFunction>;
}