parameter - APEXlang Reference

`parameter`

Parent: tool

Applies whenexecutionPoint = onDemand and type supports PARAMETERS_DEFINED_BY_TOOL

Direct Properties:

Property	Type	Required	Default Value	Details
`name`	`string`	Yes		data type=`string`; maxLen=30; textCase=`UPPER`
`description`	`multiline string`	No		data type=`multiline string`; maxLen=4000

Property Groups:

value

Property	Type	Required	Default Value	Details
`dataType`	`enum`	Yes	`varchar2`	data type=`string`; lov=`STATIC` Valid values: `varchar2` `clob` `number` `boolean`

value {
  dataType: varchar2
}

validation

Property	Type	Required	Default Value	Details
`required`	`boolean`	Yes	`true`	data type=`boolean` Specify whether a value for this parameter must always be provided by the AI Service.
`allowedValues`	`multiline string`	No		data type=`multiline string`; maxLen=4000 Applies when`dataType in (varchar2)dataType in (number)`

validation {
  required: false
  allowedValues: ```json
    value
  ```
}

APEXlang Example

parameter sample (
    name: value
    description: ```
      value
    ```
    value {
        dataType: varchar2
    }
    validation {
        required: false
        allowedValues: ```json
          value
        ```
    }
)