AIChatShortcutReviewDefinition
A shortcut that interacts with the AI Review.
Note: This shortcut type requires the AIReviewMode plugin to be loaded.
This type of shortcut can run both predefined and extra review commands. The list of predefined review commands with available parameters can be found in the AI Review documentation. Extra review commands are defined via the config.ai.review.extraCommands configuration.
Example of a shortcut that opens the AI Review mode:
{
id: 'open-review',
label: 'Open review',
type: 'review'
}
Example of a shortcut that runs the 'correctness' review command:
{
id: 'check-correctness',
label: 'Proofread this document',
type: 'review',
commandId: 'correctness'
}
Example of a shortcut that runs the 'tone' review command with a parameter:
{
id: 'adjust-tone',
label: 'Change the tone of this document to casual',
type: 'review',
commandId: 'tone',
params: [ 'casual' ]
}
Example of a shortcut that runs the 'custom' review command with a specific model and a prompt:
{
id: 'custom-review',
label: 'Custom grammar command using the gpt-5.1 model',
type: 'review',
commandId: 'custom',
model: 'gpt-5.1',
prompt: 'Check grammar and style.'
}
Properties
commandId : string | undefinedreadonlymodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#commandIdThe ID of the review command to be run.
Note: When not provided, the shortcut will switch the user interface to the AI Review.
See
config.ai.review.availableCommandsfor the list of available review commands.icon : string | undefinedreadonlyinheritedmodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#iconThe icon of the shortcut in SVG string format.
Learn more about setting the icon in the
IconViewAPI reference.Note: When not provided, a generic icon associated with the shortcut type will be used instead.
id : stringreadonlyinheritedmodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#idThe unique identifier of the shortcut.
label : stringreadonlyinheritedmodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#labelThe human-readable label of the shortcut.
model : string | undefinedreadonlymodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#modelThe ID of the model to be used for the
'custom'review command that requires a model identifier.See the integration guide to learn more about available models.
Note: When not provided, the default model will be used instead. See
config.ai.models.defaultModelIdto learn more.params : Array<string> | undefinedreadonlymodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#paramsThe parameters to be used for review commands that require parameters (e.g.
'length','tone', etc.).prompt : string | undefinedreadonlymodule:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#promptThe prompt to be sent to the AI Review for the
'custom'review command that requires a prompt.type : 'review'module:ai/aichatshortcuts/aichatshortcuts~AIChatShortcutReviewDefinition#typeThe type of the shortcut.