ChatViewTool

PropTypeDescription
toolChatCompletionTool

OpenAI tool definition.

call(args: string) => Promise<string>

The actual function to call. Called with a JSON string as returned from OpenAI. Should validate the JSON for correctness as OpenAI can hallucinate arguments. Must return a string to feed the result back into OpenAI.

requireConfirmationboolean

Whether user needs to confirm a call to this function or function calls will be executed right away. Default: true.

showDefaultAutoTriggerMessageboolean

If true, show a message when the tool is automatically triggered. Default: true.