This is an abstract base type used in Stencila Schema for model-assisted document editing instructions.

It extends Executable so instructions can carry prompt rendering, user messages, model parameters, execution state, and generated suggestions as part of the document model itself. This makes editing workflows inspectable, replayable, and serializable.

Key properties include instructionType, prompt, message, modelParameters, and activeSuggestion.

Analogues

The following external types, elements, or nodes are similar to a Instruction:

chat-based edit instruction: Approximate analogue for model-directed editing requests, though Stencila persists prompts, messages, execution state, and suggestions as structured document nodes.

Properties

The Instruction type has these properties:

Name	Description	Type	Inherited from
`instructionType`	The type of instruction describing the operation to be performed.	`InstructionType`	-
`prompt`	The prompt selected, rendered and provided to the model	`PromptBlock`	-
`message`	The instruction message, possibly including images, audio, or other media.	`InstructionMessage`	-
`modelParameters`	Model selection and inference parameters.	`ModelParameters`	-
`activeSuggestion`	The index of the suggestion that is currently active	`UnsignedInteger`	-
`executionMode`	Under which circumstances the node should be executed.	`ExecutionMode`	`Executable`
`compilationDigest`	A digest of the content, semantics and dependencies of the node.	`CompilationDigest`	`Executable`
`compilationMessages`	Messages generated while compiling the code.	`CompilationMessage`*	`Executable`
`executionDigest`	The `compilationDigest` of the node when it was last executed.	`CompilationDigest`	`Executable`
`executionDependencies`	The upstream dependencies of this node.	`ExecutionDependency`*	`Executable`
`executionDependants`	The downstream dependants of this node.	`ExecutionDependant`*	`Executable`
`executionTags`	Tags in the code which affect its execution.	`ExecutionTag`*	`Executable`
`executionCount`	A count of the number of times that the node has been executed.	`Integer`	`Executable`
`executionRequired`	Whether, and why, the code requires execution or re-execution.	`ExecutionRequired`	`Executable`
`executionStatus`	Status of the most recent, including any current, execution.	`ExecutionStatus`	`Executable`
`executionInstance`	The id of the kernel instance that performed the last execution.	`String`	`Executable`
`executionEnded`	The timestamp when the last execution ended.	`Timestamp`	`Executable`
`executionDuration`	Duration of the last execution.	`Duration`	`Executable`
`executionMessages`	Messages emitted while executing the node.	`ExecutionMessage`*	`Executable`
`id`	The identifier for this item.	`String`	`Entity`