Components
StaticToolParameter
A parameter for the tool whose value should be set at config time.
Example Usage
Fields
Field | Type | Required | Description |
---|---|---|---|
name | string | TRUE | The name of the parameter - must be unique within the tool. |
description | string | FALSE | The description of the parameter. |
required | boolean | TRUE | Whether the parameter is required to have a value assigned. |
type | components.StaticToolParameterType | TRUE | The expected type for a static tool parameter. |
default | any | FALSE | The default value for the parameter. If type is string, must be a string. If type is int, must be an int. If type is boolean, must be a boolean. If type is data_source_list, must be a list of strings (data source names). |