@servicenow/sdk - v4.7.0
    Preparing search index...

    Type Alias BaseToolDetails

    Base type with common fields shared across all tool types. Contains fields from both sn_aia_tool (tool definition) and sn_aia_agent_tool_m2m (tool usage in agent).

    type BaseToolDetails = {
        active?: boolean;
        description?: string;
        displayOutput?: boolean;
        documentStatus?: ToolDocumentStatus;
        executionMode?: ToolExecutionMode;
        m2mSysOverrides?: string | Record<"sn_aia_agent_tool_m2m">;
        maxAutoExecutions?: number;
        name: string;
        outputTransformationStrategy?: OutputTransformationStrategy;
        postMessage?: string;
        postProcessingScript?:
            | ((result: any, inputs: any, ...dependencies: any[]) => any)
            | string;
        preMessage?: string;
        preRun?: boolean;
        recordType?: AiAgentToolRecordType;
        sysOverrides?: string | Record<"sn_aia_tool">;
        timeout?: string;
        toolAttributes?: { [key: string]: JsonSerializable };
        transformationInstructions?: string;
        widgets?: (string | Record<"sn_aia_widget">)[];
    }
    Index

    Properties

    active? description? displayOutput? documentStatus? executionMode? m2mSysOverrides? maxAutoExecutions? name outputTransformationStrategy? postMessage? postProcessingScript? preMessage? preRun? recordType? sysOverrides? timeout? toolAttributes? transformationInstructions? widgets?

    Properties

    active?: boolean

    Whether the tool is active

    description?: string

    Description of the tool

    displayOutput?: boolean

    Whether to display the tool output

    documentStatus?: ToolDocumentStatus

    Document status for the tool

    executionMode?: ToolExecutionMode

    Execution mode for the tool (autopilot or copilot)

    m2mSysOverrides?: string | Record<"sn_aia_agent_tool_m2m">

    Reference to overrides for tool usage in agent (sn_aia_agent_tool_m2m)

    maxAutoExecutions?: number

    Maximum number of automatic executions

    name: string

    Name of the tool

    outputTransformationStrategy?: OutputTransformationStrategy

    Strategy for transforming the tool output

    postMessage?: string

    Message to display after tool execution

    postProcessingScript?:
        | ((result: any, inputs: any, ...dependencies: any[]) => any)
        | string

    Script to execute after the tool runs

    preMessage?: string

    Message to display before tool execution

    preRun?: boolean

    Whether to run this tool before other tools

    recordType?: AiAgentToolRecordType

    Record type for the tool (custom, promoted, or template)

    sysOverrides?: string | Record<"sn_aia_tool">

    Reference to overrides for tool definition (sn_aia_tool)

    timeout?: string

    Timeout duration for tool execution

    toolAttributes?: { [key: string]: JsonSerializable }

    Additional attributes for the tool - structured as an object

    transformationInstructions?: string

    Instructions for transforming the tool output

    widgets?: (string | Record<"sn_aia_widget">)[]

    Widgets associated with the tool

    Settings

    Member Visibility

    On This Page

    Properties