Function
tool follows the JSON Schema format. You provide the definition when adding the tool to the Tool calling block.
Parameter | Type | Description |
---|---|---|
name | string | The name of the tool |
description | string | A description of what the tool does and when the model should use it |
parameters | object | An object containing the tool’s input parameters |
parameters.type | string | The type of the parameter, which is object for a JSON schema |
parameters.properties | object | An object containing the tool’s parameters in the form of a JSON schema. See below for more details. |
parameters.required | array | An array of the tool’s required parameters |
Name | Type | Control | Default | Description | Options | Validation |
---|---|---|---|---|---|---|
Prompt | Text | Textarea | - | The task that needs to be carried out. | - | - |
Model | Model Id | - | palmyra-x5 | - | - | - |
Max iterations | Number | - | 10 | - | - | - |
Tools | Tools | - | - | - | - |
Name | Field | Type | Description |
---|---|---|---|
Tools | tools | dynamic | Run associated tools. |
Success | - | success | If the function doesn’t raise an Exception. |
Error | - | error | If the function raises an Exception. |
dynamic
end state means that the exact values of this end state change based on how you define the block.