Home

Chat

This is a type used in Stencila Schema for conversational interactions in documents.

It combines CreativeWork metadata with Executable behavior so a chat can be stored, rendered, re-executed, and linked to document editing workflows. Unlike a plain message transcript, it can carry model configuration, prompt rendering, targeted document nodes, and mixed block content.

Key properties include prompt, modelParameters, targetNodes, and content. Additional metadata and execution features are inherited from CreativeWork and Executable.

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

Analogues

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

Properties

The Chat type has these properties:

NameDescriptionTypeInherited from
isEmbeddedWhether the chat is embedded within a document (i.e. is not standalone).Boolean-
promptThe prompt selected, rendered and provided to the modelPromptBlock-
modelParametersModel selection and inference parameters.ModelParameters-
targetNodesThe ids of the nodes that this chat is targetingString*-
contentThe messages, and optionally other content, that make up the chat.Block*-
workTypeThe type of CreativeWork (e.g. article, book, software application).CreativeWorkTypeCreativeWork
doiThe work's Digital Object Identifier (https://doi.org/).StringCreativeWork
aboutThe subject matter of the content.ThingVariant*CreativeWork
abstractA short description that summarizes a CreativeWork.Block*CreativeWork
authorsThe authors of the CreativeWork.Author*CreativeWork
provenanceA summary of the provenance of the content within the work.ProvenanceCount*CreativeWork
contributorsA secondary contributor to the CreativeWork.Author*CreativeWork
editorsPeople who edited the CreativeWork.Person*CreativeWork
maintainersThe maintainers of the CreativeWork.(Person | Organization)*CreativeWork
commentsComments about this creative work.Comment*CreativeWork
dateCreatedDate/time of creation.DateTimeCreativeWork
dateReceivedDate/time that work was received.DateTimeCreativeWork
dateAcceptedDate/time of acceptance.DateTimeCreativeWork
dateModifiedDate/time of most recent modification.DateTimeCreativeWork
datePublishedDate of first publication.DateTimeCreativeWork
fundersPeople or organizations that funded the CreativeWork.(Person | Organization)*CreativeWork
fundedByGrants that funded the CreativeWork; reverse of fundedItems.(Grant | MonetaryGrant)*CreativeWork
genreGenre of the creative work, broadcast channel or group.String*CreativeWork
keywordsKeywords or tags used to describe this content. Multiple entries in a keywords list are typically delimited by commas.String*CreativeWork
isPartOfAn item or other CreativeWork that this CreativeWork is a part of.CreativeWorkVariantCreativeWork
licensesLicense documents that applies to this content, typically indicated by URL, but may be a CreativeWork itself.(CreativeWorkVariant | String)*CreativeWork
partsElements of the collection which can be a variety of different elements, such as Articles, Datatables, Tables and more.CreativeWorkVariant*CreativeWork
publisherA publisher of the CreativeWork.Person | OrganizationCreativeWork
bibliographyA bibliography of references which may be cited in the work.BibliographyCreativeWork
referencesReferences to other creative works, such as another publication, web page, scholarly article, etc.Reference*CreativeWork
textThe textual content of this creative work.TextCreativeWork
titleThe title of the creative work.Inline*CreativeWork
repositoryURL of the repository where the un-compiled, human readable source of the work is located.StringCreativeWork
pathThe file system path of the source of the work.StringCreativeWork
commitThe commit hash (or similar) of the source of the work.StringCreativeWork
versionThe version of the creative work.String | NumberCreativeWork
executionModeUnder which circumstances the node should be executed.ExecutionModeExecutable
compilationDigestA digest of the content, semantics and dependencies of the node.CompilationDigestExecutable
compilationMessagesMessages generated while compiling the code.CompilationMessage*Executable
executionDigestThe compilationDigest of the node when it was last executed.CompilationDigestExecutable
executionDependenciesThe upstream dependencies of this node.ExecutionDependency*Executable
executionDependantsThe downstream dependants of this node.ExecutionDependant*Executable
executionTagsTags in the code which affect its execution.ExecutionTag*Executable
executionCountA count of the number of times that the node has been executed.IntegerExecutable
executionRequiredWhether, and why, the code requires execution or re-execution.ExecutionRequiredExecutable
executionStatusStatus of the most recent, including any current, execution.ExecutionStatusExecutable
executionInstanceThe id of the kernel instance that performed the last execution.StringExecutable
executionEndedThe timestamp when the last execution ended.TimestampExecutable
executionDurationDuration of the last execution.DurationExecutable
executionMessagesMessages emitted while executing the node.ExecutionMessage*Executable
idThe identifier for this item.StringEntity
alternateNamesAlternate names (aliases) for the item.String*Thing
descriptionA description of the item.StringThing
identifiersAny kind of identifier for any kind of Thing.(PropertyValue | String)*Thing
imagesImages of the item.ImageObject*Thing
nameThe name of the item.StringThing
urlThe URL of the item.StringThing

Related

The Chat type is related to these types:

Bindings

The Chat type is represented in:


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

I'm happy to help with any questions or tasks you may have. Please go ahead and ask away, and I'll do my best to provide a helpful and accurate response. What's on your mind?

© 2026 Stencila