Nokome Bentley • 4 min read

Prompt

A prompt for creating or editing document content.

Properties

The Prompt type has these properties:

Name Description Type Inherited from JSON-LD @id Aliases
id The identifier for this item. String Entity schema:id -
alternateNames Alternate names (aliases) for the item. String* Thing schema:alternateName alternate-names, alternate_names, alternateName, alternate-name, alternate_name
description A description of the item. String Thing schema:description -
identifiers Any kind of identifier for any kind of Thing. (PropertyValue | String)* Thing schema:identifier identifier
images Images of the item. ImageObject* Thing schema:image image
name The name of the item. String Thing schema:name -
url The URL of the item. String Thing schema:url -
about The subject matter of the content. ThingType* CreativeWork schema:about -
abstract A a short description that summarizes a CreativeWork. Block* CreativeWork schema:abstract -
authors The authors of the CreativeWork. Author* CreativeWork schema:author author
provenance A summary of the provenance of the content within the work. ProvenanceCount* CreativeWork stencila:provenance -
contributors A secondary contributor to the CreativeWork. Author* CreativeWork schema:contributor contributor
editors People who edited the CreativeWork. Person* CreativeWork schema:editor editor
maintainers The maintainers of the CreativeWork. (Person | Organization)* CreativeWork schema:maintainer maintainer
comments Comments about this creative work. Comment* CreativeWork schema:comment comment
dateCreated Date/time of creation. Date CreativeWork schema:dateCreated date-created, date_created
dateReceived Date/time that work was received. Date CreativeWork schema:dateReceived date-received, date_received
dateAccepted Date/time of acceptance. Date CreativeWork stencila:dateAccepted date-accepted, date_accepted
dateModified Date/time of most recent modification. Date CreativeWork schema:dateModified date-modified, date_modified
datePublished Date of first publication. Date CreativeWork schema:datePublished date, date-published, date_published
funders People or organizations that funded the CreativeWork. (Person | Organization)* CreativeWork schema:funder funder
fundedBy Grants that funded the CreativeWork; reverse of fundedItems. (Grant | MonetaryGrant)* CreativeWork stencila:fundedBy funded-by, funded_by
genre Genre of the creative work, broadcast channel or group. String* CreativeWork schema:genre -
keywords Keywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas. String* CreativeWork schema:keywords keyword
isPartOf An item or other CreativeWork that this CreativeWork is a part of. CreativeWorkType CreativeWork schema:isPartOf is-part-of, is_part_of
licenses License documents that applies to this content, typically indicated by URL. (CreativeWorkType | Text)* CreativeWork schema:license license
parts Elements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more. CreativeWorkType* CreativeWork schema:hasParts hasParts, part
publisher A publisher of the CreativeWork. Person | Organization CreativeWork schema:publisher -
references References to other creative works, such as another publication, web page, scholarly article, etc. (CreativeWorkType | Text)* CreativeWork schema:citation citations, reference
text The textual content of this creative work. Text CreativeWork schema:text -
title The title of the creative work. Inline* CreativeWork schema:headline headline
version The version of the creative work. String | Number CreativeWork schema:version -
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
frontmatter Frontmatter containing document metadata. String - stencila:frontmatter -
instructionTypes The types of instructions that the prompt supports InstructionType* - stencila:instructionTypes instruction-types, instruction_types, instructionType, instruction-type, instruction_type
nodeTypes The types of nodes that the prompt supports String* - stencila:nodeTypes node-types, node_types, nodeType, node-type, node_type
nodeCount The number of nodes that the prompt supports UnsignedInteger | String - stencila:nodeCount node-count, node_count
queryPatterns Regular expressions used to match the prompt with a user query String* - stencila:queryPatterns query-patterns, query_patterns, queryPattern, query-pattern, query_pattern
content The content of the prompt. Block* - stencila:content -

Related

The Prompt type is related to these types:

Formats

The Prompt type can be encoded (serialized) to, and/or decoded (deserialized) from, these formats:

Format Encoding Decoding Support Notes
DOM HTML 🟢 No loss
HTML 🔷 Low loss
JATS
Markdown ⚠️ High loss Encoded using implemented function
Stencila Markdown ⚠️ High loss
Quarto Markdown ⚠️ High loss
MyST Markdown ⚠️ High loss
LLM Markdown ⚠️ High loss
LaTeX 🔷 Low loss 🔷 Low loss
PDF 🔷 Low loss
Plain text ⚠️ High loss
IPYNB 🔷 Low loss 🔷 Low loss
Microsoft Word DOCX 🔷 Low loss 🔷 Low loss
OpenDocument ODT 🔷 Low loss 🔷 Low loss
TeX 🔷 Low loss 🔷 Low loss
JSON 🟢 No loss 🟢 No loss
JSON+Zip 🟢 No loss 🟢 No loss
JSON5 🟢 No loss 🟢 No loss
JSON-LD 🟢 No loss 🟢 No loss
CBOR 🟢 No loss 🟢 No loss
CBOR+Zstandard 🟢 No loss 🟢 No loss
YAML 🟢 No loss 🟢 No loss
Lexical JSON 🔷 Low loss 🔷 Low loss
Koenig JSON 🔷 Low loss 🔷 Low loss
Pandoc AST 🔷 Low loss 🔷 Low loss
Directory
Stencila Web Bundle
Debug 🔷 Low loss

Bindings

The Prompt type is represented in:

Source

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