Nokome Bentley • 1 min read

Instruction

Abstract base type for a document editing instruction.

Properties

The Instruction type has these properties:

Name Description Type Inherited from JSON-LD @id Aliases
id The identifier for this item. String Entity schema:id -
executionMode Under which circumstances the node should be executed. ExecutionMode Executable stencila:executionMode execution-mode, execution_mode
compilationDigest A digest of the content, semantics and dependencies of the node. CompilationDigest Executable stencila:compilationDigest compilation-digest, compilation_digest
compilationMessages Messages generated while compiling the code. CompilationMessage* Executable stencila:compilationMessages compilation-messages, compilation_messages, compilationMessage, compilation-message, compilation_message
executionDigest The compilationDigest of the node when it was last executed. CompilationDigest Executable stencila:executionDigest execution-digest, execution_digest
executionDependencies The upstream dependencies of this node. ExecutionDependency* Executable stencila:executionDependencies execution-dependencies, execution_dependencies, executionDependency, execution-dependency, execution_dependency
executionDependants The downstream dependants of this node. ExecutionDependant* Executable stencila:executionDependants execution-dependants, execution_dependants, executionDependant, execution-dependant, execution_dependant
executionTags Tags in the code which affect its execution. ExecutionTag* Executable stencila:executionTags execution-tags, execution_tags, executionTag, execution-tag, execution_tag
executionCount A count of the number of times that the node has been executed. Integer Executable stencila:executionCount execution-count, execution_count
executionRequired Whether, and why, the code requires execution or re-execution. ExecutionRequired Executable stencila:executionRequired execution-required, execution_required
executionStatus Status of the most recent, including any current, execution. ExecutionStatus Executable stencila:executionStatus execution-status, execution_status
executionInstance The id of the kernel instance that performed the last execution. String Executable stencila:executionInstance execution-instance, execution_instance
executionEnded The timestamp when the last execution ended. Timestamp Executable stencila:executionEnded execution-ended, execution_ended
executionDuration Duration of the last execution. Duration Executable stencila:executionDuration execution-duration, execution_duration
executionMessages Messages emitted while executing the node. ExecutionMessage* Executable stencila:executionMessages execution-messages, execution_messages, executionMessage, execution-message, execution_message
instructionType The type of instruction describing the operation to be performed. InstructionType - stencila:instructionType instruction-type, instruction_type
prompt The prompt selected, rendered and provided to the model PromptBlock - stencila:prompt -
message The instruction message, possibly including images, audio, or other media. InstructionMessage - stencila:message -
modelParameters Model selection and inference parameters. ModelParameters - stencila:modelParameters model-parameters, model_parameters, model-params, model_params, model-pars, model_pars, model
activeSuggestion The index of the suggestion that is currently active UnsignedInteger - stencila:activeSuggestion active-suggestion, active_suggestion

Related

The Instruction type is related to these types:

Bindings

The Instruction type is represented in:

Source

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