This is an executable type used in Stencila Schema for previewing rendered prompts.

It exists to show how a prompt will resolve for a particular instruction type, target node, or document position before or during an editing workflow. This makes prompt selection and rendering inspectable within the document model itself.

Key properties include instructionType, nodeTypes, relativePosition, query, target, and rendered content.

This type is marked as unstable and is subject to change.

Analogues

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

rendered prompt preview: Approximate analogue for inspecting the final prompt sent to a model, though Stencila models it as an executable document node tied to editing context.

Properties

The PromptBlock type has these properties:

Name	Description	Type	Inherited from
`instructionType`	The type of instruction the being used for	`InstructionType`	-
`nodeTypes`	The type of nodes the prompt is being used for	`String`*	-
`relativePosition`	The relative position of the node being edited, described etc.	`RelativePosition`	-
`query`	A user text query used to infer the `target` prompt	`String`	-
`target`	An identifier for the prompt to be rendered	`String`	-
`directory`	The home directory of the prompt	`String`	-
`content`	The executed content of the prompt	`Block`*	-
`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`