Interface UtilityAgentTool

UtilityAgentTool.

interface UtilityAgentTool {
    agent_description?: string;
    config_schema?: WatsonXAI.JsonObject;
    description: string;
    input_schema?: WatsonXAI.JsonObject;
    name: string;
}

Properties

agent_description? config_schema? description input_schema? name

Properties

Optional agent_description

agent_description?: string

The precise instruction to agent LLMs and should be treated as part of the system prompt. If not provided, description can be used in it's place.

Optional config_schema

config_schema?: WatsonXAI.JsonObject

The JSON schema of the config that can be provided when running the tool if applicable.

description

description: string

A plain text description of what the tool is used for.

Optional input_schema

input_schema?: WatsonXAI.JsonObject

The JSON schema of the input that is provided when running the tool if applicable.

name

name: string

Name of the tool.

Settings

Member Visibility

Theme

On This Page

agent_descriptionconfig_schemadescriptioninput_schemaname