Used on an Instruction to render a prompt and display the rendering to the user. Can also be used standalone to preview how a prompt is rendered at a particular position in a document.

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

Properties

The PromptBlock type has these properties:

Name	Description	Type	Inherited from
`id`	The identifier for this item.	`String`	`Entity`
`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`
`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`*	-

The PromptBlock type is related to these types:

Parents: Executable

Children: none

Bindings

The PromptBlock type is represented in:

JSON-LD

JSON Schema

Python class PromptBlock

Rust struct PromptBlock

TypeScript class PromptBlock

This documentation was generated from PromptBlock.yaml by docs_types.rs.

Properties

Related

Bindings